Account Maintenance Requests
The Account Maintenance module is designed to facilitate customer requests to existing merchants. These requests can be submitted through our user interface or via our API integrated with your system. We offer the following types of requests: Update Bank Account, Add a Location with Merchant Velocity, Add a Location with Location Velocity, Update Velocity Settings, and Other. The Other request is comparable to an email used to request additional changes, e.g., an address update or phone number update. We will continue to add new API calls, so check back often for updated information.
Authentications to Note
- Request_email is used to validate the user and if they have access/permission to run the API calls. If the requestor is not associated with the account, an error message will be returned to the user stating: User (email address) is not authorized to run the API.
- CustServProviderId and entity_id is used to validate that the Entity ID is related to that specific Partner’s custServProviderId. If the validation fails, an error message will be returned to the user: This Merchant (Entity ID) is not associated with this Partner.
You will need to submit data in the same format as you are set up to receive it.
REST DATA FORMAT
XML
<xml>
<CustSrvProvideld></CustSrvProvideld>
<EntityId></EntityId>
<CustomerName></CustomerName>
<RequestEmail></RequestEmail>
<!--Optional:-->
<Subject></Subject>
<!--Optional:-->
<Description></Description>
<!--Optional:-->
<CaseReason></CaseReason>
</xml>
JSON
{
"CustSrvProvideld" : "",
"EntityId" : "",
"CustomerName" : "",
"RequestEmail" : "",
"Subject" : ""
"Description" : "",
"CaseReason" : "",
}
Below are the URLs for the STAGE (test) environment:
Below are the URLs for the PRODUCTION environment: