Skip to main content
GET
/
merchants
/
{id}

Endpoint

GET https://api.digitzs.com/merchants/{id}

Overview

Use this endpoint to retrieve complete details of a merchant account, including personal information, business details, and bank account information.

Authentication

HeaderValueRequired
x-api-keyYour API keyYes
AuthorizationBearer {appToken}Yes
appIdYour application IDYes

Path Parameters

id
string
required
The merchant account ID

Response

Success Response (200 OK)

{
  "links": {
    "self": "https://api.digitzs.com/merchants/merchant_abc123"
  },
  "data": {
    "type": "merchants",
    "id": "merchant_abc123",
    "attributes": {
      "AVS": "Standard",
      "accountType": "business",
      "accountName": "Acme Corporation",
      "status": "active",
      "createdAt": "2024-01-15T10:00:00Z",
      "personalInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "dayPhone": "4155551234"
      },
      "businessInfo": {
        "businessName": "Acme Corporation",
        "ein": "***4321",
        "email": "info@acme.com",
        "url": "https://acme.com"
      },
      "bankInfo": {
        "bankName": "Bank of America",
        "accountType": "checking",
        "last4": "7890"
      }
    }
  }
}
Sensitive Data Masked: SSN, EIN, and full account numbers are masked in responses for security.

Code Examples

curl -X GET https://api.digitzs.com/merchants/merchant_abc123 \
  -H "x-api-key: your-api-key" \
  -H "Authorization: Bearer your-app-token" \
  -H "appId: your-app-id"

Merchant Status Values

StatusDescription
activeMerchant can process payments
pendingMerchant account under review
suspendedAccount temporarily suspended
closedAccount permanently closed

Next Steps

List Merchants

View all merchant accounts