Retrieve merchant account details

This page explains how to retrieve the details for a merchant account.

Retrieve a merchant account

Use a GET request to retrieve a merchant account and merchantAccountStatus by passing merchantAccountId.

The merchantAccountStatus contains one of the following values:

BOARDING_IN_PROGRESS - The merchant account is in the process of being activated.
ACTIVE - The merchant account is active and eligible to process transactions.
BOARDING_DECLINED - The merchant account did not pass our internal review.
SUSPENDED - The merchant account is temporarily suspended and cannot process transactions.
CLOSED - The merchant account is permanently closed and cannot process transactions.

Retrieve status of merchant account:

HTTP method: GETEndpoint: /merchant-accounts/{merchantAccountId}

Response

Json

{
  "accountAlias": "Dannys Donuts",
  "accountName": "Dannys Donuts Downtown Location",
  "businessProfile": {
    "businessDescription": "Donut shop with exotic pastries",
    "digitalSales": {
      "usage": false,
      "website": "www.google.com"
    },
    "terminalSales": {
      "merchantManualKeyedTransactionsPercentage": 10,
      "usage": true
    }
  },
  "clientId": "3002035472",
  "contactInfo": {
    "phone": {
      "countryCode": "+1",
      "phoneNumber": "7894561551"
    },
    "email": "customersupport@dannysdonuts.com"
  },
  "enterprisePlatformIdentifier": "6019573573",
  "locationAddress": {
    "city": "Plano",
    "countryCode": "USA",
    "line1": "123 ABI Street",
    "postalCode": "71301-7610",
    "state": "TX"
  },
  "merchantAccountStatus": "BOARDING_IN_PROGRESS",
  "merchantCategoryCode": "7829",
  "merchantAccountId": "101128635403",
  "onboardRequestId": "10011033",
  "payoutAccount": {
    "financialInstitutionName": "JP Morgan Chase",
    "accountOwnerName": "Central Park Catering, LLC",
    "routingNumber": "00212345",
    "accountNumber": "1234567",
    "countryCode": "USA"
  },
  "payoutTemplate": "GROSS_PURCHASE_FUNDING",
  "pricingTemplate": "STANDARD_PRICING",
  "processingTemplate": "ACH_PROCESSING_SETUP",
  "projectedSalesInfo": {
    "annualCreditSales": 400000,
    "annualSalesTotal": 500000,
    "averageTicketSize": 7,
    "currency": "CAD"
  }
}