{"_id":"5632a5ed49e16d0d001224d8","__v":0,"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"},"githubsync":"","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)"},"project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:16:43.566Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"Delete a payment method from an existing customer.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method removes a stored payment method from a customer's record.\nEach customer record may contain multiple payment methods. (Exception: see Beta6 note below.) This option allows you to remove expired or unused payment methods from your customer's records.\nNew payment methods may be added by using [addCustomerPaymentMethod](/docs/addcustomerpaymentmethod).\nThis 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*Please Note*: Beta6 supports only one payment method for each customer. This means that if you delete a payment method from a customer's account without adding a new method, the customer will be left with no existing payment methods.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nboolean **deleteCustomerPaymentMethod** ( [ueSecurityToken](/docs/uesecuritytoken) Token, Custnum, integer PaymentMethodID )\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\": \"No description available.\",\n    \"2-0\": \"integer\",\n    \"2-1\": \"PaymentMethodID\",\n    \"2-2\": \"The ID of the payment method to be deleted.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\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\": \"boolean\",\n    \"0-1\": \"Returns confirmation of payment method deletion only if successful. If deletion fails, an exception will be thrown.\"\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\": \"<?php\\ntry {\\n //Set CustNum for the Customer that you\\n //want to delete a payment method from\\n $CustNum=\\\"12345678\\\"\\n //Set PayID for the Payment Method ID\\n //that you want to delete\\n $PayID=\\\"7654321\\\"\\n // Delete the payment method\\n $Result=$client->deleteCustomerPaymentMethod($token, $CustNum, $PayID);        \\n} catch(Exception $e) {\\n echo 'Error: ' . $e->getMessage();\\n}\\n?>  \",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Java \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"try {\\n //Set CustNum for the Customer that you\\n //want to delete a payment method from\\n BigInteger custnum = new BigInteger(\\\"12345678\\\");\\n //Set PayID for the Payment Method ID\\n //that you want to delete\\n BigInteger PayID = new BigInteger(\\\"7654321\\\");\\n boolean Result = client.deleteCustomerPaymentMethod(token, CustNum, PayID);\\n} catch (Exception e) {\\n   System.out.println(\\\"Soap Exception: \\\" + e.getMessage());\\n}\",\n      \"language\": \"java\"\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 PaymentID As String\\n       PaymentID = \\\"41\\\"\\n       Dim response As Boolean\\n       response = client.deleteCustomerPaymentMethod(token, CustNum, PaymentID)\\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           string PaymentID = \\\"21\\\";\\n          Boolean response;\\n           try\\n           {\\n               response = client.deleteCustomerPaymentMethod(token, CustNum, PaymentID);\\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":"deletecustomerpaymentmethod","type":"basic","title":"deleteCustomerPaymentMethod"}

deleteCustomerPaymentMethod


Delete a payment method from an existing customer. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method removes a stored payment method from a customer's record. Each customer record may contain multiple payment methods. (Exception: see Beta6 note below.) This option allows you to remove expired or unused payment methods from your customer's records. New payment methods may be added by using [addCustomerPaymentMethod](/docs/addcustomerpaymentmethod). 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. *Please Note*: Beta6 supports only one payment method for each customer. This means that if you delete a payment method from a customer's account without adding a new method, the customer will be left with no existing payment methods. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] boolean **deleteCustomerPaymentMethod** ( [ueSecurityToken](/docs/uesecuritytoken) Token, Custnum, integer PaymentMethodID ) [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": "No description available.", "2-0": "integer", "2-1": "PaymentMethodID", "2-2": "The ID of the payment method to be deleted." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "boolean", "0-1": "Returns confirmation of payment method deletion only if successful. If deletion fails, an exception will be thrown." }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n //Set CustNum for the Customer that you\n //want to delete a payment method from\n $CustNum=\"12345678\"\n //Set PayID for the Payment Method ID\n //that you want to delete\n $PayID=\"7654321\"\n // Delete the payment method\n $Result=$client->deleteCustomerPaymentMethod($token, $CustNum, $PayID); \n} catch(Exception $e) {\n echo 'Error: ' . $e->getMessage();\n}\n?> ", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "try {\n //Set CustNum for the Customer that you\n //want to delete a payment method from\n BigInteger custnum = new BigInteger(\"12345678\");\n //Set PayID for the Payment Method ID\n //that you want to delete\n BigInteger PayID = new BigInteger(\"7654321\");\n boolean Result = client.deleteCustomerPaymentMethod(token, CustNum, PayID);\n} catch (Exception e) {\n System.out.println(\"Soap Exception: \" + e.getMessage());\n}", "language": "java" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim CustNum As String\n CustNum = \"103125\"\n Dim PaymentID As String\n PaymentID = \"41\"\n Dim response As Boolean\n response = client.deleteCustomerPaymentMethod(token, CustNum, PaymentID)\n MsgBox(response)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": " string CustNum = \"89792\";\n string PaymentID = \"21\";\n Boolean response;\n try\n {\n response = client.deleteCustomerPaymentMethod(token, CustNum, PaymentID);\n MessageBox.Show(string.Concat(response));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block]