Menu

Merchant Application Object

The Merchant Application object is the base object for a Merchant Application submission. From the Merchant Application object, you will build out the rest of the objects and fields that make a complete submission of a Merchant Application.

Merchant Application Client Object

Description

This field links the Merchant Application you are about to create to your Partner SDK Credentials.
JSON Stringmerchant_application_client
TypeJSONObject
RequiredYes
CommentsMust include SDK Username, SDK Password, SDK Key

Merchant Application Object

Description

This field opens the request for a new Merchant Application and all other objects will be under this field.
JSON String merchant_application
TypeJSONObject
RequiredYes

Share To Email

Description

The account signer's email address where you want the Merchant Application sent to for their signatures.
JSON Stringmerchant_application_share_to_email
TypeString
RequiredYes
CommentsMust be a valid email address.

Auto Share to Merchant

Description

This will automatically share the application to the Merchant to get their signature.
JSON Stringmerchant_application_auto_share_to_merchant
TypeBoolean
RequiredNo

Auto Submit to Underwriting

Description

This will automatically submit the signed application to the Base Commerce Underwriting Department.
JSON Stringmerchant_application_auto_submit_to_underwriting
TypeBoolean
RequiredNo
CommentsThis can only be enabled once your integration specialist has approved you to do so.

Program ID

Description

The Application Program ID for your Merchant Application.
JSON Stringmerchant_application_program_id
TypeInteger
RequiredYes
CommentsThese will be provided to you by your integration specialist.

API Version

Description

Indicates what version of the API you are using to submit your applications.
JSON Stringmerchant_application_api_version
TypeString
RequiredYes

Response Code

Description

Describes the status of the submitted Merchant Application. On a successful submission, this field will be set to 200. On a submission with errors, this field will be set to 600.

JSON String

merchant_application_response_code

TypeInteger
RequiredYes

Response Messages

Description

Contains errors and the field that caused them on a returned Merchant Application. Key = field, Value = error. Errors should be fixed before reattempting to submit the application.
JSON Stringmerchant_application_response_messages
TypeMap<String, String>
RequiredYes

Custom Fields

Description

Custom Fields that can be setup by Base Commerce on your Applications.
JSON Stringmerchant_application_custom_fields
TypeString
RequiredConditional
CommentsPlease speak with your integration specialist for any custom fields for your applications.


BaseCommerceClient o_client = new BaseCommerceClient( "SDK_USERNAME", "SDK_PASSWORD", "SDK_KEY" );
o_client.setSandbox(true);
  MerchantApplication o_merchant_application = new MerchantApplication();
    o_merchant_application.setShareToEmail( "testemail@email.com" );
    o_merchant_application.setAutoShareToMerchant( false );
    o_merchant_application.setAutoSubmitToUnderwriting( false );
    o_merchant_application.setProgramId( "7" );
    o_merchant_application.setApiVersion( "1.2" );

//other objects and fields will be in this section

System.out.println(" o_merchant_application json = " + o_merchant_application.getJSON() );
        try {
            List<MerchantApplication> o_merchant_application = o_client.submitApplication( o_merchant_application );
            for ( MerchantApplication o_merchant_application : o_merchant_application ) {
                System.out.println("\n\n o_merchant_application response code = " + o_app.getResponseCode() );
                System.out.println("\n\n o_merchant_application  response messages = " + o_app.getResponseMessages() );