Service Web Service

Service

Click here for a complete list of operations.

oneClickPaymentRequest

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/oneClickPaymentRequest"

<?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>
    <oneClickPaymentRequest xmlns="http://merchantapi.envoyservices.com">
      <auth>
        <username>string</username>
        <password>string</password>
        <UserId>string</UserId>
      </auth>
      <oneClickServiceInfo>
        <serviceName>string</serviceName>
        <languageCode>string</languageCode>
        <serviceData>
          <OneClickServiceData>
            <keyName>string</keyName>
            <keyValue>string</keyValue>
          </OneClickServiceData>
          <OneClickServiceData>
            <keyName>string</keyName>
            <keyValue>string</keyValue>
          </OneClickServiceData>
        </serviceData>
      </oneClickServiceInfo>
      <paymentData>
        <customerRef>string</customerRef>
        <country>string</country>
        <amount>decimal</amount>
        <currency>string</currency>
        <receiveAmount>decimal</receiveAmount>
        <receiveCurrency>string</receiveCurrency>
        <paymentMethod>string</paymentMethod>
      </paymentData>
      <customerData>
        <email>string</email>
        <firstName>string</firstName>
        <lastName>string</lastName>
        <address1>string</address1>
        <address2>string</address2>
        <city>string</city>
        <postcode>string</postcode>
        <country>string</country>
        <customerLevel>string</customerLevel>
        <customerId>string</customerId>
        <state>string</state>
        <phone>string</phone>
      </customerData>
      <customerAccountDetails>
        <paymentChannel>string</paymentChannel>
        <bankCode>string</bankCode>
        <accountNumber>string</accountNumber>
        <accountPassword>string</accountPassword>
      </customerAccountDetails>
      <successUrl>string</successUrl>
      <cancelUrl>string</cancelUrl>
      <errorUrl>string</errorUrl>
    </oneClickPaymentRequest>
  </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>
    <oneClickPaymentRequestResponse xmlns="http://merchantapi.envoyservices.com">
      <oneClickPaymentRequestResult>
        <statusCode>int</statusCode>
        <statusMessage>string</statusMessage>
        <tokenId>guid</tokenId>
        <tokenTTL>int</tokenTTL>
        <tokenExpiryUtcTime>dateTime</tokenExpiryUtcTime>
        <customerRedirectUrl>string</customerRedirectUrl>
      </oneClickPaymentRequestResult>
    </oneClickPaymentRequestResponse>
  </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>
    <oneClickPaymentRequest xmlns="http://merchantapi.envoyservices.com">
      <auth>
        <username>string</username>
        <password>string</password>
        <UserId>string</UserId>
      </auth>
      <oneClickServiceInfo>
        <serviceName>string</serviceName>
        <languageCode>string</languageCode>
        <serviceData>
          <OneClickServiceData>
            <keyName>string</keyName>
            <keyValue>string</keyValue>
          </OneClickServiceData>
          <OneClickServiceData>
            <keyName>string</keyName>
            <keyValue>string</keyValue>
          </OneClickServiceData>
        </serviceData>
      </oneClickServiceInfo>
      <paymentData>
        <customerRef>string</customerRef>
        <country>string</country>
        <amount>decimal</amount>
        <currency>string</currency>
        <receiveAmount>decimal</receiveAmount>
        <receiveCurrency>string</receiveCurrency>
        <paymentMethod>string</paymentMethod>
      </paymentData>
      <customerData>
        <email>string</email>
        <firstName>string</firstName>
        <lastName>string</lastName>
        <address1>string</address1>
        <address2>string</address2>
        <city>string</city>
        <postcode>string</postcode>
        <country>string</country>
        <customerLevel>string</customerLevel>
        <customerId>string</customerId>
        <state>string</state>
        <phone>string</phone>
      </customerData>
      <customerAccountDetails>
        <paymentChannel>string</paymentChannel>
        <bankCode>string</bankCode>
        <accountNumber>string</accountNumber>
        <accountPassword>string</accountPassword>
      </customerAccountDetails>
      <successUrl>string</successUrl>
      <cancelUrl>string</cancelUrl>
      <errorUrl>string</errorUrl>
    </oneClickPaymentRequest>
  </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>
    <oneClickPaymentRequestResponse xmlns="http://merchantapi.envoyservices.com">
      <oneClickPaymentRequestResult>
        <statusCode>int</statusCode>
        <statusMessage>string</statusMessage>
        <tokenId>guid</tokenId>
        <tokenTTL>int</tokenTTL>
        <tokenExpiryUtcTime>dateTime</tokenExpiryUtcTime>
        <customerRedirectUrl>string</customerRedirectUrl>
      </oneClickPaymentRequestResult>
    </oneClickPaymentRequestResponse>
  </soap12:Body>
</soap12:Envelope>