Service Web Service

Service

Click here for a complete list of operations.

oneClickPaymentRequestV2

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

<?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>
    <oneClickPaymentRequestV2 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>
        <transactionShortDescription>string</transactionShortDescription>
        <transactionLongDescription>string</transactionLongDescription>
        <transactionCategoryCode>string</transactionCategoryCode>
      </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>
        <title>string</title>
        <firstName>string</firstName>
        <middleName>string</middleName>
        <lastName>string</lastName>
        <gender>string</gender>
        <dateOfBirth>dateTime</dateOfBirth>
        <houseNumber>string</houseNumber>
        <address1>string</address1>
        <address2>string</address2>
        <city>string</city>
        <state>string</state>
        <postcode>string</postcode>
        <country>string</country>
        <phone>string</phone>
        <mobile>string</mobile>
        <email>string</email>
        <customerLevel>string</customerLevel>
        <customerId>string</customerId>
        <ipAddress>string</ipAddress>
        <marketingSource>string</marketingSource>
      </customerData>
      <customerAccountDetails>
        <paymentChannel>string</paymentChannel>
        <bankCode>string</bankCode>
        <accountNumber>string</accountNumber>
        <accountPassword>string</accountPassword>
      </customerAccountDetails>
      <redirectionUrls>
        <successUrl>string</successUrl>
        <cancelUrl>string</cancelUrl>
        <errorUrl>string</errorUrl>
      </redirectionUrls>
      <customerReturnValue>string</customerReturnValue>
      <tokenOrder>
        <orderReference>string</orderReference>
        <salesChannel>string</salesChannel>
        <orderDescription>string</orderDescription>
        <orderUtcTimeStamp>dateTime</orderUtcTimeStamp>
        <totalPrice>decimal</totalPrice>
        <totalTax>decimal</totalTax>
        <totalLinePrice>decimal</totalLinePrice>
        <orderCurrency>string</orderCurrency>
        <orderItems>
          <TokenOrderItem>
            <itemCode>string</itemCode>
            <itemDescription>string</itemDescription>
            <quantity>decimal</quantity>
            <itemPrice>decimal</itemPrice>
            <discount>decimal</discount>
            <linePrice>decimal</linePrice>
            <vatRate>decimal</vatRate>
            <tax>decimal</tax>
          </TokenOrderItem>
          <TokenOrderItem>
            <itemCode>string</itemCode>
            <itemDescription>string</itemDescription>
            <quantity>decimal</quantity>
            <itemPrice>decimal</itemPrice>
            <discount>decimal</discount>
            <linePrice>decimal</linePrice>
            <vatRate>decimal</vatRate>
            <tax>decimal</tax>
          </TokenOrderItem>
        </orderItems>
      </tokenOrder>
    </oneClickPaymentRequestV2>
  </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>
    <oneClickPaymentRequestV2Response xmlns="http://merchantapi.envoyservices.com">
      <oneClickPaymentRequestV2Result>
        <statusCode>int</statusCode>
        <statusMessage>string</statusMessage>
        <tokenId>guid</tokenId>
        <tokenTTL>int</tokenTTL>
        <tokenExpiryUtcTime>dateTime</tokenExpiryUtcTime>
        <customerRedirectUrl>string</customerRedirectUrl>
        <qrCodeImageUrl>string</qrCodeImageUrl>
        <referenceDetails>
          <uniqueReference>string</uniqueReference>
          <customerRef>string</customerRef>
          <referenceExpiryUtcTime>dateTime</referenceExpiryUtcTime>
        </referenceDetails>
        <forexDetails>
          <amount>decimal</amount>
          <currency>string</currency>
          <receiveAmount>decimal</receiveAmount>
          <receiveCurrency>string</receiveCurrency>
          <forexRate>decimal</forexRate>
          <forexExpiryUTCTime>dateTime</forexExpiryUTCTime>
        </forexDetails>
        <customerReturnValue>string</customerReturnValue>
      </oneClickPaymentRequestV2Result>
    </oneClickPaymentRequestV2Response>
  </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>
    <oneClickPaymentRequestV2 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>
        <transactionShortDescription>string</transactionShortDescription>
        <transactionLongDescription>string</transactionLongDescription>
        <transactionCategoryCode>string</transactionCategoryCode>
      </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>
        <title>string</title>
        <firstName>string</firstName>
        <middleName>string</middleName>
        <lastName>string</lastName>
        <gender>string</gender>
        <dateOfBirth>dateTime</dateOfBirth>
        <houseNumber>string</houseNumber>
        <address1>string</address1>
        <address2>string</address2>
        <city>string</city>
        <state>string</state>
        <postcode>string</postcode>
        <country>string</country>
        <phone>string</phone>
        <mobile>string</mobile>
        <email>string</email>
        <customerLevel>string</customerLevel>
        <customerId>string</customerId>
        <ipAddress>string</ipAddress>
        <marketingSource>string</marketingSource>
      </customerData>
      <customerAccountDetails>
        <paymentChannel>string</paymentChannel>
        <bankCode>string</bankCode>
        <accountNumber>string</accountNumber>
        <accountPassword>string</accountPassword>
      </customerAccountDetails>
      <redirectionUrls>
        <successUrl>string</successUrl>
        <cancelUrl>string</cancelUrl>
        <errorUrl>string</errorUrl>
      </redirectionUrls>
      <customerReturnValue>string</customerReturnValue>
      <tokenOrder>
        <orderReference>string</orderReference>
        <salesChannel>string</salesChannel>
        <orderDescription>string</orderDescription>
        <orderUtcTimeStamp>dateTime</orderUtcTimeStamp>
        <totalPrice>decimal</totalPrice>
        <totalTax>decimal</totalTax>
        <totalLinePrice>decimal</totalLinePrice>
        <orderCurrency>string</orderCurrency>
        <orderItems>
          <TokenOrderItem>
            <itemCode>string</itemCode>
            <itemDescription>string</itemDescription>
            <quantity>decimal</quantity>
            <itemPrice>decimal</itemPrice>
            <discount>decimal</discount>
            <linePrice>decimal</linePrice>
            <vatRate>decimal</vatRate>
            <tax>decimal</tax>
          </TokenOrderItem>
          <TokenOrderItem>
            <itemCode>string</itemCode>
            <itemDescription>string</itemDescription>
            <quantity>decimal</quantity>
            <itemPrice>decimal</itemPrice>
            <discount>decimal</discount>
            <linePrice>decimal</linePrice>
            <vatRate>decimal</vatRate>
            <tax>decimal</tax>
          </TokenOrderItem>
        </orderItems>
      </tokenOrder>
    </oneClickPaymentRequestV2>
  </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>
    <oneClickPaymentRequestV2Response xmlns="http://merchantapi.envoyservices.com">
      <oneClickPaymentRequestV2Result>
        <statusCode>int</statusCode>
        <statusMessage>string</statusMessage>
        <tokenId>guid</tokenId>
        <tokenTTL>int</tokenTTL>
        <tokenExpiryUtcTime>dateTime</tokenExpiryUtcTime>
        <customerRedirectUrl>string</customerRedirectUrl>
        <qrCodeImageUrl>string</qrCodeImageUrl>
        <referenceDetails>
          <uniqueReference>string</uniqueReference>
          <customerRef>string</customerRef>
          <referenceExpiryUtcTime>dateTime</referenceExpiryUtcTime>
        </referenceDetails>
        <forexDetails>
          <amount>decimal</amount>
          <currency>string</currency>
          <receiveAmount>decimal</receiveAmount>
          <receiveCurrency>string</receiveCurrency>
          <forexRate>decimal</forexRate>
          <forexExpiryUTCTime>dateTime</forexExpiryUTCTime>
        </forexDetails>
        <customerReturnValue>string</customerReturnValue>
      </oneClickPaymentRequestV2Result>
    </oneClickPaymentRequestV2Response>
  </soap12:Body>
</soap12:Envelope>