Skip to main content

Create Merchant

POST 
/merchants

Use this endpoint to set up a new merchant account.

Request​

Header Parameters

    Authorization string

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

    Example: Bearer <appToken>

Body

required

    data

    object

    A key for grouping different types of API data.

    type string

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

    attributes

    object

    A key for grouping identification and payment information.

    AVS string

    The AVS mode to set merchant to. Can be Standard, Moderate, or Enhanced.

    accountType string

    The type of bank account (personal or business). If set to business, enables and requires the businessInfo and businessAddress groupings.

    accountName string

    The first and last name of the account holder, or if a business, use the business's name. This is also the Statement Descriptor that customers will see on their bank.

    personalInfo

    object

    A key for grouping personal information.

    firstName string

    The merchant’s first name.

    lastName string

    The merchant’s last name.

    email string

    The merchant's email address.

    dayPhone string

    The merchant’s daytime contact number.

    eveningPhone string

    The merchant’s evening contact number.

    birthDate string

    The merchant’s date of birth. Use "01-01-1981" for the test environment.

    socialSecurity string

    The merchant’s social security number.

    personalAddress

    object

    A key for grouping personal address information.

    line1 string

    The personal street address.

    line2 string

    A second line for street address information.

    city string

    The city where the individual is located.

    state string

    The state where the individual is located. See State and Province Codes for more information.

    zip string

    The postal code where the individual is located.

    country string

    The three-character country code. See Country Codes for more information.

    businessInfo

    object

    A key for grouping business information.

    businessName string

    The legal name of the business as registered.

    ein string

    The Employer Identification Number (EIN).

    phone string

    The Business Phone Number (Optional).

    email string

    The Business Email (Optional).

    url string

    The Business's website URL (optional).

    businessAddress

    object

    A key for grouping business address information.

    line1 string

    The business street address.

    line2 string

    A second street address line.

    city string

    The city where the business is located.

    state string

    The state where the business is located.

    zip string

    The postal code where the business is located.

    country string

    The three-character country code.

    bankInfo

    object

    A key for grouping banking information.

    bankName string

    The name of the financial institution.

    accountOwnership string

    The valid values are Personal or Business.

    accountType string

    The type of bank account (Checking or Savings).

    accountName string

    The Account name attached to the bank account. (Either account holder's name, or the business name)

    accountNumber string

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

    routingNumber string

    The bank routing number. This is required if the payment method is checking or savings. Test environment requires a real routing number.

    verificationData

    object

    A key for grouping server and timestamp information.

    ipAddress string

    The IP address used for the transaction.

    emailVerified boolean

    A true or false value.

    emailVerifiedTimestamp date-time

    The date and time the email was sent.

    signature string

    The first and last name of the customer.

    signatureTimestamp date-time

    The date and time the transaction was authorized.

    termsAccepted boolean

    A true or false value.

    threatMatrixPolicy string

    Defaults to Default, Policy to use for ThreatMetrix (optional).

    threatMetrixSessionId string

    A unique identifier (preferably uuidv4), previously used for ThreatMetrix Embed. See the ThreatMetrix documentation for more information (optional).

Responses​

Created

Schema

    data

    object

    A key for grouping different types of API data.

    type string

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

    id string

    A merchant identifier. This is the account where the split goes after the transaction settles.

Loading...