{"_id":"5632a5ed49e16d0d001224d7","__v":0,"category":{"_id":"5632a5e749e16d0d00122449","project":"55b933b3146ef121002158d3","__v":1,"version":"5632a5e549e16d0d00122443","pages":["5632a5ed49e16d0d001224cc","5632a5ed49e16d0d001224cd","5632a5ed49e16d0d001224ce","5632a5ed49e16d0d001224cf","5632a5ed49e16d0d001224d0","5632a5ed49e16d0d001224d1","5632a5ed49e16d0d001224d2","5632a5ed49e16d0d001224d3","5632a5ed49e16d0d001224d4","5632a5ed49e16d0d001224d5","5632a5ed49e16d0d001224d6","5632a5ed49e16d0d001224d7","5632a5ed49e16d0d001224d8","5632a5ed49e16d0d001224d9","5632a5ed49e16d0d001224da","5632a5ed49e16d0d001224db","5632a5ed49e16d0d001224dc","5632a5ed49e16d0d001224dd","5632a5ed49e16d0d001224de","5632a5ed49e16d0d001224df","5632a5ed49e16d0d001224e0"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-03T18:12:10.391Z","from_sync":false,"order":7,"slug":"customers-tokenization","title":"Customers (Tokenization)"},"user":"55b932ba8fd1a02b00f496c8","project":"55b933b3146ef121002158d3","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"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:16:19.825Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"This method allows you to add a new payment method to a customer record.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nMultiple payment methods may be stored for each customer. There is no limit to the number of payment methods that can be stored, but only one of these methods may be marked as the default payment method for all future transactions including recurring billing and manual charges.\nTo set a payment method as default, pass “true” for the MakeDefault parameter. Setting a payment method to default overrides the SecordarySort parameter and sets it to 0. If another method is currently set to default, it will have its SecondarySort changed to 1.\nAll new payment methods will be validated by the system to be sure that the information entered fits the required format for the specified payment method. (ie: Does the credit card have 16 digits and a future expiration date? Does the check routing number have 9 digits?)\nTo further verify that a credit card is “good”, set the Verify parameter to “true” (available for credit cards only). This setting will cause the gateway to run an AuthOnly transaction for $0.05. Any fraud modules that are configured for the source will be run. If the transaction is declined the payment method will not be stored and a fault will be thrown with the decline or error message.\nIf the Verify parameter is set to “false,” the payment data will still be checked to ensure that it is formatted correctly, but the credit card validity will not be verified.\nIf any errors are detected or the Verify fails, a fault will be thrown. This method requires the use of the CustNum, a unique customer number assigned by the gateway. If you have lost or cannot remember the customer's CustNum, use the [searchCustomers](/docs/searchcustomers) method to find the correct CustNum.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\ninteger **addCustomerPaymentMethod** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer CustNum, [PaymentMethod](/docs/paymentmethod), boolean MakeDefault, boolean Verify )\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Arguments\"\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\": \"[ueSecurityToken](/docs/uesecuritytoken)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and validate transaction.\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"CustNum\",\n    \"1-2\": \"A unique customer number assigned by the gateway.\",\n    \"2-0\": \"[PaymentMethod](/docs/paymentmethod)\",\n    \"2-1\": \"PaymentMethod\",\n    \"2-2\": \"Includes method name, description, ID, and expiration date.\",\n    \"3-0\": \"boolean\",\n    \"3-1\": \"MakeDefault\",\n    \"3-2\": \"Determines default payment method for specified customer. If set to true, payment method will be marked as default.\",\n    \"4-0\": \"boolean\",\n    \"4-1\": \"Verify\",\n    \"4-2\": \"If set to true, an AuthOnly verification of the credit card validity will be run. (See above.)\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"integer\",\n    \"0-1\": \"The ID of the new payment method.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\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\": \"try {\\n $CustNum='113701';\\n $PaymentMethod=array(\\n   'MethodName'=>'Example',\\n     'CardNumber'=>'4444555566667779',\\n     'CardExpiration'=>'1212',\\n     'CardType'=>'',    \\n     'CardCode'=>'',\\n     'AvsStreet'=>'',\\n     'AvsZip'=>'',  \\n   'SecondarySort'=>0\\n   );\\n $Default=true;\\n $Verify=false;\\n $MethodID=$client->addCustomerPaymentMethod($token, $CustNum, $PaymentMethod,\\n                                        $Default, $Verify);\\n}\\ncatch(SoapFault $e) {\\n echo \\\"\\\\n\\\\nResponse: \\\" . $client->__getLastResponse();\\n echo \\\"\\\\n\\\\nRequest: \\\" . $client->__getLastRequest();\\n echo \\\"SoapFault: \\\" .$e->getMessage();\\n}\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Java \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"try {\\n//Setting Customer Number\\nBigInteger custnum = new BigInteger(\\\"12345678\\\");\\n//Setting up New Payment Method\\nPaymentMethod paymethod = new PaymentMethod();\\n       paymethod.setExpires(\\\"2012-09-01\\\");\\n       CreditCardData ccdata = new CreditCardData();\\n               ccdata.setCardNumber(\\\"4000100011112224\\\");\\n               ccdata.setCardExpiration(\\\"0912\\\");\\n               ccdata.setAvsStreet(\\\"123 Main\\\");\\n               ccdata.setAvsZip(\\\"12345\\\");\\n       paymethod.setCreditCardData(ccdata);\\n       paymethod.setMethodName(\\\"My Visa\\\");\\n//Adding Payment Method\\nBigInteger PaymentMethodID = client.addCustomerPaymentMethod(token, custnum, paymethod, true, true);\\n} catch (Exception e) {\\n       System.out.println(\\\"Soap Exception: \\\" + e.getMessage());\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n##  Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim CustNum As String\\n       CustNum = \\\"103125\\\"\\n       Dim payMethod As eBizCharge.PaymentMethod = New eBizCharge.PaymentMethod\\n       payMethod.CardExpiration = \\\"1212\\\"\\n       payMethod.CardNumber = \\\"4000100011112224\\\"\\n       payMethod.AvsStreet = \\\"123 Main st.\\\"\\n       payMethod.AvsZip = \\\"90046\\\"\\n       payMethod.MethodName = \\\"My Visa\\\"\\n       Dim response As String\\n       response = client.addCustomerPaymentMethod(token, CustNum, payMethod, False, True)\\n       MsgBox(response)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string CustNum = \\\"89792\\\";            \\n           eBizCharge.PaymentMethod payMethod = new eBizCharge.PaymentMethod();\\n           payMethod.CardExpiration = \\\"1212\\\";\\n           payMethod.CardNumber = \\\"4000100011112224\\\";\\n           payMethod.AvsStreet = \\\"123 Main st.\\\";\\n           payMethod.AvsZip = \\\"90046\\\";\\n           payMethod.MethodName = \\\"My Visa\\\";\\n           string response;\\n           try\\n           {\\n               response = client.addCustomerPaymentMethod(token, CustNum,payMethod,false,true);\\n               MessageBox.Show(string.Concat(response));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"addcustomerpaymentmethod","type":"basic","title":"addCustomerPaymentMethod"}

addCustomerPaymentMethod


This method allows you to add a new payment method to a customer record. [block:api-header] { "type": "basic", "title": "Description" } [/block] Multiple payment methods may be stored for each customer. There is no limit to the number of payment methods that can be stored, but only one of these methods may be marked as the default payment method for all future transactions including recurring billing and manual charges. To set a payment method as default, pass “true” for the MakeDefault parameter. Setting a payment method to default overrides the SecordarySort parameter and sets it to 0. If another method is currently set to default, it will have its SecondarySort changed to 1. All new payment methods will be validated by the system to be sure that the information entered fits the required format for the specified payment method. (ie: Does the credit card have 16 digits and a future expiration date? Does the check routing number have 9 digits?) To further verify that a credit card is “good”, set the Verify parameter to “true” (available for credit cards only). This setting will cause the gateway to run an AuthOnly transaction for $0.05. Any fraud modules that are configured for the source will be run. If the transaction is declined the payment method will not be stored and a fault will be thrown with the decline or error message. If the Verify parameter is set to “false,” the payment data will still be checked to ensure that it is formatted correctly, but the credit card validity will not be verified. If any errors are detected or the Verify fails, a fault will be thrown. This method requires the use of the CustNum, a unique customer number assigned by the gateway. If you have lost or cannot remember the customer's CustNum, use the [searchCustomers](/docs/searchcustomers) method to find the correct CustNum. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] integer **addCustomerPaymentMethod** ( [ueSecurityToken](/docs/uesecuritytoken) Token, integer CustNum, [PaymentMethod](/docs/paymentmethod), boolean MakeDefault, boolean Verify ) [block:api-header] { "type": "basic", "title": "Arguments" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "[ueSecurityToken](/docs/uesecuritytoken)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and validate transaction.", "1-0": "integer", "1-1": "CustNum", "1-2": "A unique customer number assigned by the gateway.", "2-0": "[PaymentMethod](/docs/paymentmethod)", "2-1": "PaymentMethod", "2-2": "Includes method name, description, ID, and expiration date.", "3-0": "boolean", "3-1": "MakeDefault", "3-2": "Determines default payment method for specified customer. If set to true, payment method will be marked as default.", "4-0": "boolean", "4-1": "Verify", "4-2": "If set to true, an AuthOnly verification of the credit card validity will be run. (See above.)" }, "cols": 3, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "integer", "0-1": "The ID of the new payment method." }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "try {\n $CustNum='113701';\n $PaymentMethod=array(\n 'MethodName'=>'Example',\n 'CardNumber'=>'4444555566667779',\n 'CardExpiration'=>'1212',\n 'CardType'=>'', \n 'CardCode'=>'',\n 'AvsStreet'=>'',\n 'AvsZip'=>'', \n 'SecondarySort'=>0\n );\n $Default=true;\n $Verify=false;\n $MethodID=$client->addCustomerPaymentMethod($token, $CustNum, $PaymentMethod,\n $Default, $Verify);\n}\ncatch(SoapFault $e) {\n echo \"\\n\\nResponse: \" . $client->__getLastResponse();\n echo \"\\n\\nRequest: \" . $client->__getLastRequest();\n echo \"SoapFault: \" .$e->getMessage();\n}", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "try {\n//Setting Customer Number\nBigInteger custnum = new BigInteger(\"12345678\");\n//Setting up New Payment Method\nPaymentMethod paymethod = new PaymentMethod();\n paymethod.setExpires(\"2012-09-01\");\n CreditCardData ccdata = new CreditCardData();\n ccdata.setCardNumber(\"4000100011112224\");\n ccdata.setCardExpiration(\"0912\");\n ccdata.setAvsStreet(\"123 Main\");\n ccdata.setAvsZip(\"12345\");\n paymethod.setCreditCardData(ccdata);\n paymethod.setMethodName(\"My Visa\");\n//Adding Payment Method\nBigInteger PaymentMethodID = client.addCustomerPaymentMethod(token, custnum, paymethod, true, true);\n} catch (Exception e) {\n System.out.println(\"Soap Exception: \" + e.getMessage());\n}", "language": "http" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim CustNum As String\n CustNum = \"103125\"\n Dim payMethod As eBizCharge.PaymentMethod = New eBizCharge.PaymentMethod\n payMethod.CardExpiration = \"1212\"\n payMethod.CardNumber = \"4000100011112224\"\n payMethod.AvsStreet = \"123 Main st.\"\n payMethod.AvsZip = \"90046\"\n payMethod.MethodName = \"My Visa\"\n Dim response As String\n response = client.addCustomerPaymentMethod(token, CustNum, payMethod, False, True)\n MsgBox(response)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string CustNum = \"89792\"; \n eBizCharge.PaymentMethod payMethod = new eBizCharge.PaymentMethod();\n payMethod.CardExpiration = \"1212\";\n payMethod.CardNumber = \"4000100011112224\";\n payMethod.AvsStreet = \"123 Main st.\";\n payMethod.AvsZip = \"90046\";\n payMethod.MethodName = \"My Visa\";\n string response;\n try\n {\n response = client.addCustomerPaymentMethod(token, CustNum,payMethod,false,true);\n MessageBox.Show(string.Concat(response));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block]