About UsStatus Page
Developer API
  1. Partner API
  2. API Merchant Enrollment

Update Merchant Registration Data

put
https://apiprod.fattlabs.com/merchant//registration

Upserts registration data for a merchant, used during onboarding.

Overview

This endpoint allows you to upsert merchant registration data during the onboarding process, providing comprehensive support for merchant verification, compliance, and self-registration workflows.

user-plus
Registration Data

Collect principal signer, business, and beneficial owner information

shield-check
Auto-Verification

Automatically verify merchant information and identify required documents

balance-scale
Federal Compliance

Meet federal requirements for beneficial ownership disclosure

Key Features

address-cardRegistration Information

Data provided at the root of the request body (e.g., first_name, business_name) pertains to the Principal Signer/Control Owner or the business itself.

Additional Representatives/Beneficial Owners

  • If there are Additional Representatives or Beneficial Owners, include their information in the meta.representatives array.
  • Each representative should be provided as an object containing their details.
signatureElectronic Signature

This field should contain the HTML content of the terms and conditions.

Implementation Steps:

  1. Retrieve the terms and conditions using the Retrieve Terms and Conditions endpoint
  2. Include this content to capture the merchant's agreement to the terms during the enrollment process
check-doubleAuto-Verification

Determines whether to run automatic verifications on the registration information. Verifications help confirm the accuracy of the merchant's information and identify any additional documents required.

Types of Verifications

Person Identification and SSN Verification:

  • Run on the principal and any beneficial owners
  • Validates personal information against external databases

Business Identification and Banking Verification:

  • Run on the business information
  • Ensures that the business is legitimate and that banking details are correct

Note: If a verification fails, the relevant registration documents will be enabled.

flag-usaFederal Compliance

As of May 11, 2018, you must provide information on Control Owners and Beneficial Owners (individuals owning 25% or more of the entity).

Requirements

  • Provide information on any additional representatives if any individuals directly or indirectly own 25% or more of the entity
  • Ensure that all necessary personal and ownership details are included for compliance
cogSelf-Registration Field Permissions

Control the visibility and editability of fields during the self-registration process, particularly when using Stax's hosted Signup Pages.

Automatic Field Hiding

Set hide_prefilled_fields: true in your payload to automatically hide any fields that are prefilled via the API. This streamlines the registration process by only displaying fields that require the merchant's input.

Manual Field Control

Use the field_permissions object within the registration parameter to manually set permissions for specific fields.

Field Permission Options

  • null: Field will be hidden
  • read: Field will be read-only
  • write: Field will be writable (default behavior)

Behavior Notes:

  • If all fields in a given section are hidden, the entire section or page will be hidden from the front-end user interface
  • If all fields for a given page have been prefilled and hidden, the page will be removed from the sidebar tracker in the self-registration application
  • Hidden fields with values passed in will not be visible on the review step

Important Considerations

Data Accuracy

  • Ensure all provided information is accurate to prevent delays in the underwriting process
  • Inaccurate or incomplete data may lead to failed auto-verifications and additional document requirements

Compliance Requirements

  • Be thorough in collecting information on all required representatives to meet federal regulations
  • Missing information on beneficial owners can result in application rejections
Path Params
string
required

ID of the merchant

Body Params
string

100 character max. Merchant email address.

string

Merchant owner/signer first name. 100 character max.

string

Merchant owner/signer last name. 100 character max.

string
enum

Refund policy. N: No Refunds, E: Merchandise Exchange Only, T: 30 Days or Fewer, O: Other

Allowed:
string

Merchant fax number. format: (999) 999-9999, 9999999999, 999-999-9999.

string

Merchant business legal name. 100 character max.

string

Merchant business 'Doing Business As' name (should be same as legal name if no dba).

string

