getCustomFields
Retrieve the custom fields for a specific gateway account.
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.
fieldvalue getCustomFields ( ueSecurityToken)
Type |
Name |
Description |
Token |
Merchant security token: used to identify merchant and retrieve the custom fields. |
Returns a FieldValue object containing the custom field and its name. |
The following exceptions (errors) are applicable to this method.
Code |
Message |
Advice |
40470 |
No custom fields defined. |
Merchant has not configured any custom fields. They must log into the merchant console to configure custom fields. |
<?php
try {
$res = $client->getCustomFields($token);
print_r($res);
}
catch(SoapFault $e) {
echo $e->getMessage();
}
?>
try
{
eBizCharge.FieldValue[] response = client.getCustomFields(token);
MessageBox.Show(string.Concat(response.Length));
}
catch (Exception err)
{
MessageBox.Show(err.Message);
}
Dim trace() As eBizCharge.FieldValue
trace = client.getCustomFields(token)
MsgBox(trace(0).Value)
Request:
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="urn:eBizCharge" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:getCustomFields>
<Token xsi:type="ns1:ueSecurityToken">
<ClientIP xsi:type="xsd:string">192.168.0.1</ClientIP>
<PinHash xsi:type="ns1:ueHash">
<HashValue xsi:type="xsd:string">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>
<Seed xsi:type="xsd:string">12678150211876663375</Seed>
<Type xsi:type="xsd:string">sha1</Type>
</PinHash>
<SourceKey xsi:type="xsd:string">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>
</Token>
</ns1:getCustomFields>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Response:
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="urn:eBizCharge"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:getCustomFieldsResponse>
<getCustomFieldsReturn SOAP-ENC:arrayType="ns1:FieldValue[3]" xsi:type="ns1:FieldValueArray">
<item xsi:type="ns1:FieldValue">
<Field xsi:type="xsd:string">custom1</Field>
<Value xsi:type="xsd:string">Favorite Color</Value>
</item>
<item xsi:type="ns1:FieldValue">
<Field xsi:type="xsd:string">custom2</Field>
<Value xsi:type="xsd:string">Favorite Movie</Value>
</item>
<item xsi:type="ns1:FieldValue">
<Field xsi:type="xsd:string">custom3</Field>
<Value xsi:type="xsd:string">Favorite Icecream</Value>
</item>
</getCustomFieldsReturn>
</ns1:getCustomFieldsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>