Skip to main content
GET
/
merchants
/
{id}
Get Merchant by ID
curl --request GET \
  --url https://api.example.com/merchants/{id}
import requests

url = "https://api.example.com/merchants/{id}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/merchants/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/merchants/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/merchants/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/merchants/{id}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/merchants/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

​
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"

const axios = require('axios');

async function getMerchant(merchantId) {
  const response = await axios.get(
    `https://api.digitzs.com/merchants/${merchantId}`,
    {
      headers: {
        'x-api-key': 'your-api-key',
        'Authorization': 'Bearer your-app-token',
        'appId': 'your-app-id'
      }
    }
  );

  console.log('Merchant:', response.data.data.attributes.accountName);
  return response.data;
}

import requests

def get_merchant(merchant_id):
    url = f"https://api.digitzs.com/merchants/{merchant_id}"

    headers = {
        "x-api-key": "your-api-key",
        "Authorization": "Bearer your-app-token",
        "appId": "your-app-id"
    }

    response = requests.get(url, headers=headers)
    response.raise_for_status()
    return response.json()

<?php
function getMerchant($merchantId) {
    $url = "https://api.digitzs.com/merchants/" . $merchantId;

    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        "x-api-key: your-api-key",
        "Authorization: Bearer your-app-token",
        "appId: your-app-id"
    ]);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    return json_decode(curl_exec($ch), true);
}
?>

require 'net/http'
require 'json'

def get_merchant(merchant_id)
  uri = URI("https://api.digitzs.com/merchants/#{merchant_id}")
  request = Net::HTTP::Get.new(uri)
  request['x-api-key'] = 'your-api-key'
  request['Authorization'] = 'Bearer your-app-token'
  request['appId'] = 'your-app-id'

  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
    http.request(request)
  end

  JSON.parse(response.body)
end

​
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