{"_id":"5632a5ea49e16d0d0012248d","category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"user":"55b932ba8fd1a02b00f496c8","__v":0,"githubsync":"","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"project":"55b933b3146ef121002158d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:53:06.278Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"Contains customer data.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object contains all relevant customer data including the CustNum (a unique customer number assigned by the gateway), CustID (a merchant assigned customer ID), as well as customer name, address, recurring billing status and schedule, and any other relevant data.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"string\",\n    \"0-1\": \"CustNum\",\n    \"0-2\": \"Customer Number (System assigned)\",\n    \"1-0\": \"string\",\n    \"1-1\": \"CustomerID\",\n    \"1-2\": \"Customer ID (Merchant assigned)\",\n    \"2-0\": \"[Address](/docs/address)\",\n    \"2-1\": \"BillingAddress\",\n    \"2-2\": \"Customer Address information. (Uses Address object.)\",\n    \"3-0\": \"[PaymentMethod](/docs/paymentmethod)\",\n    \"3-1\": \"PaymentMethods\",\n    \"3-2\": \"Array of PaymentMethod objects. Multiple credit cards or ACH accounts may be stored for each customer.\",\n    \"4-0\": \"string\",\n    \"4-1\": \"Notes\",\n    \"4-2\": \"Notes (visible to merchant only).\",\n    \"5-0\": \"string\",\n    \"5-1\": \"CustomData\",\n    \"5-2\": \"Custom data is a raw text field, please serialize and encode (ie: base64) your data so that complex types are stored and retrieved correctly.\",\n    \"6-0\": \"[FieldValue](/docs/fieldvalue)\",\n    \"6-1\": \"CustomFields\",\n    \"6-2\": \"Array of field values containing the merchant defined customer fields. These fields are defined in the merchant console.\",\n    \"7-0\": \"string\",\n    \"7-1\": \"URL\",\n    \"7-2\": \"URL for customers website\",\n    \"8-0\": \"datetime\",\n    \"8-1\": \"Created\",\n    \"8-2\": \"Date/Time customer was created (Read Only)\",\n    \"9-0\": \"datetime\",\n    \"9-1\": \"Modified\",\n    \"9-2\": \"Date/Time customer was last changed (Read Only)\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Recurring Billing\",\n    \"h-1\": \"Recurring Billing\",\n    \"h-2\": \"Recurring Billing\",\n    \"0-0\": \"boolean\",\n    \"0-1\": \"Enabled\",\n    \"0-2\": \"Notes whether or not a customer has been enabled for a recurring billing cycle. The customer billing does not need to be enabled to run one time transactions via the [runCustomcuerTransaction](/docs/runcustomertransaction) method.\",\n    \"1-0\": \"string\",\n    \"1-1\": \"Schedule\",\n    \"1-2\": \"Recurring billing schedule, if any. Possible values include: daily, weekly, bi-weekly (every two weeks), monthly, bi-monthly (every two months), quarterly, bi-annually (every six months), annually, first of month, last day of month.\",\n    \"2-0\": \"integer\",\n    \"2-1\": \"NumLeft\",\n    \"2-2\": \"Number of transactions remaining in customer's recurring billing cycle. ”-1” indicates unlimited transactions.\",\n    \"3-0\": \"string\",\n    \"3-1\": \"Next\",\n    \"3-2\": \"Date of customer's next scheduled transaction.\",\n    \"4-0\": \"double\",\n    \"4-1\": \"Amount\",\n    \"4-2\": \"Total Amount to be billed in recurring billing cycle.\",\n    \"5-0\": \"double\",\n    \"5-1\": \"Tax\",\n    \"5-2\": \"Portion of “Amount” that is Tax\",\n    \"6-0\": \"string\",\n    \"6-1\": \"Currency\",\n    \"6-2\": \"Numeric currency code for Amount. (Only needed if multicurrency merchant account)\",\n    \"7-0\": \"string\",\n    \"7-1\": \"Description\",\n    \"7-2\": \"Description of transaction.\",\n    \"8-0\": \"string\",\n    \"8-1\": \"OrderID\",\n    \"8-2\": \"Transaction Order ID\",\n    \"9-0\": \"string\",\n    \"9-1\": \"User\",\n    \"9-2\": \"Merchant username assigned to billing.\",\n    \"10-0\": \"string\",\n    \"10-1\": \"Source\",\n    \"10-2\": \"Name of source key assigned to billing.\",\n    \"11-0\": \"boolean\",\n    \"11-1\": \"SendReceipt\",\n    \"11-2\": \"Send client a receipt.\",\n    \"12-0\": \"string\",\n    \"12-1\": \"ReceiptNote\",\n    \"12-2\": \"Note to send on receipt.\",\n    \"13-0\": \"int\",\n    \"13-1\": \"Failures\",\n    \"13-2\": \"Number of failures since last approval.\"\n  },\n  \"cols\": 3,\n  \"rows\": 14\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Point of Sale\",\n    \"h-1\": \"Point of Sale\",\n    \"h-2\": \"Point of Sale\",\n    \"0-0\": \"string\",\n    \"0-1\": \"PriceTier\",\n    \"0-2\": \"Name of customer price tier\",\n    \"1-0\": \"string\",\n    \"1-1\": \"TaxClass\",\n    \"1-2\": \"Tax Class (Group)\",\n    \"2-0\": \"string\",\n    \"2-1\": \"LookupCode\",\n    \"2-2\": \"Lookup code from customer/member id card. Either barcode or Magnetic stripe. Can be assigned by merchants. Defaults to system assigned if left blank.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n// for directions on how to set up the  \\n// WSDL link and create \\\"$token\\\" and \\\"$client,\\\"\\n// see: http://wiki.eBizCharge.com/developer/soap/howto/php\\n$CustomerObject=array(\\n       'BillingAddress'=>array(\\n               'FirstName'=>'John',\\n               'LastName'=>'Doe',\\n               'Company'=>'Acme Corp',\\n               'Street'=>'1234 main st',\\n               'Street2'=>'Suite #123',\\n               'City'=>'Los Angeles',\\n               'State'=>'CA',\\n               'Zip'=>'12345',\\n               'Country'=>'US',\\n               'Email'=>'support:::at:::eBizCharge.com',\\n               'Phone'=>'333-333-3333',\\n               'Fax'=>'333-333-3334'\\n               ),\\n       'PaymentMethods' =>\\n               array(\\n                       array(\\n                               'CreditCardData' =>\\n                                       array(\\n                                       'CardNumber'=>'4444555566667779',\\n                                       'CardExpiration'=>'0908',\\n                                       'CardType'=>'',\\n                                       'CardCode'=>'',\\n                                       'AvsStreet'=>'',\\n                                       'AvsZip'=>'',                                        \\n                                       'CardPresent'=>'',\\n                                       'MagStripe'=>'',\\n                                       'TermType'=>'',\\n                                       'MagSupport'=>'',\\n                                       'XID'=>'',\\n                                       'CAVV'=>'',\\n                                       'ECI'=>'',\\n                                       'InternalCardAuth'=>'',\\n                                       'Pares'=>''\\n                                       ),\\n                       \\\"Expires\\\"=>\\\"\\\",\\n                       \\\"MethodName\\\"=>\\\"My Visa\\\",\\n                       \\\"SecondarySort\\\"=>1                                                        \\n                       )\\n               ),\\n       'CustomData'=>base64_encode(serialize(array(\\\"mydata\\\"=>\\\"We could put anything in here!\\\"))),\\n       'CustomFields'=>array(\\n               array('Field'=>'Foo', 'Value'=>'Testing'),\\n               array('Field'=>'Bar', 'Value'=>'Tested')\\n               ),\\n       'CustomerID'=>123123 + rand(),\\n       'Description'=>'Weekly Bill',\\n       'Enabled'=>false,\\n       'Amount'=>'44.93',\\n       'Tax'=>'0',\\n       'Next'=>'2012-01-21',\\n       'Notes'=>'Testing the soap addCustomer Function',\\n       'NumLeft'=>'50',\\n       'OrderID'=>rand(),\\n       'ReceiptNote'=>'addCustomer test Created Charge',\\n       'Schedule'=>'weekly',\\n       'SendReceipt'=>true,\\n       'Source'=>'Recurring',\\n       'CustNum'=>'C'.rand()\\n       );\\n$CustomerNumber=$this->client->addCustomer($this->token,$CustomerObject);\\n$CustomerObject= $this->client->getCustomer($this->token, $CustomerNumber);\\necho $CustomerObject->CustNum;\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim customer As eBizCharge.CustomerObject = New eBizCharge.CustomerObject\\n       Dim address As eBizCharge.Address = New eBizCharge.Address\\n       address.FirstName = \\\"John\\\"\\n       address.LastName = \\\"Doe\\\"\\n       address.Company = \\\"Acme\\\"\\n       address.Street = \\\"123 main st.\\\"\\n       address.City = \\\"Hollywood\\\"\\n       address.State = \\\"ca\\\"\\n       address.Zip = \\\"91607\\\"\\n       address.Country = \\\"USA\\\"\\n       customer.BillingAddress = address\\n       customer.Enabled = True\\n       customer.Amount = 5.0\\n       customer.Next = \\\"2010-08-15\\\"\\n       customer.Schedule = \\\"monthly\\\"\\n       Dim payMethod(0) As eBizCharge.PaymentMethod\\n       payMethod(0) = New eBizCharge.PaymentMethod\\n       payMethod(0).CardExpiration = \\\"1212\\\"\\n       payMethod(0).CardNumber = \\\"4444555566667779\\\"\\n       payMethod(0).AvsStreet = \\\"123 Main st.\\\"\\n       payMethod(0).AvsZip = \\\"90046\\\"\\n       payMethod(0).MethodName = \\\"My Visa\\\"\\n       customer.PaymentMethods = payMethod\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.CustomerObject customer = new eBizCharge.CustomerObject();\\n           eBizCharge.Address address = new eBizCharge.Address();\\n           address.FirstName = \\\"John\\\";\\n           address.LastName = \\\"Doe\\\";\\n           address.Company = \\\"Acme\\\";\\n           address.Street = \\\"123 main st.\\\";\\n           address.City = \\\"Hollywood\\\";\\n           address.State = \\\"ca\\\";\\n           address.Zip = \\\"91607\\\";\\n           address.Country = \\\"USA\\\";\\n           customer.BillingAddress = address;\\n           customer.Enabled = true;\\n           customer.Amount = 5.00;\\n           customer.Next = \\\"2010-08-15\\\";\\n           customer.Schedule = \\\"monthly\\\";\\n           eBizCharge.PaymentMethod[] payMethod = new eBizCharge.PaymentMethod[1];\\n           payMethod[0] = new eBizCharge.PaymentMethod();\\n           payMethod[0].CardExpiration = \\\"1212\\\";\\n           payMethod[0].CardNumber = \\\"4444555566667779\\\";\\n           payMethod[0].AvsStreet = \\\"123 Main st.\\\";\\n           payMethod[0].AvsZip = \\\"90046\\\";\\n           payMethod[0].MethodName = \\\"My Visa\\\";\\n           customer.PaymentMethods = payMethod;\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<getCustomerReturn xsi:type=\\\"ns1:CustomerObject\\\">\\n<Amount xsi:type=\\\"xsd:double\\\">1.00</Amount>\\n<BillingAddress xsi:type=\\\"ns1:Address\\\">\\n<City xsi:type=\\\"xsd:string\\\">Los Angeles</City>\\n<Company xsi:type=\\\"xsd:string\\\">eBizCharge</Company>\\n<Country xsi:type=\\\"xsd:string\\\">US</Country>\\n<Email xsi:type=\\\"xsd:string\\\">support@eBizCharge.com</Email>\\n<Fax xsi:type=\\\"xsd:string\\\">333-333-3334</Fax>\\n<FirstName xsi:type=\\\"xsd:string\\\">Example</FirstName>\\n<LastName xsi:type=\\\"xsd:string\\\">Generator</LastName>\\n<Phone xsi:type=\\\"xsd:string\\\">333-333-3333</Phone>\\n<State xsi:type=\\\"xsd:string\\\">CA</State>\\n<Street xsi:type=\\\"xsd:string\\\">1234 main st</Street>\\n<Street2 xsi:type=\\\"xsd:string\\\">Suite #123</Street2>\\n<Zip xsi:type=\\\"xsd:string\\\">12345</Zip>\\n</BillingAddress>\\n<CustNum xsi:type=\\\"xsd:string\\\">21727</CustNum>\\n<CustomData xsi:type=\\\"xsd:string\\\">\\n</CustomData>\\n<CustomFields SOAP-ENC:arrayType=\\\"ns1:FieldValue[2]\\\" xsi:type=\\\"ns1:FieldValueArray\\\">\\n<item xsi:type=\\\"ns1:FieldValue\\\">\\n <Field xsi:type=\\\"xsd:string\\\">Example</Field>\\n <Value xsi:type=\\\"xsd:string\\\">Field</Value>\\n</item>\\n</CustomFields>\\n<CustomerID xsi:type=\\\"xsd:string\\\">156244967</CustomerID>\\n<Created xsi:type=\\\"xsd:string\\\">2008-05-08 13:40:35</Created>\\n<Description xsi:type=\\\"xsd:string\\\">Weekly Bill</Description>\\n<Enabled xsi:type=\\\"xsd:boolean\\\">false</Enabled>\\n<Modified xsi:type=\\\"xsd:string\\\">2008-05-08 13:40:35</Modified>\\n<Next xsi:type=\\\"xsd:string\\\">2012-01-21T12:00:00</Next>\\n<Notes xsi:type=\\\"xsd:string\\\">Any notes go here</Notes>\\n<NumLeft xsi:type=\\\"xsd:integer\\\">50</NumLeft>\\n<OrderID xsi:type=\\\"xsd:string\\\">1707022452</OrderID>\\n<PaymentMethods SOAP-ENC:arrayType=\\\"ns1:PaymentMethod[1]\\\" xsi:type=\\\"ns1:PaymentMethodArray\\\">\\n<item xsi:type=\\\"ns1:PaymentMethod\\\">\\n <CheckData xsi:type=\\\"ns1:CheckData\\\">\\n  <Account xsi:nil=\\\"true\\\"/>\\n  <Routing xsi:nil=\\\"true\\\"/>\\n </CheckData>\\n <CreditCardData xsi:type=\\\"ns1:CreditCardData\\\">\\n  <AvsStreet xsi:type=\\\"xsd:string\\\">1234 main st</AvsStreet>\\n  <AvsZip xsi:type=\\\"xsd:string\\\">12345</AvsZip>\\n  <CardExpiration xsi:type=\\\"xsd:string\\\">XXXX</CardExpiration>\\n  <CardNumber xsi:type=\\\"xsd:string\\\">XXXXXXXXXXXX7779</CardNumber>\\n  <CardType xsi:type=\\\"xsd:string\\\">V</CardType>\\n </CreditCardData>\\n <Expires xsi:type=\\\"xsd:string\\\">2008-05-08</Expires>\\n <MethodID xsi:type=\\\"xsd:integer\\\">7353</MethodID>\\n <MethodName xsi:type=\\\"xsd:string\\\">My Visa</MethodName>\\n <SecondarySort xsi:type=\\\"xsd:integer\\\">1</SecondarySort>\\n</item>\\n</PaymentMethods>\\n<ReceiptNote xsi:type=\\\"xsd:string\\\">Example Receipt Note</ReceiptNote>\\n<Schedule xsi:type=\\\"xsd:string\\\">Weekly</Schedule>\\n<SendReceipt xsi:type=\\\"xsd:boolean\\\">true</SendReceipt>\\n<Source xsi:type=\\\"xsd:string\\\">Recurring</Source>\\n<Tax xsi:type=\\\"xsd:double\\\">0</Tax>\\n<User xsi:type=\\\"xsd:string\\\">(Auto)</User>\\n</getCustomerReturn>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"customerobject","type":"basic","title":"CustomerObject"}
Contains customer data. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object contains all relevant customer data including the CustNum (a unique customer number assigned by the gateway), CustID (a merchant assigned customer ID), as well as customer name, address, recurring billing status and schedule, and any other relevant data. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "string", "0-1": "CustNum", "0-2": "Customer Number (System assigned)", "1-0": "string", "1-1": "CustomerID", "1-2": "Customer ID (Merchant assigned)", "2-0": "[Address](/docs/address)", "2-1": "BillingAddress", "2-2": "Customer Address information. (Uses Address object.)", "3-0": "[PaymentMethod](/docs/paymentmethod)", "3-1": "PaymentMethods", "3-2": "Array of PaymentMethod objects. Multiple credit cards or ACH accounts may be stored for each customer.", "4-0": "string", "4-1": "Notes", "4-2": "Notes (visible to merchant only).", "5-0": "string", "5-1": "CustomData", "5-2": "Custom data is a raw text field, please serialize and encode (ie: base64) your data so that complex types are stored and retrieved correctly.", "6-0": "[FieldValue](/docs/fieldvalue)", "6-1": "CustomFields", "6-2": "Array of field values containing the merchant defined customer fields. These fields are defined in the merchant console.", "7-0": "string", "7-1": "URL", "7-2": "URL for customers website", "8-0": "datetime", "8-1": "Created", "8-2": "Date/Time customer was created (Read Only)", "9-0": "datetime", "9-1": "Modified", "9-2": "Date/Time customer was last changed (Read Only)" }, "cols": 3, "rows": 10 } [/block] [block:parameters] { "data": { "h-0": "Recurring Billing", "h-1": "Recurring Billing", "h-2": "Recurring Billing", "0-0": "boolean", "0-1": "Enabled", "0-2": "Notes whether or not a customer has been enabled for a recurring billing cycle. The customer billing does not need to be enabled to run one time transactions via the [runCustomcuerTransaction](/docs/runcustomertransaction) method.", "1-0": "string", "1-1": "Schedule", "1-2": "Recurring billing schedule, if any. Possible values include: daily, weekly, bi-weekly (every two weeks), monthly, bi-monthly (every two months), quarterly, bi-annually (every six months), annually, first of month, last day of month.", "2-0": "integer", "2-1": "NumLeft", "2-2": "Number of transactions remaining in customer's recurring billing cycle. ”-1” indicates unlimited transactions.", "3-0": "string", "3-1": "Next", "3-2": "Date of customer's next scheduled transaction.", "4-0": "double", "4-1": "Amount", "4-2": "Total Amount to be billed in recurring billing cycle.", "5-0": "double", "5-1": "Tax", "5-2": "Portion of “Amount” that is Tax", "6-0": "string", "6-1": "Currency", "6-2": "Numeric currency code for Amount. (Only needed if multicurrency merchant account)", "7-0": "string", "7-1": "Description", "7-2": "Description of transaction.", "8-0": "string", "8-1": "OrderID", "8-2": "Transaction Order ID", "9-0": "string", "9-1": "User", "9-2": "Merchant username assigned to billing.", "10-0": "string", "10-1": "Source", "10-2": "Name of source key assigned to billing.", "11-0": "boolean", "11-1": "SendReceipt", "11-2": "Send client a receipt.", "12-0": "string", "12-1": "ReceiptNote", "12-2": "Note to send on receipt.", "13-0": "int", "13-1": "Failures", "13-2": "Number of failures since last approval." }, "cols": 3, "rows": 14 } [/block] [block:parameters] { "data": { "h-0": "Point of Sale", "h-1": "Point of Sale", "h-2": "Point of Sale", "0-0": "string", "0-1": "PriceTier", "0-2": "Name of customer price tier", "1-0": "string", "1-1": "TaxClass", "1-2": "Tax Class (Group)", "2-0": "string", "2-1": "LookupCode", "2-2": "Lookup code from customer/member id card. Either barcode or Magnetic stripe. Can be assigned by merchants. Defaults to system assigned if left blank." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\n// for directions on how to set up the \n// WSDL link and create \"$token\" and \"$client,\"\n// see: http://wiki.eBizCharge.com/developer/soap/howto/php\n$CustomerObject=array(\n 'BillingAddress'=>array(\n 'FirstName'=>'John',\n 'LastName'=>'Doe',\n 'Company'=>'Acme Corp',\n 'Street'=>'1234 main st',\n 'Street2'=>'Suite #123',\n 'City'=>'Los Angeles',\n 'State'=>'CA',\n 'Zip'=>'12345',\n 'Country'=>'US',\n 'Email'=>'support@eBizCharge.com',\n 'Phone'=>'333-333-3333',\n 'Fax'=>'333-333-3334'\n ),\n 'PaymentMethods' =>\n array(\n array(\n 'CreditCardData' =>\n array(\n 'CardNumber'=>'4444555566667779',\n 'CardExpiration'=>'0908',\n 'CardType'=>'',\n 'CardCode'=>'',\n 'AvsStreet'=>'',\n 'AvsZip'=>'', \n 'CardPresent'=>'',\n 'MagStripe'=>'',\n 'TermType'=>'',\n 'MagSupport'=>'',\n 'XID'=>'',\n 'CAVV'=>'',\n 'ECI'=>'',\n 'InternalCardAuth'=>'',\n 'Pares'=>''\n ),\n \"Expires\"=>\"\",\n \"MethodName\"=>\"My Visa\",\n \"SecondarySort\"=>1 \n )\n ),\n 'CustomData'=>base64_encode(serialize(array(\"mydata\"=>\"We could put anything in here!\"))),\n 'CustomFields'=>array(\n array('Field'=>'Foo', 'Value'=>'Testing'),\n array('Field'=>'Bar', 'Value'=>'Tested')\n ),\n 'CustomerID'=>123123 + rand(),\n 'Description'=>'Weekly Bill',\n 'Enabled'=>false,\n 'Amount'=>'44.93',\n 'Tax'=>'0',\n 'Next'=>'2012-01-21',\n 'Notes'=>'Testing the soap addCustomer Function',\n 'NumLeft'=>'50',\n 'OrderID'=>rand(),\n 'ReceiptNote'=>'addCustomer test Created Charge',\n 'Schedule'=>'weekly',\n 'SendReceipt'=>true,\n 'Source'=>'Recurring',\n 'CustNum'=>'C'.rand()\n );\n$CustomerNumber=$this->client->addCustomer($this->token,$CustomerObject);\n$CustomerObject= $this->client->getCustomer($this->token, $CustomerNumber);\necho $CustomerObject->CustNum;\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim customer As eBizCharge.CustomerObject = New eBizCharge.CustomerObject\n Dim address As eBizCharge.Address = New eBizCharge.Address\n address.FirstName = \"John\"\n address.LastName = \"Doe\"\n address.Company = \"Acme\"\n address.Street = \"123 main st.\"\n address.City = \"Hollywood\"\n address.State = \"ca\"\n address.Zip = \"91607\"\n address.Country = \"USA\"\n customer.BillingAddress = address\n customer.Enabled = True\n customer.Amount = 5.0\n customer.Next = \"2010-08-15\"\n customer.Schedule = \"monthly\"\n Dim payMethod(0) As eBizCharge.PaymentMethod\n payMethod(0) = New eBizCharge.PaymentMethod\n payMethod(0).CardExpiration = \"1212\"\n payMethod(0).CardNumber = \"4444555566667779\"\n payMethod(0).AvsStreet = \"123 Main st.\"\n payMethod(0).AvsZip = \"90046\"\n payMethod(0).MethodName = \"My Visa\"\n customer.PaymentMethods = payMethod", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.CustomerObject customer = new eBizCharge.CustomerObject();\n eBizCharge.Address address = new eBizCharge.Address();\n address.FirstName = \"John\";\n address.LastName = \"Doe\";\n address.Company = \"Acme\";\n address.Street = \"123 main st.\";\n address.City = \"Hollywood\";\n address.State = \"ca\";\n address.Zip = \"91607\";\n address.Country = \"USA\";\n customer.BillingAddress = address;\n customer.Enabled = true;\n customer.Amount = 5.00;\n customer.Next = \"2010-08-15\";\n customer.Schedule = \"monthly\";\n eBizCharge.PaymentMethod[] payMethod = new eBizCharge.PaymentMethod[1];\n payMethod[0] = new eBizCharge.PaymentMethod();\n payMethod[0].CardExpiration = \"1212\";\n payMethod[0].CardNumber = \"4444555566667779\";\n payMethod[0].AvsStreet = \"123 Main st.\";\n payMethod[0].AvsZip = \"90046\";\n payMethod[0].MethodName = \"My Visa\";\n customer.PaymentMethods = payMethod;", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<getCustomerReturn xsi:type=\"ns1:CustomerObject\">\n<Amount xsi:type=\"xsd:double\">1.00</Amount>\n<BillingAddress xsi:type=\"ns1:Address\">\n<City xsi:type=\"xsd:string\">Los Angeles</City>\n<Company xsi:type=\"xsd:string\">eBizCharge</Company>\n<Country xsi:type=\"xsd:string\">US</Country>\n<Email xsi:type=\"xsd:string\">support@eBizCharge.com</Email>\n<Fax xsi:type=\"xsd:string\">333-333-3334</Fax>\n<FirstName xsi:type=\"xsd:string\">Example</FirstName>\n<LastName xsi:type=\"xsd:string\">Generator</LastName>\n<Phone xsi:type=\"xsd:string\">333-333-3333</Phone>\n<State xsi:type=\"xsd:string\">CA</State>\n<Street xsi:type=\"xsd:string\">1234 main st</Street>\n<Street2 xsi:type=\"xsd:string\">Suite #123</Street2>\n<Zip xsi:type=\"xsd:string\">12345</Zip>\n</BillingAddress>\n<CustNum xsi:type=\"xsd:string\">21727</CustNum>\n<CustomData xsi:type=\"xsd:string\">\n</CustomData>\n<CustomFields SOAP-ENC:arrayType=\"ns1:FieldValue[2]\" xsi:type=\"ns1:FieldValueArray\">\n<item xsi:type=\"ns1:FieldValue\">\n <Field xsi:type=\"xsd:string\">Example</Field>\n <Value xsi:type=\"xsd:string\">Field</Value>\n</item>\n</CustomFields>\n<CustomerID xsi:type=\"xsd:string\">156244967</CustomerID>\n<Created xsi:type=\"xsd:string\">2008-05-08 13:40:35</Created>\n<Description xsi:type=\"xsd:string\">Weekly Bill</Description>\n<Enabled xsi:type=\"xsd:boolean\">false</Enabled>\n<Modified xsi:type=\"xsd:string\">2008-05-08 13:40:35</Modified>\n<Next xsi:type=\"xsd:string\">2012-01-21T12:00:00</Next>\n<Notes xsi:type=\"xsd:string\">Any notes go here</Notes>\n<NumLeft xsi:type=\"xsd:integer\">50</NumLeft>\n<OrderID xsi:type=\"xsd:string\">1707022452</OrderID>\n<PaymentMethods SOAP-ENC:arrayType=\"ns1:PaymentMethod[1]\" xsi:type=\"ns1:PaymentMethodArray\">\n<item xsi:type=\"ns1:PaymentMethod\">\n <CheckData xsi:type=\"ns1:CheckData\">\n <Account xsi:nil=\"true\"/>\n <Routing xsi:nil=\"true\"/>\n </CheckData>\n <CreditCardData xsi:type=\"ns1:CreditCardData\">\n <AvsStreet xsi:type=\"xsd:string\">1234 main st</AvsStreet>\n <AvsZip xsi:type=\"xsd:string\">12345</AvsZip>\n <CardExpiration xsi:type=\"xsd:string\">XXXX</CardExpiration>\n <CardNumber xsi:type=\"xsd:string\">XXXXXXXXXXXX7779</CardNumber>\n <CardType xsi:type=\"xsd:string\">V</CardType>\n </CreditCardData>\n <Expires xsi:type=\"xsd:string\">2008-05-08</Expires>\n <MethodID xsi:type=\"xsd:integer\">7353</MethodID>\n <MethodName xsi:type=\"xsd:string\">My Visa</MethodName>\n <SecondarySort xsi:type=\"xsd:integer\">1</SecondarySort>\n</item>\n</PaymentMethods>\n<ReceiptNote xsi:type=\"xsd:string\">Example Receipt Note</ReceiptNote>\n<Schedule xsi:type=\"xsd:string\">Weekly</Schedule>\n<SendReceipt xsi:type=\"xsd:boolean\">true</SendReceipt>\n<Source xsi:type=\"xsd:string\">Recurring</Source>\n<Tax xsi:type=\"xsd:double\">0</Tax>\n<User xsi:type=\"xsd:string\">(Auto)</User>\n</getCustomerReturn>", "language": "xml" } ] } [/block]