Save Data

Add data to a merchant application through our API.

This guide shows how to use the Application Boarding API resource to prefill data requested in a merchant application. For field definitions, see Application Boarding Conventions in Reference and Save Data in our API Reference.

Prerequisites

1. Contact Maast to set up your Maast Partner account.
2. Follow the steps in Get Your API Credentials to save your vendor sandbox ID and API key.
3. See Authentication to format the credentials and generate your API token. (Alternatively, use the credentials as-is to test this endpoint with our 'Try It!' feature.)
4. Use the Create Application guide to generate an application and save its application ID (appid).

Implement

Write a POST request. For the request endpoint, include the application ID (appid) of the application you wish to prefill, placing it between application/ and /data. The resulting endpoint is /platform/application/{appId}/data, where the ID number replaces {appId}.

See the sample code below, where the application ID is 119146:

'Save data' header sample

curl --request POST \
     --url https://api-test.maast.com/platform/application/119146/data \
     --header 'accept: application/json' \
     --header 'authorization: Basic OjllZGVjMjFhMzFjMHh5ejc4OWUzMGEzNDE2YWJjMTIz' \
     --header 'content-type: application/json'

In the body of the request, add a data array. Populate the array with sets of key and value data as described in the subsections below. See 'Save Data' Request Conventions for field definitions.

Organization Information

Use the key and value sets in the following sample code to provide basic information on the organization:

Organization information sample

{
  "data": [
    {
      "key": "legal_name",
      "value": "XYZ Test Business"
    },
    {
      "key": "business_name",
      "value": "CompanyXYZ"
    },
    {
      "key": "business_websites",
      "value": "https://www.domain.com/"
    },
    {
      "key": "business_email",
      "value": "[email protected]"
    },
    {
      "key": "business_phone",
      "value": "9999999999"
    },
    {
      "key": "business_address",
      "value": {"firm_name": "Test Business Address", "address1": "123 Main St", "address2": "", "city": "San Mateo", "state": "CA", "zip": "94402", "zip4": "1234", "country": "840", "attempted": true, "validated": true}
    },
    {
      "key": "business_type",
      "value": "llc"
    },
    {
      "key": "limited_partnership",
      "value": "false"
    },
    {
      "key": "trading_status",
      "value": "np"
    },
    {
      "key": "tax_id_type",
      "value": "ssn"
    },
    {
      "key": "tax_id",
      "value": "999-99-9999"
    },
    {
      "key": "state_filed",
      "value": "CA"
    }
  ]
}

Business History

Use the key and value sets in the following sample code to provide business history information:

Business history sample

{
  "data": [
    {
      "key": "business_established",
      "value": "2007-01-01"
    },
    {
      "key": "business_mcc",
      "value": "5599"
    },
    {
      "key": "business_description",
      "value": "Selling to ABC and XYZ clients."
    }
  ]
}

Owner / Officer Information

Include an ownership object to add officer information. The business type (business_type) determines what in this object is required, so it is generally easier to use the Maast portal to provide this information or to determine which information to include in this object. See the sample code below:

Owner / officer information sample

{
  "data": [
    {
      "key": "ownership",
      "value": {"interestCount": 1, "owners": [{"name": {"first_name": "John","last_name": "Doe"}, 
      	"personType": {"owner": true,"control": true,"user": true}, "id":"efgbe295c41611edb32402171867ecb2", 
      	"contactType": {"admin": true}, "phone": "9999999999", "email": "[email protected]", 
      	"dob": "1970-01-01", "ssn": "999999999", "passport": "", "passport_expiration_date": "", 
      	"passport_issue_date": "", "dl_number": "999999", "dl_state": "CA", 
      	"dl_expiration_date": "2050-01-01", "dl_issue_date": "2015-01-01", "interestPercent": 0, 
      	"relatedBusinesses": [], "cbExp": "", "legal": false, "legalExp": "", "title": "ceo", 
      	"address": {"firm_name": "", "address1": "123 Main St", "address2": "", "city": "San Mateo", 
      	"state": "CA", "zip": "94538", "zip4": "1234", "country": "840", "attempted": true, 
      	"validated": true}}]
}
    }
  ]
}