merchant business website address (include http://). 100 characters max.

string

Merchant business phone number, format: (999) 999-9999, 9999999999, 999-999-9999.

string

Merchant business address line 1.100 characters max.

string

merchant business address line 2 (optional if no address line 2). 100 characters max.

string

Merchant business city.

string

The two letter abbreviation of the state.

string

Merchant business zip

string

Merchant business country 2 characters.

string

Merchant business address line 1 (if no secondary billing address, this field should be a duplicate of business_address_1)

string

Merchant business address line 2 (if no secondary billing address, this field should be a duplicate of business_address_2)

string

Merchant business city (if no secondary billing address, this field should be a duplicate of business_address_city)

string

Merchant business state two letters (if no secondary billing address, this field should be a duplicate of business_address_state)

string

Merchant business zip (if no secondary billing address, this field should be a duplicate of business_address_zip).

string

Merchant business country iso alpha-2(if no secondary billing address, this field should be a duplicate of business_address_country).

string

Merchant business phone number, format: (999) 999-9999 (if no secondary billing address, this field should be a duplicate of business_address_phone).

string

Merchant business open date. Format MM/DD/YYYY.

string
enum

A: Association/Estate/Trust, G: Government (Federal/State/Local), S: Individual/Sole Proprietor, F: Financial Institution, L: LLC (Limited-Liability Corporation), E: Tax-Exempt Organization (501C), P: Partnership, V: Private Corporation, B: Public Corporation, R: SEC-Registered Entity.

string

Merchant business tax id. Format: 12-3456789.

string

Merchant's annual credit card only volume.

string

Merchant's annual ACH volume. Can be null.

string

Merchant's credit card average transaction size.

string

Merchant's average ACH transaction size. Can be null.

string

Merchant's reported highest credit card transaction amount.

string

Merchant's reported highest ACH transaction amount. Can be null.

string

Merchant volume card present percent eg: 50 (ex. Terminal transactions where card is physically present at time of transaction)

string

Merchant volume of card swiped transactions. percent eg 50. Can be null.

string

Merchant volume not present, e.g., 15 (e.g., transactions taken on the website where the user enters card information into a form).

string

Merchant volume percentage taken over moto (mail order telephone order) -- typically the same value as card_not_present_percent.

string

Merchant volume percentage taken over the internet.

string

The merchant business to business volume percentage

string

The merchant international volume percentage.

string

The billing bank routing number.

string

The billing bank account number.

string

The billing bank account owner name.

string

IMPORTANT: Partners only. Please reach out to your account manager or POC for information on your pricing plan option(s).

string
enum

Has merchant processed before or are they not currently processing. PROC_CHANGE: merchant is currently processing with a different processor and needs to change processors. NOT_NOW_PROC: merchant is not currently processing payments

Allowed:
string

IMPORTANT: Partners only. Please reach out to your account manager or POC for information on mcc codes if needed.

string

The merchant business main service/ product description. Max 200 characters.

string
enum

Business type: 1: Retail, 11: Restaurant, 12: Moto, 18: Internet

Allowed:
string
enum

Sub business type: 19: Retail.key entered, 45: Moto, 13: Dial pay capture, 36: Interchange plus

Allowed:
string

The merchant owner principal first and last name.

string

The merchant owner title (same as title).

string

The merchant owner title (same as job_title).

string

Owner date of birth. Format: MM/DD/YYYY

string

Driver's license id of the owner/signer. Can be null.

string

The state where driver's license of the owner/signer was issued (Please send in a 2-character state code. ex. "FL" for Florida). Can be null.

string

Owner/signer phone number, format: (999) 999-9999.

string
string
string
string

Owner/signer's 2-character state.

string

Owner/signer's 2 character state.

string

Postal / Zip code.

string

Primary owner/signer social security number.

string

max 100 characters.

electronic_signature
object
credit_inquiry_electronic_signature
object
meta
object
string

See Add File To Merchant Registration route for more information.

boolean

Determines whether or not to run autoverification on the registration record. See "Get Registration Documents" for more info on autoverification.

Responses

Updated 10 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

Did this page help you?