Service Web Service

Service

Click here for a complete list of operations.

payToBankAccountV2

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: envoytx.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://merchantapi.envoyservices.com/payToBankAccountV2"

<?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>
    <payToBankAccountV2 xmlns="http://merchantapi.envoyservices.com">
      <auth>
        <username>string</username>
        <password>string</password>
        <UserId>string</UserId>
      </auth>
      <requestReference>string</requestReference>
      <paymentInstructions>
        <paymentInstructionV2>
          <paymentDetails>
            <countryCode>string</countryCode>
            <payee>string</payee>
            <sourceCurrency>string</sourceCurrency>
            <sourceAmount>double</sourceAmount>
            <targetCurrency>string</targetCurrency>
            <targetAmount>double</targetAmount>
            <sourceOrTarget>string</sourceOrTarget>
            <merchantReference>string</merchantReference>
            <paymentReference>string</paymentReference>
            <additionalInfo1>string</additionalInfo1>
            <additionalInfo2>string</additionalInfo2>
            <additionalInfo3>string</additionalInfo3>
            <email>string</email>
            <mobile>string</mobile>
          </paymentDetails>
          <bankDetails>
            <accountNumber>string</accountNumber>
            <bankName>string</bankName>
            <bankCode>string</bankCode>
            <branchCode>string</branchCode>
            <branchAddress>string</branchAddress>
            <accountType>string</accountType>
            <checkDigits>int</checkDigits>
            <iban>string</iban>
            <swift>string</swift>
            <ffc>string</ffc>
            <fastPayment>string</fastPayment>
            <bankAccountCurrency>string</bankAccountCurrency>
          </bankDetails>
        </paymentInstructionV2>
        <paymentInstructionV2>
          <paymentDetails>
            <countryCode>string</countryCode>
            <payee>string</payee>
            <sourceCurrency>string</sourceCurrency>
            <sourceAmount>double</sourceAmount>
            <targetCurrency>string</targetCurrency>
            <targetAmount>double</targetAmount>
            <sourceOrTarget>string</sourceOrTarget>
            <merchantReference>string</merchantReference>
            <paymentReference>string</paymentReference>
            <additionalInfo1>string</additionalInfo1>
            <additionalInfo2>string</additionalInfo2>
            <additionalInfo3>string</additionalInfo3>
            <email>string</email>
            <mobile>string</mobile>
          </paymentDetails>
          <bankDetails>
            <accountNumber>string</accountNumber>
            <bankName>string</bankName>
            <bankCode>string</bankCode>
            <branchCode>string</branchCode>
            <branchAddress>string</branchAddress>
            <accountType>string</accountType>
            <checkDigits>int</checkDigits>
            <iban>string</iban>
            <swift>string</swift>
            <ffc>string</ffc>
            <fastPayment>string</fastPayment>
            <bankAccountCurrency>string</bankAccountCurrency>
          </bankDetails>
        </paymentInstructionV2>
      </paymentInstructions>
    </payToBankAccountV2>
  </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>
    <payToBankAccountV2Response xmlns="http://merchantapi.envoyservices.com">
      <payToBankAccountV2Result>
        <requestReference>string</requestReference>
        <receivedDate>dateTime</receivedDate>
        <statusCode>int</statusCode>
        <statusMessage>string</statusMessage>
        <paymentInstructions>
          <paymentResultV2>
            <epacsReference>string</epacsReference>
            <merchantReference>string</merchantReference>
            <paymentReference>string</paymentReference>
            <paymentDetails>
              <countryCode>string</countryCode>
              <payee>string</payee>
              <sourceCurrency>string</sourceCurrency>
              <sourceAmount>double</sourceAmount>
              <targetCurrency>string</targetCurrency>
              <targetAmount>double</targetAmount>
              <sourceOrTarget>string</sourceOrTarget>
              <merchantReference>string</merchantReference>
              <paymentReference>string</paymentReference>
              <additionalInfo1>string</additionalInfo1>
              <additionalInfo2>string</additionalInfo2>
              <additionalInfo3>string</additionalInfo3>
              <email>string</email>
              <mobile>string</mobile>
            </paymentDetails>
            <bankDetails>
              <accountNumber>string</accountNumber>
              <bankName>string</bankName>
              <bankCode>string</bankCode>
              <branchCode>string</branchCode>
              <branchAddress>string</branchAddress>
              <accountType>string</accountType>
              <checkDigits>int</checkDigits>
              <iban>string</iban>
              <swift>string</swift>
              <ffc>string</ffc>
              <fastPayment>string</fastPayment>
              <bankAccountCurrency>string</bankAccountCurrency>
            </bankDetails>
            <paymentStatusCode>int</paymentStatusCode>
            <paymentStatusMessage>string</paymentStatusMessage>
          </paymentResultV2>
          <paymentResultV2>
            <epacsReference>string</epacsReference>
            <merchantReference>string</merchantReference>
            <paymentReference>string</paymentReference>
            <paymentDetails>
              <countryCode>string</countryCode>
              <payee>string</payee>
              <sourceCurrency>string</sourceCurrency>
              <sourceAmount>double</sourceAmount>
              <targetCurrency>string</targetCurrency>
              <targetAmount>double</targetAmount>
              <sourceOrTarget>string</sourceOrTarget>
              <merchantReference>string</merchantReference>
              <paymentReference>string</paymentReference>
              <additionalInfo1>string</additionalInfo1>
              <additionalInfo2>string</additionalInfo2>
              <additionalInfo3>string</additionalInfo3>
              <email>string</email>
              <mobile>string</mobile>
            </paymentDetails>
            <bankDetails>
              <accountNumber>string</accountNumber>
              <bankName>string</bankName>
              <bankCode>string</bankCode>
              <branchCode>string</branchCode>
              <branchAddress>string</branchAddress>
              <accountType>string</accountType>
              <checkDigits>int</checkDigits>
              <iban>string</iban>
              <swift>string</swift>
              <ffc>string</ffc>
              <fastPayment>string</fastPayment>
              <bankAccountCurrency>string</bankAccountCurrency>
            </bankDetails>
            <paymentStatusCode>int</paymentStatusCode>
            <paymentStatusMessage>string</paymentStatusMessage>
          </paymentResultV2>
        </paymentInstructions>
      </payToBankAccountV2Result>
    </payToBankAccountV2Response>
  </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: 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>
    <payToBankAccountV2 xmlns="http://merchantapi.envoyservices.com">
      <auth>
        <username>string</username>
        <password>string</password>
        <UserId>string</UserId>
      </auth>
      <requestReference>string</requestReference>
      <paymentInstructions>
        <paymentInstructionV2>
          <paymentDetails>
            <countryCode>string</countryCode>
            <payee>string</payee>
            <sourceCurrency>string</sourceCurrency>
            <sourceAmount>double</sourceAmount>
            <targetCurrency>string</targetCurrency>
            <targetAmount>double</targetAmount>
            <sourceOrTarget>string</sourceOrTarget>
            <merchantReference>string</merchantReference>
            <paymentReference>string</paymentReference>
            <additionalInfo1>string</additionalInfo1>
            <additionalInfo2>string</additionalInfo2>
            <additionalInfo3>string</additionalInfo3>
            <email>string</email>
            <mobile>string</mobile>
          </paymentDetails>
          <bankDetails>
            <accountNumber>string</accountNumber>
            <bankName>string</bankName>
            <bankCode>string</bankCode>
            <branchCode>string</branchCode>
            <branchAddress>string</branchAddress>
            <accountType>string</accountType>
            <checkDigits>int</checkDigits>
            <iban>string</iban>
            <swift>string</swift>
            <ffc>string</ffc>
            <fastPayment>string</fastPayment>
            <bankAccountCurrency>string</bankAccountCurrency>
          </bankDetails>
        </paymentInstructionV2>
        <paymentInstructionV2>
          <paymentDetails>
            <countryCode>string</countryCode>
            <payee>string</payee>
            <sourceCurrency>string</sourceCurrency>
            <sourceAmount>double</sourceAmount>
            <targetCurrency>string</targetCurrency>
            <targetAmount>double</targetAmount>
            <sourceOrTarget>string</sourceOrTarget>
            <merchantReference>string</merchantReference>
            <paymentReference>string</paymentReference>
            <additionalInfo1>string</additionalInfo1>
            <additionalInfo2>string</additionalInfo2>
            <additionalInfo3>string</additionalInfo3>
            <email>string</email>
            <mobile>string</mobile>
          </paymentDetails>
          <bankDetails>
            <accountNumber>string</accountNumber>
            <bankName>string</bankName>
            <bankCode>string</bankCode>
            <branchCode>string</branchCode>
            <branchAddress>string</branchAddress>
            <accountType>string</accountType>
            <checkDigits>int</checkDigits>
            <iban>string</iban>
            <swift>string</swift>
            <ffc>string</ffc>
            <fastPayment>string</fastPayment>
            <bankAccountCurrency>string</bankAccountCurrency>
          </bankDetails>
        </paymentInstructionV2>
      </paymentInstructions>
    </payToBankAccountV2>
  </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>
    <payToBankAccountV2Response xmlns="http://merchantapi.envoyservices.com">
      <payToBankAccountV2Result>
        <requestReference>string</requestReference>
        <receivedDate>dateTime</receivedDate>
        <statusCode>int</statusCode>
        <statusMessage>string</statusMessage>
        <paymentInstructions>
          <paymentResultV2>
            <epacsReference>string</epacsReference>
            <merchantReference>string</merchantReference>
            <paymentReference>string</paymentReference>
            <paymentDetails>
              <countryCode>string</countryCode>
              <payee>string</payee>
              <sourceCurrency>string</sourceCurrency>
              <sourceAmount>double</sourceAmount>
              <targetCurrency>string</targetCurrency>
              <targetAmount>double</targetAmount>
              <sourceOrTarget>string</sourceOrTarget>
              <merchantReference>string</merchantReference>
              <paymentReference>string</paymentReference>
              <additionalInfo1>string</additionalInfo1>
              <additionalInfo2>string</additionalInfo2>
              <additionalInfo3>string</additionalInfo3>
              <email>string</email>
              <mobile>string</mobile>
            </paymentDetails>
            <bankDetails>
              <accountNumber>string</accountNumber>
              <bankName>string</bankName>
              <bankCode>string</bankCode>
              <branchCode>string</branchCode>
              <branchAddress>string</branchAddress>
              <accountType>string</accountType>
              <checkDigits>int</checkDigits>
              <iban>string</iban>
              <swift>string</swift>
              <ffc>string</ffc>
              <fastPayment>string</fastPayment>
              <bankAccountCurrency>string</bankAccountCurrency>
            </bankDetails>
            <paymentStatusCode>int</paymentStatusCode>
            <paymentStatusMessage>string</paymentStatusMessage>
          </paymentResultV2>
          <paymentResultV2>
            <epacsReference>string</epacsReference>
            <merchantReference>string</merchantReference>
            <paymentReference>string</paymentReference>
            <paymentDetails>
              <countryCode>string</countryCode>
              <payee>string</payee>
              <sourceCurrency>string</sourceCurrency>
              <sourceAmount>double</sourceAmount>
              <targetCurrency>string</targetCurrency>
              <targetAmount>double</targetAmount>
              <sourceOrTarget>string</sourceOrTarget>
              <merchantReference>string</merchantReference>
              <paymentReference>string</paymentReference>
              <additionalInfo1>string</additionalInfo1>
              <additionalInfo2>string</additionalInfo2>
              <additionalInfo3>string</additionalInfo3>
              <email>string</email>
              <mobile>string</mobile>
            </paymentDetails>
            <bankDetails>
              <accountNumber>string</accountNumber>
              <bankName>string</bankName>
              <bankCode>string</bankCode>
              <branchCode>string</branchCode>
              <branchAddress>string</branchAddress>
              <accountType>string</accountType>
              <checkDigits>int</checkDigits>
              <iban>string</iban>
              <swift>string</swift>
              <ffc>string</ffc>
              <fastPayment>string</fastPayment>
              <bankAccountCurrency>string</bankAccountCurrency>
            </bankDetails>
            <paymentStatusCode>int</paymentStatusCode>
            <paymentStatusMessage>string</paymentStatusMessage>
          </paymentResultV2>
        </paymentInstructions>
      </payToBankAccountV2Result>
    </payToBankAccountV2Response>
  </soap12:Body>
</soap12:Envelope>