About Taking Payments

Use the key and value sets in the following sample code to provide information about the type, quantity, and timing of payments the business takes:

About taking payments sample

{
  "data": [
    {
      "key": "processing_history",
      "value": "true"
    },
    {
      "key": "business_services_process",
      "value": "order"
    },
    {
      "key": "business_services_auth_time",
      "value": "{1,30,30+}"
    },
    {
      "key": "card_brands",
      "value": {"vi":true,"mc":true,"di":false,"am":false,"gp":true}
    },
    {
      "key": "card_volume",
      "value": "90000"
    },
    {
      "key": "ach_volume",
      "value": "5000"
    },
    {
      "key": "total_volume",
      "value": "100000"
    },
    {
      "key": "high_ticket",
      "value": "100"
    }
  ]
}

Fulfillment Information

Use the key and value sets in the following sample code to provide information about how the business fulfills sales orders:

Fulfillment information sample

{
  "data": [
    {
      "key": "fulfillment_provider_flag",
      "value": "business"
    },
    {
      "key": "fulfillment_delivery_method",
      "value": {"digitally":false,"pickup":true,"delivery":false,"Service":true}
    },	
    {
      "key": "delivery_confirmation",
      "value": "true"
    },	
    {
      "key": "fulfillment_name",
      "value": "John Doe Fulfillment Center"
    },
      "key": "fulfillment_contact",
      "value": "Doe Fulfillment Contact"
    },
    {
      "key": "fulfillment_email",
      "value": "[email protected]"
    },
    {
      "key": "fulfillment_phone",
      "value": "9999999999"
    },
    {
      "key": "fulfillment_address",
      "value": {"firm_name": "Test Fulfillment Center", "address1": "123 Main St", "address2": "Unit 1", "city": "San Mateo", "state": "CA", "zip": "94402", "zip4": "1234", "country": "840", "attempted": true, "validated": true}
    },
    {
      "key": "fulfillment_process_flag",
      "value": "true"
    }
  ]
}

Deposit Information

Use the key and value sets in the following sample code to tell us where to deposit money for the business:

Deposit information sample

{
  "data": [
    {
      "key": "bank_routing",
      "value": "301080428"
    },
    {
      "key": "bank_account_number",
      "value": "710130198363"
    }
  ]
}

Example Request

Once configured, the code for your 'Save Data' request will resemble the following sample:

'Save data' request sample code

