Skip to main content
POST
/
merchants
{
  "data.id": "<string>"
}

​
Endpoint

POST https://api.digitzs.com/merchants

​
Overview

Use this endpoint to create a new merchant account. This comprehensive onboarding process collects personal, business, and banking information required for payment processing.
Merchant accounts are created in real-time and can begin processing payments immediately upon approval.

​
Authentication

HeaderValueRequired
x-api-keyYour API keyYes
AuthorizationBearer {appToken}Yes
appIdYour application IDYes
Content-Typeapplication/jsonYes

​
Request Body

​
data.type
string
required
Must be "merchants"
​
data.attributes
object
required
Merchant account attributes
​
data.attributes.AVS
string
required
AVS mode: "Standard", "Strict", or "Disabled"
​
data.attributes.accountType
string
required
Account type: "personal" or "business"
​
data.attributes.accountName
string
required
Name for the merchant account
​
data.attributes.miscData
string
Optional additional metadata
​
data.attributes.personalInfo
object
required
Personal information for account holder
​
data.attributes.personalAddress
object
required
Personal address
​
data.attributes.businessInfo
object
Business information (required for business accounts)
​
data.attributes.businessAddress
object
Business address (required for business accounts)
​
data.attributes.bankInfo
object
required
Bank account information for deposits
​
data.attributes.verificationData
object
required
Verification and compliance data
​
data.attributes.threatMetrixPolicy
string
Fraud detection policy: "Default", "Strict", or "Disabled"
​
data.attributes.threatMetrixSessionId
string
ThreatMetrix session identifier for fraud screening

​
Example Request

{
  "data": {
    "type": "merchants",
    "attributes": {
      "AVS": "Standard",
      "accountType": "business",
      "accountName": "Acme Corporation",
      "personalInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "dayPhone": "4155551234",
        "eveningPhone": "4155551234",
        "birthDate": "01-15-1980",
        "socialSecurity": "123456789"
      },
      "personalAddress": {
        "line1": "123 Main Street",
        "line2": "Suite 100",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94102",
        "country": "USA"
      },
      "businessInfo": {
        "businessName": "Acme Corporation",
        "ein": "987654321",
        "phone": "4155555000",
        "email": "info@acme.com",
        "url": "https://acme.com"
      },
      "businessAddress": {
        "line1": "456 Market Street",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94102",
        "country": "USA"
      },
      "bankInfo": {
        "bankName": "Bank of America",
        "accountOwnership": "business",
        "accountType": "checking",
        "accountName": "Acme Corporation",
        "accountNumber": "1234567890",
        "routingNumber": "026009593"
      },
      "verificationData": {
        "ipAddress": "192.168.1.1",
        "emailVerified": true,
        "emailVerifiedTimestamp": "2024-01-15T10:00:00Z",
        "signature": "John Doe",
        "signatureTimestamp": "2024-01-15T10:05:00Z",
        "termsAccepted": true
      },
      "threatMetrixPolicy": "Default",
      "threatMetrixSessionId": "abc123session456"
    }
  }
}

​
Response

​
Success Response (201 Created)

{
  "links": {
    "self": "https://api.digitzs.com/merchants"
  },
  "data": {
    "type": "merchants",
    "id": "merchant_abc123xyz"
  }
}
​
data.id
string
Unique merchant account identifier. Use this ID for all payment processing.

​
Code Examples

curl -X POST https://api.digitzs.com/merchants \
  -H "x-api-key: your-api-key" \
  -H "Authorization: Bearer your-app-token" \
  -H "appId: your-app-id" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "type": "merchants",
      "attributes": {
        "AVS": "Standard",
        "accountType": "business",
        "accountName": "Acme Corporation",
        "personalInfo": { ... },
        "personalAddress": { ... },
        "businessInfo": { ... },
        "businessAddress": { ... },
        "bankInfo": { ... },
        "verificationData": { ... }
      }
    }
  }'

​
AVS Modes

ModeDescription
StandardRequires ZIP code match for card payments
StrictRequires full address match for card payments
DisabledNo AVS verification required

​
Important Notes

Sensitive Data: This endpoint handles sensitive personal and financial information. Ensure your application uses HTTPS and follows security best practices.
Real-Time Creation: Merchant accounts are created instantly and can process payments immediately after successful creation.
Fraud Prevention: Use ThreatMetrix integration for enhanced fraud detection during merchant onboarding.

​
Best Practices

  1. Validate Data: Validate all fields before submission to prevent errors
  2. Secure Collection: Use secure forms to collect sensitive information
  3. Email Verification: Verify email addresses before creating accounts
  4. Terms Acceptance: Ensure users explicitly accept terms and conditions
  5. IP Logging: Record accurate IP addresses for compliance
  6. Test Mode: Test thoroughly in sandbox before production deployment

​
Next Steps

Get Merchant Details

Retrieve merchant account information

Update Bank Info

Update merchant bank account details