Versions Compared

Version Old Version 17 New Version Current
Changes made by

Erick Meijer

yuriy.biryukov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties

Description

Payment interface

Latest Version

2023.10.15.1 / 2023.20.3.1

Release Date

Download Path - APM 2023.10 and lower

Download

...

Download Path - APM 2023.20 and higher

Download

Type

APM Plugin

Change Log: 

Expand

Version

Date

Description

20232022.20.100.16

24

  • Entity Interface Id; added the possibility to define multiple Company Entity_Interface_id. In the configuration screen, you find a new tab, Entity Id, enabling you to link payscale tables to an Entity ID.

  • Fixed the file name format; when exporting advanced and additional payments, the system generated the wrong file format. 
    File Name Format: 
    payment{custID}{optional client-defined data}{MMDDYYYYhhmmss}.txt
    The section {option client defined data} contains the information if it is advanced, addition or payment, the currency and company entity.

  • Added the possibility to save the payment and enrollment files in two different directories—see Setup> General > Export Directories to select the directories to be used.

  • Brightwell accepts the European Nation ID Card if the person does not hold a passport. 
    In Setup> Generate, you can select the travel book code identifying the ENID.

    • The Brightwell interface supports adding multiple Company Entity_Interface_

     

    Fixed the issues with disabled export button for Non Superuser

    Fixed ‘Tag all/Untag all' buttons

    Added the possibility to leave the Date field empty. In such case the Release_Date field in the export file will also be empty

    Added the possibility to define the ‘Location’ field in the setup. This field is mandatory, and error will appear if the field is empty.

    Changed the rule of the truncating First Name and Last Name fields:

    • FirstName should be truncated to 20 chars if exceeds;

    • LastName should be truncated to 20 chars if exceeds

    2023.10.1

    Fixed the issues with disabled export button for Non Superuser

    Fixed ‘Tag all/Untag all' buttons

    Added the possibility to leave the Date field empty. In such case the Release_Date field in the export file will also be empty

    Added the possibility to define the ‘Location’ field in the setup. This field is mandatory, and error will appear if the field is empty.

    Changed the rule of the truncating First Name and Last Name fields:

  • FirstName should be truncated to 20 chars if exceeds;

    • LastName should be truncated to 20 chars if exceeds

    1. Entity Interface Id; added the possibility to define multiple Company Entity_Interface_id. In the configuration screen, you find a new tab, Entity Id, enabling you to link payscale tables to an Entity ID.

    2. Fixed the file name format; when exporting advanced and additional payments, the system generated the wrong file format. 
      File Name Format: 
      payment{custID}{optional client-defined data}{MMDDYYYYhhmmss}.txt
      The section {option client defined data} contains the information if it is advanced, addition or payment, the currency and company entity.

    3. Added the possibility to save the payment and enrollment files in two different directories—see Setup> General > Export Directories to select the directories to be used.

    4. Brightwell accepts the European Nation ID Card if the person does not hold a passport. 
      In Setup> Generate, you can select the travel book code identifying the ENID.

    5. The Brightwell interface supports adding multiple Company Entity_Interface_ID’s in one export file as separate batches. We have added the option “Slit export files by Entity ID in Setup > General. If checked, the plugin creates one export file for each entity id, adding the entity id to the section {option client defined data} of the file name..

    6. Brightwell does not support multiple currencies per account. If a person shifts from one currency to the next, the person needs to be enrolled once more in the new currency with a new unique identifier. We solved this by adding the currency to the PIN. Sample Pin=1234, Currency=USD => Brightwell Account no=1234USD.

      1. Switch on the option 'Allow multiple accounts based on currency' in Setup> General.

      2. In the candidate's tab, we added the following columns; Payscale Currency, Account.

      3. Updated the enrol functionality; only enrol persons linked to the selected currency.

      4. In the waiting for card tab, we improved the Card Received functionality by linking The bank account to the newly formatted account, Pin + Currency.

    2022.20.0.6

     

    1. , adding the entity id to the section {option client defined data} of the file name..

    2. Brightwell does not support multiple currencies per account. If a person shifts from one currency to the next, the person needs to be enrolled once more in the new currency with a new unique identifier. We solved this by adding the currency to the PIN. Sample Pin=1234, Currency=USD => Brightwell Account no=1234USD.

      1. Switch on the option 'Allow multiple accounts based on currency' in Setup> General.

      2. In the candidate's tab, we added the following columns; Payscale Currency, Account.

      3. Updated the enrol functionality; only enrol persons linked to the selected currency.

      4. In the waiting for card tab, we improved the Card Received functionality by linking The bank account to the newly formatted account, Pin + Currency.

    2023.10.2

    APMPI-768

    • We have added new option 'Allow multiple accounts based on currency';

    • If the option is turned on, USD/EUR enrollment doesn`t change P0Y.Currency;

    • If the option is turned on, EUR/USD Enroll works only for persons, who have the same currency on the Payscale table used for the activity;

    • If the option is turned on P0Y.DEBIT_CARD_ACCOUNT_NO will become PIN+<PayscaleCurrency> after enrollment;

    • Payscale currency can be checked in the new added Payment currency column;

    APMPI-810

    Changed the format for the export files.

    If the option ‘Split Export Files By Entity Id’ turned off:

    Registration file
    registration{Customer Id}_brightwell{MMDDYYYYhhmmss}.txt

    Net Payment file
    payment{Customer Id}net-{Currency}{MMDDYYYYhhmmss}.txt

    Advance Payment file
    payment{Customer Id}_advance-{Currency}_{MMDDYYYYhhmmss}.txt

    Additional Payment file
    payment{Customer Id}_additional-{Currency}_{MMDDYYYYhhmmss}.txt

    If the option ‘Split Export Files By Entity Id’ turned on:

    Registration file
    registration{Customer Id}{EntityId}-_brightwell_{MMDDYYYYhhmmss}.txt

    Net Payment file
    payment{Customer Id}{EntityId}-net-{Currency}{MMDDYYYYhhmmss}.txt

    Advance Payment file
    payment{Customer Id}{EntityId}_advance{Currency}_{MMDDYYYYhhmmss}.txt

    Additional Payment file
    payment{Customer Id}{EntityId}_additional{Currency}_{MMDDYYYYhhmmss}.txt

    APMPI-811

    From now payroll field Text(L38) will be fetched to the payment files in the Detail_Record_Type section.

    APMPI-802

    The field 'Payment Type' moved to the main Setup window.

    2023.10.3

    APMPI-803

    Fixed the situation, when Brightwell balance action was not changed to Cash for Advance and Additional entries, after persons exclusion from Brightwell interface.

    APMPI-812

    Fixed problem with 'Tag All' button. Now it will select only the records with all required information.

    APMPI-809

    Changes for whole consistency of the warning messages on all plugin`s tabs.

    2023.10.4

    APMPI-814

    Changed the account no into ['E'|'U']+PIN instead of PIN + ['EUR'|'USD']

    APMPI-817

    The system add the correct email notification address to enrollment and payment export.

    APMPI-818

    To avoid misunderstanding, we renamed the column Payment Currency to Enrollment Currency in the following tabs: Candidates, Waiting for Cards, Members, and Exclusion.

    In the payment tabs, net, advanced and additional, we added the column Enrollment Currency. From the payment tab, it is only possible to export a person whose payment currency equals the enrollment currency. The system highlight ignored payments. To get the payments through, the user needs to change the payment currency in the payroll and recalculate or enrol the person in the correct currency program.

    2023.10.5

    APMPI-823

    Added new column 'Vessel':

    • On the Candidates, Waiting for Card, Members and Exclusion tabs it is fetching vessel from the activity;

    • On the Net, Advance and Additional Payment tabs it is fetching DIM2 from the entries.

    APMPI-824

    Added right-click menu for the grids.

    Some standard functionalities, like ‘Export grid’ to different file formats(HTML, XML, Excel, Text), Alignment, ‘Print grid’ and others, can be found in this menu.

    Menu is accessible using right-click on the columns headers.

    APMPI-825

    Added new option 'Exclude Net Payments'.

    When the option is turned on:

    • Net payment tab will be hidden;

    • Person`s balance action will not be changed to Brightwell while enrollment;

    Image Added

    Advanced and Additional payments missing bank account

    Because the payment tab balance action is different from the Brightwell balance action, the user is missing the possibility to copy the details from the payment tab when adding an advanced or additional entry.

    We will advise the customer to link the entry code to a Common Payment Receiver. The common payment receiver should use the balance action, Brightwell.
    When calculating these payroll entries, the user should not have to enter the bank account. But the plug-in will use the debit_accountno as this is the same as the Brightwell bank account.

    Expand
    titleExample Customer Configuration
    Image Added

    Image AddedImage Added

    When using the entry code, the balance action is prefilled.

    Image Added

    As you can see, the bank account is not displayed and does not exist on the Entry Code.

    APMPI-826

    Added new column 'Payscale Currency'.

    New column available on the Payment tabs and fetch the currency from the Payscale table used on the entries in Payroll.

    Records with different Payscale, Payment and Enrollment Currencies will be marked red and warning message will prevent processing such payments.

    2023.10.6

    APMPI-816

    Adjustments to increase Brightwell plugin performance.

    APMPI-820

    Added possibility to select field to fetch Comment from.

    Image Added

    2023.10.7

    APMPI-835

    Location fie ld enhancements:

    • Added the possibility to select Interface code in Setup. Selected Interface code will be used to find XREF codes on the Vessels. These Xref codes will be fetched to persons as locations;

    • Usual Location field from Setup will be used for persons, who are linked to the Vessels without defined Xref codes;

    • Added the possibility to create locations list in the Setup;

    • Added functionality to overwrite location codes using the values from the locations list;

    • Added possibility to reset overwritten locations;

    • The system will remember overwritten locations for each enrollment currency. Means the same person can have different locations for USD and EUR;

    • Added Location column to Candidates, Waiting For Cards, Members and Exclusion tabs;

    • The same locations, as shown in the grid, will be fetched to enrollment files;

    APMPI-840

    Registration grids modifications:

    • Department column has been added to Candidates, Waiting for Cards, Members, Exclusion tabs;

    • Activity Text column has been added to Candidates, Waiting for Cards, Members, Exclusion tabs;

    • Sign Off column will fetch Estimated End Date from activity, when Date To is empty;

    Payment grids modifications:

    • Account Dim 3 column has been added to Net Payment, Advance Payment and Additional Payment tabs. It can be used to fetch department from the Entries.

    2023.10.8

    APMPI-834 - Added the functionality to link a Product Group Alias to a payment currency (USD, EUR). Implemented separate tab that give possibility to define Product Group Alias for inputted currency code on Setup form.

    APMPI-880 - Fixed issues with date columns filtering

    APMPI-881 - 1) Bank Account No. is taken from P0Y.DEBIT_CARD_ACCOUNTNO. If its empty then Bank Account No. is taken from PAI.ACCOUNTNO

    2) Fixed “Name” column to show correct data,

    2023.10.9

    APMPI-839

    • Moved Card Stock Override Code from Setup to Plugin`s ribbon;

    • Fixed problem with fetching Card Stock Override Code to Enrollment files;

    APMPI-883

    Fixed situation when persons without SSN, but with Passport, were marked as unavailable.

    2023.10.10

    APMPI-738 - Added the possibility to allow/deny access for different tabs in Brightwell. It can be done from plugin`s Setup.

    • 'None' access means that tab will be hidden for corresponding level;

    • 'Read' access means that a user with corresponding level can open the tab and check information there, but cannot change anything or process any files;

    • 'Write' access means that a user with corresponding level will have full access to the tab;

    • By default access rights for all security levels are ‘None’, except the level 99;

    • For ‘Setup’ button, access can be granted or denied;

    Image Added

    APMPI-846 - USD/EUR enrollment replaced with enrollment based on Payscale currency.

    When a user clicks Enroll, the system will automatically enroll all selected crew members with the corresponding currency.

    APMPI-836 - Added new field ‘Response Preference' in Setup with possibility to select 'Email', 'Echo', 'Both', 'None’ values:

    Image Added

    Selected value will be fetched to export files to the field RESPONSE_PREFERENCE under the FILE_HEADER_RECORD_TYPE section.

    2023.10.11

    APMPI-905 - Fixed the issue, when filtered out persons can be tagged while using Tag All.

    APMPI-906 - Fixed the issue, when the export confirmation pop up window doesn’t appear.

    APMPI-890 - Added the possibility to define separate Payment Types for Net, Advance and Additional payments.

    Image Added

    APMPI-902 - Included Zip codes fetching to the plugin`s grid and enrollment files for non-USA employees.

    The validation stays the same - ZIP only mandatory for the USA residents.

    APMPI-904 - Excluded persons are no longer shown on the Candidates and Members tabs. Only on the Esclusion tab

    APMPI-911 - Adjusted notification message for the persons without access to Brightwell.

    2023.10.14

    APMPI-915 - The calculation of total amount of entries has been adjusted in the following way:

    • If none of the crew members are tagged in the grid, all entries are summed up.

    • If a user tags some records, only tagged entries are summed up.

    • On filtering records, only filtered entries are summed up.

    APMPI-947 - Fixed the performance issue occurred when a user tries to tag/untag a number of payment transactions.

    APMPI-974 - Enhanced the logic of processing data in Brightwell:

    • If the Allow multiple accounts based on currency option is selected, the Account No field (P0Y.DEBIT_CARD_ACCOUNT_NO) has the First Currency letter + PIN value.

    • If the Allow multiple accounts based on currency option is selected, the EmployeeId field in the generated file has the First Currency letter + PIN value.

    • If the Allow multiple accounts based on currency option is not selected, the Account No field (P0Y.DEBIT_CARD_ACCOUNT_NO) has the PIN value.

    • If the Allow multiple accounts based on currency option is not selected, the EmployeeId field in the generated file has the PIN value.

    • If a person is enrolled but does not have the predefined Payment currency, the person gets removed from the Candidates tab.

    Besides, in case the currency is not predefined, the value is fetched from P01.

    Note: If the Currency Payment != Payscale Payment, then after enrolling crew members, the Currency Payment will be changed to the Payscale Payment.

    2023.20.1

    APMPI-1034 - GUID is now used instead of int for SeqNo field

    2023.20.2

    APMPI-1130 - Fixed the Catastrophic failure error while running the Brightwell plugin.

    2023.10.15

    2023.20.3

    APMPI-1102 - In Brightwell, in the Export Setup dialog > the Autentication tab, added the Location Required checkbox:

    image-20240708-113019.pngImage Added

    In case the Location check box is selected, but the Location field is empty, a warning message pops up while enrollment:

    image-20240708-113042.pngImage Added

    Functionality

    User Interface

    ...


    Enroll Brightwell Form appears.
    There are 5 tabs: Candidates, Waiting for Card, Members, Exclusion, Payment.

    Candidates list all crew fitting to participate in the Brightwell program:

    • Employed state;

    • With current sea-service activity which linked to Opened Client org.unit or its sub-units and Start Date of activity = before or on the selected (on the form) Date;

    • Not a member of e.g. Ocean Pay or Citibank Direct Deposit programs.



      By default, today's Date is defined.

      The red background indicates that you missed filling some mandatory fields for this person. Just click this record and the system will point you missed fields.
      You have the option to Enroll the selected crew in USD or EUR.
      This is for candidates' registration (a special text. file with all details will be generated).

      • The person will be moved to Waiting For Card page.

        You can also Exclude a candidate from the Brightwell program.

      • Will be moved to Excluded page.

        You can Print the list if needed.

        Help switches you to the Brightwell user manual.


    Waiting for Card page lists all crew that is registered but have not received their card yet:

    ...

    You can Print the list if needed. 

    Help switches you to the Brightwell user manual.



    Members page lists all current members of the program (which were registered and got cards):

    ...

    You can Print the list if needed. 

    Help switches you to the Brightwell user manual.


    The exclusion page lists all crew that is not yet included in the program or was dismissed:

    ...

    You can Print the list if needed. 

    Help switches you to the Brightwell user manual.


    The payment page lists persons which are ready for exporting to Brightwell for payments:

    ...

    You will have also the possibility to lock the period of the persons who have already been exported.

    Help switches you to the Brightwell user manual.



    The Brightwell Navigator is a payments interface that simplifies your payroll distribution and gives your employees better control over their pay.
    This document contains everything you will need to create batch files to register and pay your employees.
    To be able to pay employees via the Brightwell program the employee will receive a debit card on which the payments are stored.
    To receive a debit card the employee needs to be enrolled/registered in the Brightwell program.

    ...

    1. Click the Setup button to perform the required setup for data exporting:



      Please define:
      1) Email Notification Address - should include at least one email address to receive file processing results (can be multiple addresses, separated by comma);
      2) Customer ID (mandatory, provided by Brightwell);
      3) Interface Entity ID (mandatory, provided by Brightwell);
      4) Product Group Alias (mandatory, provided by Brightwell);
      5) Card Stock Override Code (optional, provided by Brightwell).

    2. Browse the path on your PC where export files (registration/payment) will be saved.

    3. Each employee who will be paid through Navigator must first be registered.
      Tag needed person(s) who you want to be enrolled into the Brightwell program.

    4. Click Enroll command for the selected crew. Click USD or EUR (depends on person's payment currency).
      You will see two dialog boxes:
      Confirmation:





      Export completion:

      As a result, special text. the file will be generated and saved to your specified location.
      The file format allows you to send Brightwell the information needed to prepare each employee for Navigator enrolment.

      For technical documentation for an enrolment file sent to Brightwell please see Reference > Brightwell Enrollment File Specification.


      File Name Format
      registration{custID}{optional client-defined data}{MMDDYYYYhhmmss}.txt

      Example: registration123_brightwell_02092018165738.txt
      {custID} will be assigned to you by Brightwell Payments.
      {optional client-defined data} should be enclosed by "_". 

      Record Layout
      Please note that even though the specification below displays multiple lines per record, the file must be delivered with all data for a record type on one line.

      Example File:
      01|pr 3.0.1|brighwell Notification@company.com|Email
      02|123| 03P|ANNA||ZELENSKAYA|ADDRESS1|ADDRESS2|CITY|FL|123456789|USA|
      PAS123567|USA|12/31/1980|12/31/2010|100|01/01/1980|
      12345678901|EMPLOYEE@COMPANY.COM|LOCATION|12334121|USA|||ProductGroupAlias|Card stock Override code

      For each enrolment file that was sent, a response file will be received from Brightwell.
      Each Record Type will be indicated as either ‘Accepted’ or ‘Rejected’ (followed by a list of error codes, if any). See Reference > Brightwell Error Codes Table.
      The person will be moved to Waiting For Card page.

    5. You can also Exclude some persons from the Brightwell program.
      They'll be moved to Excluded page.

    ...

    Once the person has received the card, you can tag him and click Card Received to move the person to the Members list.
    If click Reset: a person will be moved to the Candidates page back.
    You can Print the list if needed.

    Help switches you to the Brightwell user manual.

    ...

    Will be moved to the Exclusion page.

    Help switches you to the Brightwell user manual.

    ...

    Will be moved to the Candidates page.

    Help switches you to the Brightwell user manual.

    ...

    Please note, the Standard Crew List view should be opened.

    Warning

    Payment procedure in Brightwell Interface is only available for a user who has access to Group Payment under Reports >Payroll Current Period Reports > Field 36 in ACC.


    So, users without access to create a Payment list have no access to the Payment tab.

    ...


    1. To Export data, only tagged persons on the grid will be included.
      Note, when the data is to be refreshed on the grid, all persons are tagged, you can adjust it as you want with Untagged individual.

      Click the Export button.


    2. Warning
      iconfalse
      If you confirm exporting, entry code 994 will be automatically locked.



    3. Payment Brightwell file is generated. 

      The export file will be located in the specified Export directory.
      File Name Format - payment{custID}{optional client-defined data}{MMDDYYYYhhmmss}.txt

      {custID} will be assigned to you by Brightwell Payments.
      {optional client-defined data} should be enclosed by "". (e.g.: _main office) 

      Our example:
      Payment123_brightwellUSD_02192018113124.txt 

      File Name depends on payment currency. 
      For technical documentation for the payment file, please see Reference > Brightwell Payment File Specification.

    4. You will have also the possibility to lock the period of the persons who have already been exported.

    5. You will see a confirmation message that the payment export was completed.

    6. You can perform a setup for payment by defining Payment type.

    ...

    or your FTP area to download the latest patch with the name like APM_Plugin_BWNavigator_2018.X.X.X

    Note

    Please close the APM application before plugin installation.

    ...

    The process is the same as with Brightwell Interface Plugin installation.

    ACC Access Rights

    Enabling Brightwell Interface

    After a plugin is installed, it appears available for setting up access in Adonis Control Centre > Plugins:



    You can enable/disable access per user level/group.
    If you have several sites, a plugin needs to be installed and enabled on each one.

    Granting Rights for Payment

    Payment procedure in Brightwell Interface is only available for the user(s) who has access for Group Payment under Reports > Payroll Current Period Reports > Field 36 in ACC:



    Users without access to create a Payment list have no access to the Payment tab in Brightwell.

    References


    Follow the link to see Brightwell Navigator, Standard File Formats manual:

    ...

    Brightwell Enrollment File Specification


    Field Name

    Length

    Notes

    Adonis xref

    FILE_HEADER_RECORD_TYPE


    Required Must be: 01

    Hard-Coded

    VERSION


    Required Must be: pr 3.0.0

    Hard-Coded

    EMAIL_NOTIFICATION_ ADDRESSES


    255 Required Must include at least one email address to receive the results of file processing multiple addresses must be separated by commas only (no spaces between the comma and email address).

    From Setup Screen <email notification Address>

    RESPONSE_PREFERENCE


    Optional Valid values are 'Email', 'Echo', 'Both', 'None' If empty, Email will be used

    Keep Empty for now the echo will come later

    BATCH_HEADER_RECORD_TYPE


    Required Must be: 02

    Hard-Coded

    ENTITY_INTERFACE_ID

    30

    Required Assigned by Brightwell Payments

    From Setup Screen <Interface Entity ID>

    PARTICIPANT_DETAIL_RECORD_TYPE


    Required Must be: 03P

    Hard-Coded

    FIRST_NAME

    20*

    Required

    P01.FIRSTNAME *If the overall length of a Participant's first and last name is greater than 21 characters (including spaces), the embossed name on the card will be the first letter of the first name and the last name. Example: If FIRST_NAME= "JONATHAN FRANCISCO" and LAST_NAME = "SMITH", then "J SMITH" will be embossed on the card.

    MIDDLE_INITIAL

    1

    Optional

    Skip Middle name is only 1 in length

    LAST_NAME

    20*

    Required

    P01.LASTNAME

    ADDRESS1

    50

    Required

    P01.ADDRESS1

    ADDRESS2

    50

    Optional

    P01.ADDRESS2

    CITY

    20

    Required

    PWPOST.NAME (FK PW001P01 POSTCODE=PWPOST.POSTCODE AND PW001P01.ADDRESSCOUNTRY=PWPOST.COUNTRYCODE)

    STATE_PROVINCE

    2

    if COUNTRY = USA otherwise 20, Required if COUNTRY=USA

    PWPOST.COUNTYCODE PW001P01.ADDRESSCOUNTRY="US"

    ZIP_POSTAL_CODE

    10

    Required if COUNTRY=USA

    PW001P01.POSTCODE PW001P01.ADDRESSCOUNTRY="US"

    COUNTRY

    3

    Required Refer to Country Codes for valid values.

    PWCOUNTRY.ISO3166_ALPHA3(FK PW001P01.ADDRESSCOUNTRY=PWCOUNTRY.COUNTYRCODE)

    PASSPORT_NUMBER

    50

    Required if no SSN provided

    PW001P08.TDNUMBER Passport with the latest expiry date

    PASSPORT_COUNTRY

    3

    Required if no SSN provided

    PWCOUNTRY.ISO3166_ALPHA3 (FK PWCOUNTRY.COUNTRYCODE=PW001P08.ISSUE_COUNTRY)

    PASSPORT_ISSUED_DATE

    10

    Required if no SSN provided MM/DD/YYYY

    PW001P08.DATEFROM

    PASSPORT_EXPIRATION_DATE

    10

    Required if no SSN provided MM/DD/YYYY

    PW001P08.DATETO

    EMPLOYEE_ID

    10

    Required Alphanumeric Leading zeros allowed

    PW001P01.PIN

    BIRTH_DATE

    10

    Required MM/DD/YYYY

    PW001P01.BIRTHDATE

    SSN

    11

    Required if no passport data provided xxx-xx-xxxx


    EMAIL

    39

    Optional A single email address for contacting the Participant

    <email address with the highest priority>If multiple priorities 1 emails then pick the first...

    LOCATION

    15

    Optional Ship name, staffing center, etc.

    Need to decide if we should the current or first planned sea service activity, if none found then leave blank

    PHONE

    15

    Optional

    Leave blank if we can't uniquely identify the phone country

    PHONE_COUNTRY

    3

    Required if Phone is not null

    Leave blank

    MOBILE_PHONE

    15

    For Future Use

    Leave Blank

    MOBILE_PHONE_COUNTRY

    3

    For Future Use

    Leave Blank

    PRODUCT_GROUP_ALIAS


    Required Client defined

    From setup screen <product group allias>

    CARD_STOCK_OVERRIDE_CODE


    6 or 7 Optional Alphanumeric; hyphens allowed, provided by Brightwell Payments

    Leave Blank

    BATCH_FOOTER_RECORD_TYPE


    Required Must be: 04

    Hard-Coded

    PARTICIPANT_DETAIL_RECORD_COUNT


    Required Cannot contain commas or decimal points.

    Number of participants records the number of pin numbers exported in PARTICIPANT_DETAIL_RECORD_TYPE segment

    ACCOUNT_DETAIL_RECORD_COUNT


    Required Count of 03A record types in the batch Cannot contain commas or decimal points.

    Hardcode 0 we are not exporting account records.

    FILE_FOOTER_RECORD_TYPE


    Required Must be: 05

    Hard-Coded

    NUMBER_OF_BATCHES


    Required Cannot contain commas or decimal points.

    Number of batches in this file


    Brightwell Error Codes Table


    Code

    Description

    R010

    The file format is no longer supported.

    R011

    Invalid email length

    R012

    Invalid email address

    R013

    Invalid response preference

    R014

    Duplicate file name

    R020

    Invalid batch count

    R030

    Entity Interface Number is required.

    R031

    Entity Interface Number is invalid.

    R032

    Entity Interface Number must be admin

    R040

    The number of participant records doesn't match the total in the trailer

    R041

    The number of account records doesn't match the total in the trailer

    R050

    The participant detail record is invalid. Unable to parse.

    R051

    Multiple participant records with the same Employee ID

    R052

    Product Group is a required field

    R053

    Product Group is invalid

    R054

    No products exist in the product group

    R055

    No card products exist in the product group to auto allocate to.



    R040

    The number of participant records doesn't match the total in the trailer

    R041

    The number of account records doesn't match the total in the trailer

    R050

    The participant detail record is invalid. Unable to parse.

    R051

    Multiple participant records with the same Employee ID

    R052

    Product Group is a required field

    R053

    Product Group is invalid

    R054

    No products exist in the product group

    R055

    No card products exist in the product group to auto allocate to.

    R056

    No money transfer products exist in the product group to auto allocate to.

    R057

    Product Group does not have a valid card inventory profile.

    R058

    Employee ID is required and should be between 1 and 10 ASCII characters.

    R059

    Employee ID already exists as an Account Holder

    R060

    Employee ID already exists as a Participant

    R061

    First Name is required and should be between 1 and 20 ASCII characters.

    R062

    Middle Initial should be 1 ASCII character in length only

    R063

    Last Name is required and should be between 1 and 20 ASCII characters.

    R064

    Address 1 is required and should be between 1 and 50 ASCII characters.

    R065

    Address 2 should be up to 50 ASCII characters.

    R066

    The country should be a valid 3 character country code.

    R067

    The city is required and should be between 1 and 20 ASCII characters.

    R068

    The state is required and should be 2 ASCII characters

    R069

    The state should be up to 2 ASCII characters

    R070

    Zip is required and should be between 1 and 10 ASCII characters.

    R071

    Zip is invalid. Must be formatted nnnnn-nnnn (9 digit Zip is optional)

    R072

    The city should be up to 20 ASCII characters

    R073

    Zip should be up to 10 ASCII characters

    R074

    A Social Security Number is required for Domestic Payroll or GPR

    R075

    A Passport Number is required for Maritime Payroll

    R076

    The passport Number provided is invalid

    R077

    Passport Country should be a valid 3 character country code

    R078

    Passport Issued Date is required when a passport number is provided

    R079

    Passport Expiration Date is required or must not be expired when a passport number is provided

    R080

    Passport Issued Date is invalid

    R081

    Passport Expiration Date is invalid

    R082

    Social Security Number is invalid. Must be formatted nnn-nn-nnnn.

    R083

    Valid Birth Date is required

    R084

    Email exceeds the maximum length of 39 characters or is invalid.

    R085

    Product Group is a required field

    R086

    Invalid input in field Location

    R087

    The phone should be up to {0} ASCII characters

    R088

    Phone Country should be a valid 3 character country code

    R089

    Mobile Phone should be up to {0} ASCII characters

    R090

    Mobile Phone Country should be a valid 3 character country code

    R091

    Card Stock Override cannot be used if Auto allocates 100% to Card = No. Participant created, but no card was ordered

    R092

    Invalid Card Stock Override

    R093

    Card fulfillment exception--Participant created. Card ordered. Fulfillment = Remote Print

    R094

    Card fulfillment exception--Participant created. Card ordered. Fulfillment = Regular

    R100

    The account detail record is invalid. Unable to parse.

    R101

    Currency ID should be up to {0} ASCII characters

    R102

    Currency ID is not a valid Currency ID

    R103

    Beneficiary Name should be up to 43 ASCII characters

    R104

    Beneficiary Street Address should be up to 35 ASCII characters

    R105

    Beneficiary City should be up to 35 ASCII characters

    R106

    Beneficiary Country should be a valid 3 character country code.

    R107

    Beneficiary State/Province is required and should be 2 ASCII characters

    R108

    Beneficiary State/Province should be up to 2 ASCII characters

    R109

    Beneficiary State/Province should be up to 35 ASCII characters

    R110

    Beneficiary Zip/Postal Code should be up to 20 ASCII characters

    R111

    Beneficiary Zip Code invalid for Country = USA

    R112

    Email exceeds the maximum length of 100 characters or is invalid

    R113

    Beneficiary Name contains special characters

    R114

    Bank Name should be between 1 and 35 ASCII characters

    R115

    Bank Country is required and should be between 1 and 3 ASCII characters.

    R116

    Bank Country should be a valid 3 character country code

    R117

    Bank Account Number is required and should be between 1 and 34 ASCII characters.

    R118

    Bank Account Number contains special characters.

    R119

    Bank Swift Code contains special characters.

    R120

    Bank Swift Code should be up to 11 ASCII characters

    R121

    Bank Routing Code contains special characters

    R122

    Bank Routing Code should be up to 29 ASCII characters

    R123

    Bank Swift Branch Details should be up to 45 ASCII characters

    R124

    Bank Street Address should be up to 35 ASCII characters

    R125

    Bank City should be up to 35 ASCII characters

    R126

    Bank State/Province is required and should be between 1 and {0} ASCII characters

    R127

    Bank State/Province should be up to 35 ASCII characters

    R128

    Bank Zip/Postal Code should be up to 20 ASCII characters

    R129

    Intermediary Bank Name should be up to {0} ASCII characters

    R130

    Intermediary Bank Country should be a valid 3 character country code

    R131

    Intermediary Bank Account Number should be up to 34 ASCII characters

    R132

    Intermediary Bank Swift Code should be up to 11 ASCII characters

    R133

    Intermediary Bank Routing Code should be up to 29 ASCII characters

    R134

    Intermediary Bank Swift Branch Details should be up to 45 ASCII characters

    R135

    Intermediary Bank Street Address should be up to 35 ASCII characters

    R136

    Intermediary Bank City should be up to 20 ASCII characters

    R137

    Intermediary Bank State/Province should be up to 2 ASCII characters

    R138

    Intermediary Bank State/Province should be up to 35 ASCII characters

    R139

    Intermediary Bank Zip/Postal Code should be up to 20 ASCII characters

    R140

    Nature of Relationship missing

    R141

    Nature of Relationship is invalid

    R142

    Invalid Account record as no participant record with this Employee ID exists in the batch



    Brightwell Payment File Specification


    Field Name

    Length

    Notes

    FILE_HEADER_RECORD_TYPE


    Required
    Must be: 01

    VERSION


    Required
    Must be: pf 2.0.0

    EMAIL_NOTIFICATION_ ADDRESSES

    255

    Required
    Must include at least one email address to receive the results of file processing
    Multiple addresses must be separated by commas only (no spaces between the comma and email address).

    RESPONSE_PREFERENCE


    Optional
    Valid values are 'Email', 'Echo', 'Both', 'None'
    If empty, Email will be used

    BATCH_HEADER_RECORD_TYPE


    Required
    Must be: 02

    ENTITY_INTERFACE_ID

    30

    Required
    Assigned by Brightwell Payments

    RELEASE_DATE

    8

    Optional
    If empty, the current date will be used
    Release date of card and money transfer disbursements resulting from payments in the batch.
    YYYYMMDD

    PAYMENT_TYPE


    Required
    Assigned by Brightwell Payments

    DETAIL_RECORD_TYPE


    Required
    Must be: 03

    EMPLOYEE_ID

    10

    Required
    Alphanumeric
    Leading zeros accepted