curl --request POST \
     --url https://api-test.maast.com/platform/application/119193/data \
     --header 'accept: application/json' \
     --header 'authorization: Basic OjhiZjEwNWRiOWNkMTExZWRiOTAzMDYwNGQ3MWFiMDhm' \
     --header 'content-type: application/json' \
     --data '
{
  "data": [
    {
      "key": "legal_name",
      "value": "XYZ Test Business"
    },
    {
      "key": "business_name",
      "value": "CompanyXYZ"
    },
    {
      "key": "business_websites",
      "value": "https://www.domain.com/"
    },
    {
      "key": "business_email",
      "value": "[email protected]"
    },
    {
      "key": "business_phone",
      "value": "9999999999"
    },
    {
      "key": "business_address",
      "value": {"firm_name": "Test Business Address", "address1": "123 Main St", "address2": "", "city": "San Mateo", "state": "CA", "zip": "94402", "zip4": "1234", "country": "840", "attempted": true, "validated": true}
    },
    {
      "key": "business_type",
      "value": "llc"
    },
    {
      "key": "limited_partnership",
      "value": "false"
    },
    {
      "key": "trading_status",
      "value": "np"
    },
    {
      "key": "tax_id_type",
      "value": "ssn"
    },
    {
      "key": "tax_id",
      "value": "999-99-9999"
    },
    {
      "key": "state_filed",
      "value": "CA"
    },
    {
      "key": "business_established",
      "value": "2007-01-01"
    },
    {
      "key": "business_mcc",
      "value": "5599"
    },
    {
      "key": "business_description",
      "value": "Selling to ABC and XYZ clients."
    },
    {
      "key": "ownership",
      "value": {
      	"interestCount": 1, 
        "owners": [
        	{
            "name": {
              "first_name": "John",
              "last_name": "Doe"
            }, 
          "personType": {
          	"owner": true,
            "control": true,
            "user": true
           }, 
           "id":"efgbe295c41611edb32402171867ecb2", 
           "contactType": {
           	"admin": true
           }, 
           "phone": "9999999999", 
           "email": "[email protected]", 
           "dob": "1970-01-01", 
           "ssn": "999999999", 
           "passport": "", "
           passport_expiration_date": "", 
           "passport_issue_date": "", 
           "dl_number": "999999", 
           "dl_state": "CA", 
           "dl_expiration_date": "2050-01-01", 
           "dl_issue_date": "2015-01-01", "
           interestPercent": 0, "
           relatedBusinesses": [], 
           "cbExp": "", 
           "legal": false, 
           "legalExp": "", 
           "title": "ceo", 
           "address": {
           	"firm_name": "", 
            "address1": "123 Main St", 
            "address2": Unit 1"", 
            "city": "San Mateo", 
            "state": "CA", 
            "zip": "94538", 
            "zip4": "1234", 
            "country": "840", 
            "attempted": true, 
            "validated": true
           }
          }
        ]
      }
    },
    {
      "key": "processing_history",
      "value": "true"
    },
    {
      "key": "business_services_process",
      "value": "order"
    },
    {
      "key": "business_services_auth_time",
      "value": "{1,30,30+}"
    },
    {
      "key": "card_brands",
      "value": {"vi":true,"mc":true,"di":false,"am":false,"gp":true}
    },
    {
      "key": "card_volume",
      "value": "90000"
    },
    {
      "key": "ach_volume",
      "value": "5000"
    },
    {
      "key": "total_volume",
      "value": "100000"
    },
    {
      "key": "high_ticket",
      "value": "100"
    },
    {
      "key": "fulfillment_provider_flag",
      "value": "business"
    },
    {
      "key": "fulfillment_delivery_method",
      "value": {"digitally":false,"pickup":true,"delivery":false,"Service":true}
    },	
    {
      "key": "delivery_confirmation",
      "value": "true"
    },	
    {
      "key": "fulfillment_name",
      "value": "John Doe Fulfillment Center"
    },
      "key": "fulfillment_contact",
      "value": "Doe Fulfillment Contact"
    },
    {
      "key": "fulfillment_email",
      "value": "[email protected]"
    },
    {
      "key": "fulfillment_phone",
      "value": "9999999999"
    },
    {
      "key": "fulfillment_address",
      "value": {
      	"firm_name": "Test Fulfillment Center", 
        "address1": "123 Main St", 
        "address2": "Unit 1", 
        "city": "San Mateo", 
        "state": "CA", 
        "zip": "94402", 
        "zip4": "1234", 
        "country": "840", 
        "attempted": true, 
        "validated": true
       }
    },
    {
      "key": "fulfillment_process_flag",
      "value": "true"
    },
    {
      "key": "bank_routing",
      "value": "301080428"
    },
    {
      "key": "bank_account_number",
      "value": "710130198363"
    }
  ]
}
'

Integrate

Send your request. You will receive a response like this from the Maast server:

'Save Data' success response sample

