Service
Click here for a complete list of operations.
cancelPayin
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /MerchantAPI.asmx HTTP/1.1 Host: test.envoytx.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://merchantapi.envoyservices.com/cancelPayin" <?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> <cancelPayin xmlns="http://merchantapi.envoyservices.com"> <auth> <username>string</username> <password>string</password> <UserId>string</UserId> </auth> <cancelMerchantReference>string</cancelMerchantReference> <cancelInstruction> <CancelAdditionalData> <AdditionalData> <KeyName>string</KeyName> <KeyValue>string</KeyValue> </AdditionalData> <AdditionalData> <KeyName>string</KeyName> <KeyValue>string</KeyValue> </AdditionalData> </CancelAdditionalData> <CancelDetails> <TokenId>guid</TokenId> <CustomerReference>string</CustomerReference> <UniqueReference>string</UniqueReference> <Reason>string</Reason> <ServiceName>string</ServiceName> <CustomerReturnValue>string</CustomerReturnValue> </CancelDetails> </cancelInstruction> </cancelPayin> </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> <cancelPayinResponse xmlns="http://merchantapi.envoyservices.com"> <cancelPayinResult> <CancelResult> <ReceivedDate>dateTime</ReceivedDate> <CancelMerchantReference>string</CancelMerchantReference> </CancelResult> <StatusCode>int</StatusCode> <StatusMessage>string</StatusMessage> </cancelPayinResult> </cancelPayinResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /MerchantAPI.asmx HTTP/1.1 Host: test.envoytx.com 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> <cancelPayin xmlns="http://merchantapi.envoyservices.com"> <auth> <username>string</username> <password>string</password> <UserId>string</UserId> </auth> <cancelMerchantReference>string</cancelMerchantReference> <cancelInstruction> <CancelAdditionalData> <AdditionalData> <KeyName>string</KeyName> <KeyValue>string</KeyValue> </AdditionalData> <AdditionalData> <KeyName>string</KeyName> <KeyValue>string</KeyValue> </AdditionalData> </CancelAdditionalData> <CancelDetails> <TokenId>guid</TokenId> <CustomerReference>string</CustomerReference> <UniqueReference>string</UniqueReference> <Reason>string</Reason> <ServiceName>string</ServiceName> <CustomerReturnValue>string</CustomerReturnValue> </CancelDetails> </cancelInstruction> </cancelPayin> </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> <cancelPayinResponse xmlns="http://merchantapi.envoyservices.com"> <cancelPayinResult> <CancelResult> <ReceivedDate>dateTime</ReceivedDate> <CancelMerchantReference>string</CancelMerchantReference> </CancelResult> <StatusCode>int</StatusCode> <StatusMessage>string</StatusMessage> </cancelPayinResult> </cancelPayinResponse> </soap12:Body> </soap12:Envelope>