Create Merchant - Digitzs API Documentation

Create Merchant

curl --request POST \
  --url https://api.example.com/merchants \
  --header 'Content-Type: application/json' \
  --data '
{
  "data.type": "<string>",
  "data.attributes": {},
  "data.attributes.AVS": "<string>",
  "data.attributes.accountType": "<string>",
  "data.attributes.accountName": "<string>",
  "data.attributes.miscData": "<string>",
  "data.attributes.personalInfo": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "dayPhone": "<string>",
    "eveningPhone": "<string>",
    "birthDate": "<string>",
    "socialSecurity": "<string>"
  },
  "data.attributes.personalAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "data.attributes.businessInfo": {
    "businessName": "<string>",
    "ein": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "url": "<string>"
  },
  "data.attributes.businessAddress": {},
  "data.attributes.bankInfo": {
    "bankName": "<string>",
    "accountOwnership": "<string>",
    "accountType": "<string>",
    "accountName": "<string>",
    "accountNumber": "<string>",
    "routingNumber": "<string>"
  },
  "data.attributes.verificationData": {
    "ipAddress": "<string>",
    "emailVerified": true,
    "emailVerifiedTimestamp": "<string>",
    "signature": "<string>",
    "signatureTimestamp": "<string>",
    "termsAccepted": true
  },
  "data.attributes.threatMetrixPolicy": "<string>",
  "data.attributes.threatMetrixSessionId": "<string>"
}
'

{
  "data.id": "<string>"
}

POST

merchants

Create Merchant

curl --request POST \
  --url https://api.example.com/merchants \
  --header 'Content-Type: application/json' \
  --data '
{
  "data.type": "<string>",
  "data.attributes": {},
  "data.attributes.AVS": "<string>",
  "data.attributes.accountType": "<string>",
  "data.attributes.accountName": "<string>",
  "data.attributes.miscData": "<string>",
  "data.attributes.personalInfo": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "dayPhone": "<string>",
    "eveningPhone": "<string>",
    "birthDate": "<string>",
    "socialSecurity": "<string>"
  },
  "data.attributes.personalAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "data.attributes.businessInfo": {
    "businessName": "<string>",
    "ein": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "url": "<string>"
  },
  "data.attributes.businessAddress": {},
  "data.attributes.bankInfo": {
    "bankName": "<string>",
    "accountOwnership": "<string>",
    "accountType": "<string>",
    "accountName": "<string>",
    "accountNumber": "<string>",
    "routingNumber": "<string>"
  },
  "data.attributes.verificationData": {
    "ipAddress": "<string>",
    "emailVerified": true,
    "emailVerifiedTimestamp": "<string>",
    "signature": "<string>",
    "signatureTimestamp": "<string>",
    "termsAccepted": true
  },
  "data.attributes.threatMetrixPolicy": "<string>",
  "data.attributes.threatMetrixSessionId": "<string>"
}
'

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

Header	Value	Required
`x-api-key`	Your API key	Yes
`Authorization`	`Bearer {appToken}`	Yes
`appId`	Your application ID	Yes
`Content-Type`	`application/json`	Yes

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

Show Personal info properties

firstName

string

required

First name

lastName

string

required

Last name

string

required

Email address

dayPhone

string

required

Daytime phone number

eveningPhone

string

Evening phone number

birthDate

string

required

Date of birth (MM-DD-YYYY format)

Social Security Number (SSN)

data.attributes.personalAddress

object

required

Personal address

Show Address properties

line1

string

required

Street address

line2

string

Address line 2

city

string

required

City

state

string

required

State code

zip

string

required

ZIP code

country

string

required

Country code

data.attributes.businessInfo

object

Business information (required for business accounts)

Show Business info properties

businessName

string

required

Legal business name

ein

string

required

Employer Identification Number (EIN)

phone

string

required

Business phone number

string

required

Business email address

url

string

Business website URL

data.attributes.businessAddress

object

Business address (required for business accounts)

data.attributes.bankInfo

object

required

Bank account information for deposits

Show Bank info properties

bankName

string

required

Name of financial institution

accountOwnership

string

required

"personal" or "business"

accountType

string

required

"checking" or "savings"

accountName

string

required

Account holder name

accountNumber

string

required

Bank account number

routingNumber

string

required

9-digit routing number

data.attributes.verificationData

object

required

Verification and compliance data

Show Verification properties

ipAddress

string

required

IP address of account holder during signup

emailVerified

boolean

required

Whether email has been verified

emailVerifiedTimestamp

string

ISO 8601 timestamp of email verification

signature

string

required

Account holder’s signature

signatureTimestamp

string

required

ISO 8601 timestamp of signature

termsAccepted

boolean

required

Must be true - indicates terms acceptance

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

Mode	Description
`Standard`	Requires ZIP code match for card payments
`Strict`	Requires full address match for card payments
`Disabled`	No 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

Validate Data: Validate all fields before submission to prevent errors
Secure Collection: Use secure forms to collect sensitive information
Email Verification: Verify email addresses before creating accounts
Terms Acceptance: Ensure users explicitly accept terms and conditions
IP Logging: Record accurate IP addresses for compliance
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

Merchant Endpoints Get Merchant by ID

Documentation Index

​Endpoint

​Overview

​Authentication

​Request Body

​Example Request

​Response

​Success Response (201 Created)

​Code Examples

​AVS Modes

​Important Notes

​Best Practices

​Next Steps

Get Merchant Details

Update Bank Info

Endpoint

Overview

Authentication

Request Body

Example Request

Response

Success Response (201 Created)

Code Examples

AVS Modes

Important Notes

Best Practices

Next Steps