{
  "code" : 0,
  "message" : "Success",
  "data" : {
    "fields" : [ {
      "key" : "state_filed",
      "value" : "CA",
      "type" : "us_state",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "fulfillment_provider_flag",
      "value" : "business",
      "type" : "radio",
      "settings" : {
        "options" : [ {
          "label" : "My Business",
          "value" : "business"
        }, {
          "label" : "Third Party",
          "value" : "thirdparty"
        } ],
        "required" : true
      }
    }, {
      "key" : "total_volume",
      "value" : "100000",
      "type" : "currency",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "bank_account_number",
      "value" : "710130198363",
      "type" : "bank_dda",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "fulfillment_delivery_method",
      "value" : {
        "digitally" : false,
        "pickup" : true,
        "delivery" : false,
        "Service" : true
      },
      "type" : "checkbox_row",
      "settings" : {
        "required" : true,
        "options" : [ {
          "label" : "Digitally",
          "value" : "digitally"
        }, {
          "label" : "Pick-up",
          "value" : "pickup"
        }, {
          "label" : "Delivery",
          "value" : "delivery"
        }, {
          "label" : "Service",
          "value" : "Service"
        } ]
      }
    }, {
      "key" : "business_address",
      "value" : {
        "firm_name" : "Test Business Address",
        "address1" : "123 Main St",
        "address2" : "",
        "city" : "San Mateo",
        "state" : "CA",
        "zip" : "94402",
        "zip4" : "1234",
        "country" : "840",
        "attempted" : true,
        "validated" : true
      },
      "type" : "address_suggest",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "processing_history",
      "value" : "true",
      "type" : "toggle",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "card_brands",
      "value" : {
        "vi" : true,
        "mc" : true,
        "di" : false,
        "am" : false,
        "gp" : true
      },
      "type" : "checkbox_row",
      "settings" : {
        "required" : true,
        "options" : [ {
          "label" : "<span class=\"fa-stack fa-1x\"><i class=\"fa fa-cc-visa fa-stack-2x\"></i></span>",
          "value" : "vi",
          "disabled" : false
        }, {
          "label" : "<span class=\"fa-stack fa-1x\\\"><i class=\"fa fa-cc-mastercard fa-stack-2x\"></i></span>",
          "value" : "mc",
          "disabled" : false
        }, {
          "label" : "<span class=\"fa-stack fa-1x\"><i class=\"fa fa-cc-discover fa-stack-2x\"></i></span>",
          "value" : "di",
          "disabled" : true
        }, {
          "label" : "<span class=\"fa-stack fa-1x\"><i class=\"fa fa-cc-amex fa-stack-2x\"></i></span>",
          "value" : "am",
          "disabled" : false
        }, {
          "label" : "<span class=\"fa-stack fa-1x\"><i class=\"fab fa-google-pay fa-stack-2x\"></i></span>",
          "value" : "gp"
        } ]
      }
    }, {
      "key" : "trading_status",
      "value" : "np",
      "type" : "radio",
      "settings" : {
        "options" : [ {
          "label" : "Publicly Traded",
          "value" : "pt"
        }, {
          "label" : "Non-Public",
          "value" : "np"
        } ],
        "required" : true
      }
    }, {
      "key" : "fulfillment_name",
      "value" : "John Doe Fulfillment Center",
      "type" : "text",
      "settings" : {
        "required" : false
      }
    }, {
      "key" : "business_services_process",
      "value" : "order",
      "type" : "radio",
      "settings" : {
        "options" : [ {
          "label" : "At Time of Order",
          "value" : "order"
        }, {
          "label" : "At Fulfillment",
          "value" : "fulfill"
        } ],
        "required" : true
      }
    }, {
      "key" : "fulfillment_phone",
      "value" : "9999999999",
      "type" : "phone",
      "settings" : {
        "required" : false
      }
    }, {
      "key" : "fulfillment_address",
      "value" : {
        "firm_name" : "Test Fulfillment Address",
        "address1" : "123 Main St",
        "address2" : "",
        "city" : "San Mateo",
        "state" : "CA",
        "zip" : "94402",
        "zip4" : "1234",
        "country" : "840",
        "attempted" : true,
        "validated" : true
      },
      "type" : "address_suggest",
      "settings" : {
        "required" : false
      }
    }, {
      "key" : "delivery_confirmation",
      "value" : "true",
      "type" : "toggle",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "fulfillment_email",
      "value" : "[email protected]",
      "type" : "email",
      "settings" : {
        "required" : false
      }
    }, {
      "key" : "limited_partnership",
      "value" : "false",
      "type" : "toggle",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "business_phone",
      "value" : "9999999999",
      "type" : "phone",
      "settings" : {
        "required" : false
      }
    }, {
      "key" : "business_services_auth_time",
      "value" : "{1,30,30+}",
      "type" : "checkbox_group",
      "settings" : {
        "options" : [ {
          "label" : "0 - 1 Days",
          "value" : "1"
        }, {
          "label" : "2 - 29 Days",
          "value" : "30"
        }, {
          "label" : "30 - 89 Days",
          "value" : "30+"
        }, {
          "label" : "90 + days",
          "value" : "90+"
        } ],
        "required" : true
      }
    }, {
      "key" : "tax_id_type",
      "value" : "ssn",
      "type" : "select",
      "settings" : {
        "options" : [ {
          "label" : "Employer Identification Number (EIN)",
          "value" : "ein"
        }, {
          "label" : "Social Security Number (SSN)",
          "value" : "ssn"
        } ],
        "required" : true
      }
    }, {
      "key" : "business_type",
      "value" : "llc",
      "type" : "select",
      "settings" : {
        "options" : [ {
          "label" : "Sole Proprietorship",
          "value" : "sole-prop"
        }, {
          "label" : "Limited Liability Company",
          "value" : "llc"
        }, {
          "label" : "Public Corporation",
          "value" : "corporation-public"
        }, {
          "label" : "Private Corporation",
          "value" : "corporation-private"
        }, {
          "label" : "Partnership",
          "value" : "partnership"
        }, {
          "label" : "Non-Profit",
          "value" : "tax-exempt"
        } ],
        "required" : true
      }
    }, {
      "key" : "business_description",
      "value" : "Selling to ABC and XYZ clients.",
      "type" : "text",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "legal_name",
      "value" : "XYZ Test Business",
      "type" : "text",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "fulfillment_contact",
      "value" : "Doe Fulfillment Contact",
      "type" : "name",
      "settings" : {
        "required" : false
      }
    }, {
      "key" : "business_name",
      "value" : "CompanyXYZ",
      "type" : "text",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "business_mcc",
      "value" : "5599",
      "type" : "mcc",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "card_volume",
      "value" : "90000",
      "type" : "currency",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "business_websites",
      "value" : "https://www.domain.com/",
      "type" : "url_list",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "high_ticket",
      "value" : "100",
      "type" : "currency",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "ach_volume",
      "value" : "5000",
      "type" : "currency",
      "settings" : {
        "required" : false
      }
    }, {
      "key" : "tax_id",
      "value" : "999-99-9999",
      "type" : "tax_id",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "ownership",
      "value" : {
        "interestCount" : 1,
        "owners" : [ {
          "name" : {
            "first_name" : "John",
            "last_name" : "Doe"
          },
          "personType" : {
            "owner" : true,
            "control" : true,
            "user" : true
          },
          "id" : "efgbe295c41611edb32402171867ecb2",
          "contactType" : {
            "admin" : true
          },
          "phone" : "9999999999",
          "email" : "[email protected]",
          "dob" : "1970-01-01",
          "ssn" : "999999999",
          "passport" : "",
          "passport_expiration_date" : "",
          "passport_issue_date" : "",
          "dl_number" : "999999",
          "dl_state" : "CA",
          "dl_expiration_date" : "2050-01-01",
          "dl_issue_date" : "2015-01-01",
          "interestPercent" : 0,
          "relatedBusinesses" : [ ],
          "cbExp" : "",
          "legal" : false,
          "legalExp" : "",
          "title" : "ceo",
          "address" : {
            "firm_name" : "",
            "address1" : "123 Main St",
            "address2" : "",
            "city" : "San Mateo",
            "state" : "CA",
            "zip" : "94538",
            "zip4" : "1234",
            "country" : "840",
            "attempted" : true,
            "validated" : true
          }
        } ]
      },
      "type" : "ownership",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "fulfillment_process_flag",
      "value" : "true",
      "type" : "toggle",
      "settings" : {
        "required" : false
      }
    }, {
      "key" : "business_email",
      "value" : "[email protected]",
      "type" : "email",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "bank_routing",
      "value" : "301080428",
      "type" : "bank_routing",
      "settings" : {
        "required" : true
      }
    }, {
      "key" : "business_established",
      "value" : "2007-01-01",
      "type" : "date",
      "settings" : {
        "required" : true
      }
    } ]
  }
}

Check the code field in the request response: 0 confirms that you have successfully saved data to the application. If the value is something other than 0, check Platform API Response Codes in Reference. See Application Boarding Conventions in Reference and Save Data in our API Reference for field definitions.

Test and Go Live

See our Test and Go Live guide to test your API integration and to start transacting with an active production account.