Skip to main content

Get Merchant by Id

GET 
/merchants/:merchantId

Use this endpoint to view information about a specific merchant.

Note

There are no request parameters for this endpoint.

Request​

Path Parameters

    merchantId stringrequired

    The unique identifier of the merchant being searched.

    Example: xxxxxx

Header Parameters

    Authorization string

    appToken created by /auth/token Format: Bearer xxxxxx...

    Example: Bearer <appToken>

Responses​

Ok

Schema

    data

    object

    A key for grouping different types of API data. See Objects for more information.

    idstring

    Merchant Identification string for Digitzs.

    typestring

    The type of transaction. This value must be "merchants".

    attributes

    object

    A key for grouping identification and payment information.

    accountTypestring

    The type of bank account (Checking or Savings).

    accountNamestring

    The first and last name of the account holder.

    personalInfo

    object

    A key for grouping personal information.

    firstNamestring

    The merchant’s first name.

    lastNamestring

    The merchant’s last name.

    emailstring

    The merchant's email address.

    dayPhonestring

    The merchant’s daytime contact number.

    eveningPhonestring

    The merchant’s evening contact number.

    birthDatestring

    The merchant’s date of birth.

    socialSecuritystring

    The merchant’s social security number.

    personalAddress

    object

    A key for grouping personal address information.

    line1string

    The personal street address.

    line2string

    A second line for street address information.

    citystring

    The city where the individual is located.

    statestring

    The state where the individual is located.

    zipstring

    The postal code where the individual is located.

    countrystring

    The three-character country code.

    businessInfo

    object

    A key for grouping business information.

    businessNamestring

    The legal name of the business as registered.

    einstring

    The Employer Identification Number (EIN).

    businessAddress

    object

    A key for grouping business address information.

    line1string

    The business street address.

    line2string

    A second street address line.

    citystring

    The city where the business is located.

    statestring

    The state where the business is located.

    zipstring

    The postal code where the business is located.

    countrystring

    The three-character country code.

    bankInfo

    object

    A key for grouping banking information.

    bankNamestring

    The name of the financial institution.

    accountOwnershipstring

    The valid values are Personal or Business.

    accountTypestring

    The type of bank account (Checking or Savings).

    accountNamestring

    The first and last name of the account holder or the business Name.

    accountNumberstring

    The financial institution account number. It is required if boarding with the primary bank on file.

    routingNumberstring

    The bank routing number. This is required if the payment method is checking or savings.

    verificationData

    object

    A key for grouping server and timestamp information.

    ipAddressstring

    The IP address used for the transaction.

    emailVerifiedboolean

    A true or false value.

    emailVerifiedTimestampstring

    The date and time the email was sent.

    signaturestring

    The first and last name of the customer.

    signatureTimestampstring

    The date and time the transaction was authorized.

    termsAcceptedboolean

    A true or false value.