Skip to main content

Ally Payments

POST Get Ally Submerchant Details

The POST Get Ally Submerchant Details method allows AndDone allies to retrieve comprehensive information about a specific submerchant using its unique merchant ID. The response includes key details such as the submerchants contact information, active status, and timeline information.

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

Request Parameters

Field Name Data Type Mandatory Field Length Description
merchantID String true NA The submerchant's unique AndDone merchant ID.

Body Request Example (JSON)

    
      {
        "merchantId": "nZ8gjaxo"
      }

Response Parameters

Body Response Example (JSON)

    
{
                  "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"
                }