DC Gateway CustomFields Web Service
Adds a custom field. Valid input values are: UserName & Password – Assigned by the payment gateway, RPNum – The numerical Vendor/Merchant key/RPNum, FieldName – Used as a key to programatically access the custom field, IsNumeric – TRUE | FALSE, DecimalPlaces – The number of decimal places allowed in the custom field, MaxLength – The maximum number of characters allowed in the custom field, RegEx – Any regular expression allowed by the custom field, IsRequired – TRUE | FALSE, Description – Displayed in the Virtual Terminal form, MinValue – Minimum value allowed by the custom field, MaxValue – Maximum value allowed by the custom field, DisplayOnReceipt – TRUE | FALSE, ErrorMessage – The error message that displays if parameters entered in the custom field do not match what is allowed
POST /ws/customfields.asmx HTTP/1.1 Host: pmn.payment-gate.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://pmn.payment-gate.net/AddCustomField" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <AddCustomField xmlns="http://pmn.payment-gate.net/"> <UserName>string</UserName> <Password>string</Password> <RPNum>string</RPNum> <FieldName>string</FieldName> <IsNumeric>boolean</IsNumeric> <DecimalPlaces>string</DecimalPlaces> <MaxLength>string</MaxLength> <RegEx>string</RegEx> <IsRequired>boolean</IsRequired> <Description>string</Description> <MinValue>string</MinValue> <MaxValue>string</MaxValue> <DisplayOnReceipt>boolean</DisplayOnReceipt> <ErrorMessage>string</ErrorMessage> </AddCustomField> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <AddCustomFieldResponse xmlns="http://pmn.payment-gate.net/"> <AddCustomFieldResult> <Result>int</Result> <RespMSG>string</RespMSG> <Message>string</Message> <Message1>string</Message1> <Message2>string</Message2> <AuthCode>string</AuthCode> <PNRef>string</PNRef> <HostCode>string</HostCode> <HostURL>string</HostURL> <ReceiptURL>string</ReceiptURL> <GetAVSResult>string</GetAVSResult> <GetAVSResultTXT>string</GetAVSResultTXT> <GetStreetMatchTXT>string</GetStreetMatchTXT> <GetZipMatchTXT>string</GetZipMatchTXT> <GetCVResult>string</GetCVResult> <GetCVResultTXT>string</GetCVResultTXT> <GetGetOrigResult>string</GetGetOrigResult> <GetCommercialCard>string</GetCommercialCard> <WorkingKey>string</WorkingKey> <KeyPointer>string</KeyPointer> <ExtData>string</ExtData> </AddCustomFieldResult> </AddCustomFieldResponse> </soap:Body> </soap:Envelope>
POST /ws/customfields.asmx HTTP/1.1 Host: pmn.payment-gate.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <AddCustomField xmlns="http://pmn.payment-gate.net/"> <UserName>string</UserName> <Password>string</Password> <RPNum>string</RPNum> <FieldName>string</FieldName> <IsNumeric>boolean</IsNumeric> <DecimalPlaces>string</DecimalPlaces> <MaxLength>string</MaxLength> <RegEx>string</RegEx> <IsRequired>boolean</IsRequired> <Description>string</Description> <MinValue>string</MinValue> <MaxValue>string</MaxValue> <DisplayOnReceipt>boolean</DisplayOnReceipt> <ErrorMessage>string</ErrorMessage> </AddCustomField> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <AddCustomFieldResponse xmlns="http://pmn.payment-gate.net/"> <AddCustomFieldResult> <Result>int</Result> <RespMSG>string</RespMSG> <Message>string</Message> <Message1>string</Message1> <Message2>string</Message2> <AuthCode>string</AuthCode> <PNRef>string</PNRef> <HostCode>string</HostCode> <HostURL>string</HostURL> <ReceiptURL>string</ReceiptURL> <GetAVSResult>string</GetAVSResult> <GetAVSResultTXT>string</GetAVSResultTXT> <GetStreetMatchTXT>string</GetStreetMatchTXT> <GetZipMatchTXT>string</GetZipMatchTXT> <GetCVResult>string</GetCVResult> <GetCVResultTXT>string</GetCVResultTXT> <GetGetOrigResult>string</GetGetOrigResult> <GetCommercialCard>string</GetCommercialCard> <WorkingKey>string</WorkingKey> <KeyPointer>string</KeyPointer> <ExtData>string</ExtData> </AddCustomFieldResult> </AddCustomFieldResponse> </soap12:Body> </soap12:Envelope>
GET /ws/customfields.asmx/AddCustomField?UserName=string&Password=string&RPNum=string&FieldName=string&IsNumeric=string&DecimalPlaces=string&MaxLength=string&RegEx=string&IsRequired=string&Description=string&MinValue=string&MaxValue=string&DisplayOnReceipt=string&ErrorMessage=string HTTP/1.1 Host: pmn.payment-gate.net
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <Response xmlns="http://pmn.payment-gate.net/"> <Result>int</Result> <RespMSG>string</RespMSG> <Message>string</Message> <Message1>string</Message1> <Message2>string</Message2> <AuthCode>string</AuthCode> <PNRef>string</PNRef> <HostCode>string</HostCode> <HostURL>string</HostURL> <ReceiptURL>string</ReceiptURL> <GetAVSResult>string</GetAVSResult> <GetAVSResultTXT>string</GetAVSResultTXT> <GetStreetMatchTXT>string</GetStreetMatchTXT> <GetZipMatchTXT>string</GetZipMatchTXT> <GetCVResult>string</GetCVResult> <GetCVResultTXT>string</GetCVResultTXT> <GetGetOrigResult>string</GetGetOrigResult> <GetCommercialCard>string</GetCommercialCard> <WorkingKey>string</WorkingKey> <KeyPointer>string</KeyPointer> <ExtData>string</ExtData> </Response>
POST /ws/customfields.asmx/AddCustomField HTTP/1.1 Host: pmn.payment-gate.net Content-Type: application/x-www-form-urlencoded Content-Length: length UserName=string&Password=string&RPNum=string&FieldName=string&IsNumeric=string&DecimalPlaces=string&MaxLength=string&RegEx=string&IsRequired=string&Description=string&MinValue=string&MaxValue=string&DisplayOnReceipt=string&ErrorMessage=string
Retrieves Custom Field information. Valid input values are: UserName & Password – Assigned by the payment gateway, RPNum – The numerical Vendor/Merchant key/RPNum
POST /ws/customfields.asmx HTTP/1.1 Host: pmn.payment-gate.net Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "https://pmn.payment-gate.net/GetCustomFields" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetCustomFields xmlns="http://pmn.payment-gate.net/"> <UserName>string</UserName> <Password>string</Password> <RPNum>string</RPNum> </GetCustomFields> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetCustomFieldsResponse xmlns="http://pmn.payment-gate.net/"> <GetCustomFieldsResult /> </GetCustomFieldsResponse> </soap:Body> </soap:Envelope>
POST /ws/customfields.asmx HTTP/1.1 Host: pmn.payment-gate.net Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetCustomFields xmlns="http://pmn.payment-gate.net/"> <UserName>string</UserName> <Password>string</Password> <RPNum>string</RPNum> </GetCustomFields> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetCustomFieldsResponse xmlns="http://pmn.payment-gate.net/"> <GetCustomFieldsResult /> </GetCustomFieldsResponse> </soap12:Body> </soap12:Envelope>
GET /ws/customfields.asmx/GetCustomFields?UserName=string&Password=string&RPNum=string HTTP/1.1 Host: pmn.payment-gate.net
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <anyType xmlns="http://pmn.payment-gate.net/" />
POST /ws/customfields.asmx/GetCustomFields HTTP/1.1 Host: pmn.payment-gate.net Content-Type: application/x-www-form-urlencoded Content-Length: length UserName=string&Password=string&RPNum=string