{"_id":"5632a5eb49e16d0d001224b2","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"},"category":{"_id":"5632a5e749e16d0d0012244c","project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","__v":1,"pages":["5632a5eb49e16d0d001224a9","5632a5eb49e16d0d001224aa","5632a5eb49e16d0d001224ab","5632a5eb49e16d0d001224ac","5632a5eb49e16d0d001224ad","5632a5eb49e16d0d001224ae","5632a5eb49e16d0d001224af","5632a5eb49e16d0d001224b0","5632a5eb49e16d0d001224b1","5632a5eb49e16d0d001224b2"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:33:48.347Z","from_sync":false,"order":11,"slug":"general-merchant-methods","title":"General Merchant Methods"},"project":"55b933b3146ef121002158d3","__v":0,"user":"55b932ba8fd1a02b00f496c8","githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:49:00.625Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"Retrieve the custom fields for a specific gateway account.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to retrieve the custom fields for a specific gateway account.\nUse this method to identify which custom fields exist.\nTo retrieve the list of custom fields a token must me provided as an argument. The token will be used to identify the specific gateway account.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[fieldvalue](/docs/fieldvalue) **getCustomFields** ( [ueSecurityToken](/docs/uesecuritytoken))\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 retrieve the custom fields.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\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-1\": \"Returns a FieldValue object containing the custom field and its name.\",\n    \"0-0\": \"[FieldValue](/docs/fieldvalue)\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exceptions\"\n}\n[/block]\nThe following exceptions (errors) are applicable to this method.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Message\",\n    \"h-2\": \"Advice\",\n    \"0-0\": \"40470\",\n    \"0-1\": \"No custom fields defined.\",\n    \"0-2\": \"Merchant has not configured any custom fields. They must log into the merchant console to configure custom fields.\"\n  },\n  \"cols\": 3,\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 $res = $client->getCustomFields($token);\\n print_r($res);\\n}\\ncatch(SoapFault $e) {\\n echo $e->getMessage();\\n}\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"try\\n           {\\n               eBizCharge.FieldValue[] response = client.getCustomFields(token);\\n               MessageBox.Show(string.Concat(response.Length));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim trace() As eBizCharge.FieldValue\\n       trace = client.getCustomFields(token)\\n       MsgBox(trace(0).Value)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Request:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope\\n xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n xmlns:ns1=\\\"urn:eBizCharge\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:getCustomFields>\\n<Token xsi:type=\\\"ns1:ueSecurityToken\\\">\\n<ClientIP xsi:type=\\\"xsd:string\\\">192.168.0.1</ClientIP>\\n<PinHash xsi:type=\\\"ns1:ueHash\\\">\\n<HashValue xsi:type=\\\"xsd:string\\\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\\n<Seed xsi:type=\\\"xsd:string\\\">12678150211876663375</Seed>\\n<Type xsi:type=\\\"xsd:string\\\">sha1</Type>\\n</PinHash>\\n<SourceKey xsi:type=\\\"xsd:string\\\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\\n</Token>\\n</ns1:getCustomFields>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope\\n xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n xmlns:ns1=\\\"urn:eBizCharge\\\"\\n xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:getCustomFieldsResponse>\\n<getCustomFieldsReturn SOAP-ENC:arrayType=\\\"ns1:FieldValue[3]\\\" xsi:type=\\\"ns1:FieldValueArray\\\">\\n <item xsi:type=\\\"ns1:FieldValue\\\">\\n   <Field xsi:type=\\\"xsd:string\\\">custom1</Field>\\n   <Value xsi:type=\\\"xsd:string\\\">Favorite Color</Value>\\n </item>\\n <item xsi:type=\\\"ns1:FieldValue\\\">\\n   <Field xsi:type=\\\"xsd:string\\\">custom2</Field>\\n   <Value xsi:type=\\\"xsd:string\\\">Favorite Movie</Value>\\n </item>\\n <item xsi:type=\\\"ns1:FieldValue\\\">\\n   <Field xsi:type=\\\"xsd:string\\\">custom3</Field>\\n   <Value xsi:type=\\\"xsd:string\\\">Favorite Icecream</Value>\\n </item>\\n</getCustomFieldsReturn>\\n</ns1:getCustomFieldsResponse>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getcustomfields","type":"basic","title":"getCustomFields"}
Retrieve the custom fields for a specific gateway account. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method allows you to retrieve the custom fields for a specific gateway account. Use this method to identify which custom fields exist. To retrieve the list of custom fields a token must me provided as an argument. The token will be used to identify the specific gateway account. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [fieldvalue](/docs/fieldvalue) **getCustomFields** ( [ueSecurityToken](/docs/uesecuritytoken)) [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 retrieve the custom fields." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-1": "Returns a FieldValue object containing the custom field and its name.", "0-0": "[FieldValue](/docs/fieldvalue)" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Exceptions" } [/block] The following exceptions (errors) are applicable to this method. [block:parameters] { "data": { "h-0": "Code", "h-1": "Message", "h-2": "Advice", "0-0": "40470", "0-1": "No custom fields defined.", "0-2": "Merchant has not configured any custom fields. They must log into the merchant console to configure custom fields." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $res = $client->getCustomFields($token);\n print_r($res);\n}\ncatch(SoapFault $e) {\n echo $e->getMessage();\n}\n?>", "language": "php" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "try\n {\n eBizCharge.FieldValue[] response = client.getCustomFields(token);\n MessageBox.Show(string.Concat(response.Length));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim trace() As eBizCharge.FieldValue\n trace = client.getCustomFields(token)\n MsgBox(trace(0).Value)", "language": "c" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "Request:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope\n xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:getCustomFields>\n<Token xsi:type=\"ns1:ueSecurityToken\">\n<ClientIP xsi:type=\"xsd:string\">192.168.0.1</ClientIP>\n<PinHash xsi:type=\"ns1:ueHash\">\n<HashValue xsi:type=\"xsd:string\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\n<Seed xsi:type=\"xsd:string\">12678150211876663375</Seed>\n<Type xsi:type=\"xsd:string\">sha1</Type>\n</PinHash>\n<SourceKey xsi:type=\"xsd:string\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\n</Token>\n</ns1:getCustomFields>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope\n xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:getCustomFieldsResponse>\n<getCustomFieldsReturn SOAP-ENC:arrayType=\"ns1:FieldValue[3]\" xsi:type=\"ns1:FieldValueArray\">\n <item xsi:type=\"ns1:FieldValue\">\n <Field xsi:type=\"xsd:string\">custom1</Field>\n <Value xsi:type=\"xsd:string\">Favorite Color</Value>\n </item>\n <item xsi:type=\"ns1:FieldValue\">\n <Field xsi:type=\"xsd:string\">custom2</Field>\n <Value xsi:type=\"xsd:string\">Favorite Movie</Value>\n </item>\n <item xsi:type=\"ns1:FieldValue\">\n <Field xsi:type=\"xsd:string\">custom3</Field>\n <Value xsi:type=\"xsd:string\">Favorite Icecream</Value>\n </item>\n</getCustomFieldsReturn>\n</ns1:getCustomFieldsResponse>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]