Update Import Settings

---

Introduction

The Merchant Boarding Web Service offers the ability to update the import settings pertaining to the Financial Institution (FI). Typically, the import settings do not need to be updated once they are created but in this guide we will show you how to update the import settings for the FI.

Getting Started

Tasks covered in this guide

• Update previously created Import Settings for the merchant boarding file upload.

Required prerequisites before you continue

• You will need to obtain your test credentials to try any of the examples in this guide. You should receive these from the Integrations team near the start of your project.
• Review the Merchant Boarding File Upload Process Guide for an understanding on how to create and receive the File Import ID.

Update Import Settings Workflow

Update Import Settings Diagram

	Integrator Merchant Boarding Flow				SmartPay Merchant Boarding Web Service Flow
	SmartPay Merchant Boarding Web Service
1.	Send Update Import Settings request using the previously obtained importSettingID.
					The Update Import Settings response returns the same importSettingId and returns any existing and/or updated settings.

Step 1 Send Update Import Settings request using the previously obtained importSettingID.

note

If a data element is left blank, the data element will be updated to null.

UpdateImportSettings Request Example

• "Method": PUT
• "Endpoint": https://ws.eps.profitstars.com/fileupload/entities/{entityId}/file-uploads/settings/{importSettingId}
• "Content-Type": application/JSON
• "Authorization": Set the Bearer Token in the authorization.

{
    "settings":{
        "fileTypeId": "Boarding",
        "StoreId": StoreId,
        "userName": "RTG User",
        "custServId": custServId,
        "ownerEntityId": ownerEntityId,
        "fileFormat": "XML",
        "source": "FIBoarding",
        "notifyIndividually": true
    }
}

The Update Import Settings response returns the same importSettingId and returns any existing and/or updated settings.

UpdateImportSettings Response Example

• "HTTP Status": 200
• "Content-Type": application/JSON

{
    "setting": {
        "importSettingId": "66aaa414f505fd0e38139451",
        "entityId": entityId,
        "fileTypeId": "Boarding",
        "allowDuplicates": false,
        "autoAuthorize": [
            "File_Import"
        ],
        "responses": [],
        "settings": {
            "fileTypeId": "Boarding",
            "test": null,
            "storeId": storeId,
            "storeKey": null,
            "userName": "RTG User",
            "custServId": custServId,
            "ownerEntityId": ownerEntityId,
            "fileFormat": "XML",
            "source": "FIBoarding",
            "notifyIndividually": true
        },
        "auditInfo": {
            "workingEntityId": workingEntityId,
            "userId": 0,
            "appId": 113,
            "userFullName": null,
            "reason": "ImportSetting for Boarding"
        }
    }
}

Handling Errors and Failed Requests

Not all requests will be successful, so we will run through a few common error messages you should be ready to handle.

• 401 Unauthorized: This error is returned when the Bearer Token has expired. If this appears, have the user obtain a new Bearer Token using the Bearer Token request.

• 403 Forbidden: This error is returned when the entityID is incorrect. If this appears, confirm the valid entityID with customer support.

Next steps

• Review the API Reference

Please review the API Reference to see all APIs and their technical specifications.

• Explore other guides

We have other guides to show how to leverage our APIs in other common use cases so if this one doesn’t cover what you are looking for, give another guide a try. If your situation or question is not covered in the current guide, consult another resource.

• Get certified and move into production

Ready to put your new code into production use? Refer to this process guide that explains our certification steps and how to contact us to get started.