POST Customer

Request Information

URI Parameters

None.

Body Parameters

CustomerRequest
Name Description Type Additional information
client_ip

string

None.

Customer

CustomerData

None.

card

CardData

None.

check

CheckData

None.

custom_fields

Collection of CustomFieldsData

None.

additional_data

Collection of AdditionalData

None.

Request Formats

application/json, text/json

Sample:
{
  "client_ip": "sample string 1",
  "Customer": {
    "first_name": "sample string 1",
    "last_name": "sample string 2",
    "street_1": "sample string 3",
    "street_2": "sample string 4",
    "city": "sample string 5",
    "state": "sample string 6",
    "zip": "sample string 7",
    "country": "sample string 8",
    "phone_number": "sample string 9",
    "company": "sample string 10",
    "customer_id": "sample string 11",
    "email": "sample string 12",
    "email_receipt": "sample string 13",
    "notes": "sample string 14",
    "action_code": "sample string 15",
    "custom_fields": [
      {
        "id": "sample string 1",
        "value": "sample string 2",
        "UDFNumber": "sample string 3"
      },
      {
        "id": "sample string 1",
        "value": "sample string 2",
        "UDFNumber": "sample string 3"
      }
    ],
    "sms_receipt": 16
  },
  "card": {
    "number": "sample string 1",
    "code": "sample string 2",
    "expiration_date": "sample string 3",
    "track_data": "sample string 4",
    "action_code": "sample string 5",
    "token": "sample string 6",
    "ksn": "sample string 7",
    "pin_block": "sample string 8",
    "auth_code": "sample string 9",
    "voucher_number": "sample string 10",
    "entry_mode": "sample string 11",
    "pin_ksn": "sample string 12",
    "payment_token": "sample string 13",
    "merchant_terminal_id": "sample string 14",
    "googlepay_token": "sample string 15",
    "applepay_token": "sample string 16",
    "card_network": "sample string 17"
  },
  "check": {
    "aba_code": "sample string 1",
    "account_number": "sample string 2",
    "account_type": "sample string 3",
    "bank_name": "sample string 4",
    "check_number": "sample string 5",
    "sec_code": "sample string 6",
    "action_code": "sample string 7",
    "token": "sample string 8",
    "payment_token": "sample string 9"
  },
  "custom_fields": [
    {
      "id": "sample string 1",
      "value": "sample string 2",
      "UDFNumber": "sample string 3"
    },
    {
      "id": "sample string 1",
      "value": "sample string 2",
      "UDFNumber": "sample string 3"
    }
  ],
  "additional_data": [
    {
      "id": "sample string 1",
      "value": "sample string 2"
    },
    {
      "id": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<CustomerRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <client_ip>sample string 1</client_ip>
  <Customer>
    <first_name>sample string 1</first_name>
    <last_name>sample string 2</last_name>
    <street_1>sample string 3</street_1>
    <street_2>sample string 4</street_2>
    <city>sample string 5</city>
    <state>sample string 6</state>
    <zip>sample string 7</zip>
    <country>sample string 8</country>
    <phone_number>sample string 9</phone_number>
    <company>sample string 10</company>
    <customer_id>sample string 11</customer_id>
    <email>sample string 12</email>
    <email_receipt>sample string 13</email_receipt>
    <notes>sample string 14</notes>
    <action_code>sample string 15</action_code>
    <custom_fields>
      <CustomFieldsData>
        <id>sample string 1</id>
        <value>sample string 2</value>
        <UDFNumber>sample string 3</UDFNumber>
      </CustomFieldsData>
      <CustomFieldsData>
        <id>sample string 1</id>
        <value>sample string 2</value>
        <UDFNumber>sample string 3</UDFNumber>
      </CustomFieldsData>
    </custom_fields>
    <sms_receipt>16</sms_receipt>
  </Customer>
  <card>
    <number>sample string 1</number>
    <code>sample string 2</code>
    <expiration_date>sample string 3</expiration_date>
    <track_data>sample string 4</track_data>
    <action_code>sample string 5</action_code>
    <token>sample string 6</token>
    <ksn>sample string 7</ksn>
    <pin_block>sample string 8</pin_block>
    <auth_code>sample string 9</auth_code>
    <voucher_number>sample string 10</voucher_number>
    <entry_mode>sample string 11</entry_mode>
    <pin_ksn>sample string 12</pin_ksn>
    <payment_token>sample string 13</payment_token>
    <merchant_terminal_id>sample string 14</merchant_terminal_id>
    <googlepay_token>sample string 15</googlepay_token>
    <applepay_token>sample string 16</applepay_token>
    <card_network>sample string 17</card_network>
  </card>
  <check>
    <aba_code>sample string 1</aba_code>
    <account_number>sample string 2</account_number>
    <account_type>sample string 3</account_type>
    <bank_name>sample string 4</bank_name>
    <check_number>sample string 5</check_number>
    <sec_code>sample string 6</sec_code>
    <action_code>sample string 7</action_code>
    <token>sample string 8</token>
    <payment_token>sample string 9</payment_token>
  </check>
  <custom_fields>
    <CustomFieldsData>
      <id>sample string 1</id>
      <value>sample string 2</value>
      <UDFNumber>sample string 3</UDFNumber>
    </CustomFieldsData>
    <CustomFieldsData>
      <id>sample string 1</id>
      <value>sample string 2</value>
      <UDFNumber>sample string 3</UDFNumber>
    </CustomFieldsData>
  </custom_fields>
  <additional_data>
    <AdditionalData>
      <id>sample string 1</id>
      <value>sample string 2</value>
    </AdditionalData>
    <AdditionalData>
      <id>sample string 1</id>
      <value>sample string 2</value>
    </AdditionalData>
  </additional_data>
</CustomerRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
Name Description Type Additional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.