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

    Example: 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.

    Example: Standard
    accountType string

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

    Example: business
    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.

    Example: ACME Enterprise

    personalInfo

    object

    A key for grouping personal information.

    firstName string

    The merchant’s first name.

    Example: John
    lastName string

    The merchant’s last name.

    Example: Doe
    email string

    The merchant's email address.

    Example: johndoe@email.com
    dayPhone string

    The merchant’s daytime contact number.

    Example: 3105551222
    eveningPhone string

    The merchant’s evening contact number.

    Example: 3105551222
    birthDate string

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

    Example: 01-01-1981
    socialSecurity string

    The merchant’s social security number.

    Example: 123456789

    personalAddress

    object

    A key for grouping personal address information.

    line1 string

    The personal street address.

    Example: 21 Jump Street
    line2 string

    A second line for street address information.

    Example: Suite 007
    city string

    The city where the individual is located.

    Example: Los Angeles
    state string

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

    Example: CA
    zip string

    The postal code where the individual is located.

    Example: 90210
    country string

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

    Example: USA

    businessInfo

    object

    A key for grouping business information.

    businessName string

    The legal name of the business as registered.

    Example: Legal Name LLC
    ein string

    The Employer Identification Number (EIN).

    Example: 123456789
    phone string

    The Business Phone Number (Optional).

    Example: 5555555555
    email string

    The Business Email (Optional).

    Example: test@email.co
    url string

    The Business's website URL (optional).

    Example: https://test.com

    businessAddress

    object

    A key for grouping business address information.

    line1 string

    The business street address.

    Example: 21 Jump Streets
    line2 string

    A second street address line.

    Example: Suite 007
    city string

    The city where the business is located.

    Example: Los ANgeles
    state string

    The state where the business is located.

    Example: CA
    zip string

    The postal code where the business is located.

    Example: 90210
    country string

    The three-character country code.

    Example: USA

    bankInfo

    object

    A key for grouping banking information.

    bankName string

    The name of the financial institution.

    Example: Bank of Abundance
    accountOwnership string

    The valid values are Personal or Business.

    Example: business
    accountType string

    The type of bank account (Checking or Savings).

    Example: checking
    accountName string

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

    Example: doe's money account
    accountNumber string

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

    Example: 2341234321
    routingNumber string

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

    Example: 000000000

    verificationData

    object

    A key for grouping server and timestamp information.

    ipAddress string

    The IP address used for the transaction.

    Example: 192.168.0.1
    emailVerified boolean

    A true or false value.

    Example: true
    emailVerifiedTimestamp date-time

    The date and time the email was sent.

    Example: 2016-01-31T11:16:07.234Z
    signature string

    The first and last name of the customer.

    Example: Huyen dinh
    signatureTimestamp date-time

    The date and time the transaction was authorized.

    Example: 2016-01-31T11:16:07.234Z
    termsAccepted boolean

    A true or false value.

    Example: true
    threatMatrixPolicy string

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

    Example: Default
    threatMetrixSessionId string

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

    Example: x

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...