Skip to main content

Ally Payments

POST Search Ally Submerchants

The Search Ally Submerchants method allows you to query outbound payment records based on various filter criteria, such as company name, active status, and created date range. This method returns a paginated list of matching submerchants, including details like contact name, phone number and address.

Note: This API is supported in AndDone version 2.3 only.

API Endpoint
https://api.uat.anddone.com/secure/allies/merchants/search
Authorization
x-api-key The API key ({env_merchantAccessKey}) associated with the AndDone Ally user who is submitting the transaction on the sub-merchant's behalf.
Request Headers
x-app-key The Merchant ID ({env_merchantId}) of the Ally sub-merchant.
x-version API version (e.g., 2.3)
Origin URL or IP address provided to AndDone as an allowed origin.
Content-Type application/json
API Data Details
URI /secure/allies/merchants/search
Method POST
Authorization API Key Authorization

Query Parameters

Parameter Description
companyName The company name of the merchant.
firstName The merchant's first name.
lastName The merchant's last name.
email The merchant's email address.
phone The merchant's phone number.
city The City of the merchant's address.
postalCode The Postal code of the merchant's address.
isActive Indicates whether the merchant is currently active in the AndDone system. Accepts true or false.
merchantId The merchant's unique identifier in the AndDone system.
adminName The merchant's admin name.
dBAName The merchant's “Doing Business As” (DBA) name.
startDate Indicates the beginning date of the merchant's createdOn date range. Format: YYYY-MM-DD hh:mm:ss.
endDate Indicates the end date of the merchant's createdOn date range. Format: YYYY-MM-DD hh:mm:ss.
searchText This parameter accepts free text to search across all available fields in the submerchant records.
startRow Sets the starting row for pagination (zero-based index).
pageSize Sets the number of records to return per page.
sortField Specifies the field name to sort by (for example, createdAt or companyName).
asc Specifies sort order: true for ascending, false for descending.

Request

Example Request
https://api.uat.anddone.com/secure/allies/merchants/search?merchantId=nZ8gjaxo

Response

Body Response Example (JSON)


   {
                  "totalRowCount": 1,
                  "data": [
                    {
                      "id": "nZ8gjaxo",
                      "merchantAdminUser": "nZ8gjaxo",
                      "companyName": "Pfeffer Group",
                      "contact": {
                        "name": {
                          "title": "Mr.",
                          "firstName": "Damion",
                          "middleName": "E.",
                          "lastName": "Pfeffer"
                        },
                        "companyName": "Pfeffer Group",
                        "department": "Sales",
                        "fax": "1234567890",
                        "phone": "1234567890",
                        "alternatePhone": "1234567890",
                        "mobile": "1234567890",
                        "email": "[email protected]",
                        "url": "https://pfeffergroup.com",
                        "address": {
                          "addressLine1": "123 Main St",
                          "addressLine2": "Apt 4B",
                          "city": "New York",
                          "state": "NY",
                          "country": 77,
                          "postalCode": "10001",
                          "timeZone": "EST"
                        },
                        "isdCode": null
                      },
                      "loginURL": "https://pfeffergroup.com/login",
                      "merchantId": "nZ8gjaxo",
                      "merchantActivatedOn": "11-13-2024 01:15:25",
                      "userIsActive": true,
                      "userIsLock": false,
                      "isActive": true,
                      "createdOn": "11-13-2024 01:15:25",
                      "createdBy": "admin",
                      "modifiedOn": "11-13-2024 01:15:25",
                      "modifiedBy": "admin",
                      "accessKey": "wefrtyuiop",
                      "paymentToken": "1234567890",
                      "hasIntegrationAccess": false,
                      "hierarchy": "Level 1",
                      "dbaName": "Pfeffer Group DBA",
                      "considerDBAName": true,
                      "changedPasswordOn": "11-13-2024 01:15:25",
                      "closeTime": "17:00:00",
                      "utcCloseTime": "17:00:00",
                      "isQuickOnBoarding": false,
                      "payoutTimeType": 1,
                      "onboardingType": 1,
                      "allyId": "6MxaKld3"
                    }
                  ]
              }