Customer Management

Add Customers

Add Customers

This request creates a new customer with the details entered and saves it to the customer database.

Add New Customer with all fields

Example Request:

{
    "customer":
     {
        "first_name": "Oscar",
        "last_name": "Brady",
        "street_1": "55",
        "street_2": "Airport Drive",
        "city": "Pensacola",
        "state": "FL",
        "zip": "32503",
        "country": "US",
        "phone_number": "2025550197",
        "company": "Ferry Group",
        "customer_id": "cust008",
        "email": "oscar@brady.com",
        "email_receipt": "YES",
        "notes": "Sample Test ",
    },
   "check":
   {  
      "aba_code":"056008849",
      "account_number":"3453543455",
      "account_type":"Savings",
      "bank_name":"ABC Bank",
      "check_number":"1234567890",
      "sec_code":"PPD",
   }
   
}

Example Response:

{
  "customer_response": {
    "result_code": 1,
    "result_text": "Customer Record Added",
    "result_sub_code": "2000",
    "transaction_datetime": "20200921T103006Z",
    "token": "cc8e553e59404e5f890cfad3c9647f2a",
    "account_type": "Savings",
    "account_last_4": "3455",
    "expiration_date": ""
  },
  "customer": {
    "first_name": "Oscar",
    "last_name": "Brady",
    "street_1": "55",
    "street_2": "Airport Drive",
    "city": "Pensacola",
    "state": "FL",
    "zip": "32503",
    "country": "US",
    "phone_number": "2025550197",
    "company": "Ferry Group",
    "customer_id": "cust008",
    "email": "oscar@brady.com",
    "email_receipt": "YES",
    "notes": "Sample Test ",
    "action_code": "1"
  }
}

Add New Customer with required fields

Example Request:

{
    "customer": {
     "customer_id": "cust009",
     "action_code": "1"
    },
    "card": {
     "number": "4424900930713822",
     "expiration_date": "0822",
     "type": "MC"
    }
}

Example Response:

{
  "customer_response": {
    "result_code": 1,
    "result_text": "Customer Record Added",
    "result_sub_code": "2000",
    "transaction_datetime": "20200921T103140Z",
    "token": "b65e788783424c32b487ed4a7fd3ab55",
    "account_type": "VI",
    "account_last_4": "3822",
    "expiration_date": "0822"
  },
  "customer": {
    "first_name": "",
    "last_name": "",
    "street_1": "",
    "street_2": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "phone_number": "",
    "company": "",
    "customer_id": "cust009",
    "email": "",
    "email_receipt": "",
    "notes": "",
    "action_code": "1"
  }
}

Add New Customer with Customer ID Autogenerated

Example Request:

{
    "customer": {
     "customer_id": "AUTO",
     "action_code": "1"
    },
    "card": {
        "number": "4424900930713822",
        "expiration_date": "0822",
        "type": "MC"
    }
}

Example Response:

{
  "customer_response": {
    "result_code": 1,
    "result_text": "Customer Record Added",
    "result_sub_code": "2000",
    "transaction_datetime": "20200921T103328Z",
    "token": "61c714a0e0764bc5a03be0dc4de17297",
    "account_type": "VI",
    "account_last_4": "5541",
    "expiration_date": "0822"
  },
  "customer": {
    "first_name": "",
    "last_name": "",
    "street_1": "",
    "street_2": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "phone_number": "",
    "company": "",
    "customer_id": "1000287",
    "email": "",
    "email_receipt": "",
    "notes": "",
    "action_code": "1"
  }
}

Add New Customer with Customer ID User Generated

Example Request:

{
    "customer": {
    "customer_id": "cust5566",
     "action_code": "1"
    },
    "card": {
        "number": "4424900930713822",
        "expiration_date": "0822",
        "type": "MC"
    }
}

Example Response:

{
  "customer_response": {
    "result_code": 1,
    "result_text": "Customer Record Added",
    "result_sub_code": "2000",
    "transaction_datetime": "20200921T103509Z",
    "token": "b65e788783424c32b487ed4a7fd3ab55",
    "account_type": "VI",
    "account_last_4": "3822",
    "expiration_date": "0822"
  },
  "customer": {
    "first_name": "",
    "last_name": "",
    "street_1": "",
    "street_2": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "phone_number": "",
    "company": "",
    "customer_id": "cust5566",
    "email": "",
    "email_receipt": "",
    "notes": "",
    "action_code": "1"
  }
}

Add Customer with Custom Fields

Example Request:

{
    "customer": {
        "customer_id": "AUTO",
        "action_code": "1"
    },
    "card": {
        "number": "4111111111111111",
        "expiration_date": "1229",
        "type": "VI"
    },
     "custom_fields": [
        {
            "UDFNumber": "1",
            "id": "1",
            "value": "TC001"
        },
        {
            "UDFNumber": "2",
            "id": "2",
            "value": "TC002"
        }
    ]
}

Example Response:

{
  "customer_response": {
    "result_code": 1,
    "result_text": "Customer Record Added",
    "result_sub_code": "2000",
    "transaction_datetime": "20200921T103557Z",
    "token": "2742756405581111",
    "account_type": "VI",
    "account_last_4": "1111",
    "expiration_date": "1229"
  },
  "customer": {
    "first_name": "",
    "last_name": "",
    "street_1": "",
    "street_2": "",
    "city": "",
    "state": "",
    "zip": "",
    "country": "",
    "phone_number": "",
    "company": "",
    "customer_id": "1000288",
    "email": "",
    "email_receipt": "",
    "notes": "",
    "action_code": "1"
  },
  "custom_fields": [
    {
      "id": "1",
      "value": "TC001",
      "UDFNumber": "1"
    },
    {
      "id": "2",
      "value": "TC002",
      "UDFNumber": "2"
    }
  ]
}