doTransaction

Click on any of the following links to view a sample of the respective data structure

API requests:
- REQUEST - Credit Card request: PAYMENT or RESERVE
  This is the default API response for either a PAYMENT or RESERVE API call using credit cards as a payment method. Please make sure that you understand the difference between a PAYMENT and RESERVE api calls.
- REQUEST - Credit Card: PAYMENT or RESERVE (with Fraud enabled)
  PayU's Fraud service is an optional paid-for service. If integrating and signed up for fraud, please make sure to include the sections Basket.productLineItem, Basket.shippingDetails and Fraud
- REQUEST - Credit Card with Handshake
- REQUEST - Credit Card with Token (Save Card) - first request
- REQUEST - Credit Card with Token (Save Card) - subsequent request
API response:

- RESPONSE - Credit Card: PAYMENT or RESERVE
  This is the default API response for either a PAYMENT or RESERVE API call using credit cards.
- RESPONSE - Credit Card: PAYMENT or RESERVE (with bank reference)
  Merchant can request to have the the bank reference returned in the doTransaction API reponse (by default it is not returned) for credit card payments. If enabled it will send the bank reference in the customer field parameter.

REQUEST - Credit Card request: PAYMENT or RESERVE

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soap.api.controller.web.payjar.com/" xmlns:SOAPENV="
    http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header>
    <wsse:Security SOAP-ENV:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken-9" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
        <wsse:Username>~~~SOAP Username goes here~~~</wsse:Username>
        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">~~~SOAP Password goes
            here~~~</wsse:Password>
        </wsse:UsernameToken>
    </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
    <soap:doTransaction xmlns:ns2="http://soap.api.controller.web.payjar.com/">
        <Api>ONE_ZERO</Api>
        <Safekey>~~~SAFEKEY goes here ~~~</Safekey>
        <TransactionType>~~~a value of PAYMENT or RESERVE~~~</TransactionType>
        <AdditionalInformation>
          <merchantReference>~~~Merchant ref goes here~~~</merchantReference>
          <notificationUrl>http://example.com/notification-page/</notificationUrl>
        </AdditionalInformation>
        <Customer>
          <countryCode>27</countryCode>
          <countryOfResidence>ZAR</countryOfResidence>
          <merchantUserId>0123465798</merchantUserId>
          <email>john.doe@example.com</email>
          <firstName>John</firstName>
          <lastName> Doe </lastName>
          <mobile>0827777777</mobile>
          <regionalId>5612124567897</regionalId>
          <ip>127.0.0.1</ip>
        </Customer>
        <Basket>
          <amountInCents>12000</amountInCents>
          <currencyCode>ZAR</currencyCode>
          <description>Fraud Basket</description>
        </Basket>
        <Creditcard>
          <amountInCents>12000</amountInCents>
          <cardExpiry>122014</cardExpiry>
          <cardNumber>4111120000005078</cardNumber>
          <cvv>123</cvv>
          <nameOnCard>Fred Fraud</nameOnCard>
        </Creditcard>
    </soap:doTransaction>
    </soapenv:Body>
</soapenv:Envelope>

Top

REQUEST - Credit Card: PAYMENT or RESERVE (with Fraud enabled)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soap.api.controller.web.payjar.com/" xmlns:SOAPENV="
    http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header>
    <wsse:Security SOAP-ENV:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken-9" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
        <wsse:Username>~~~SOAP Username goes here~~~</wsse:Username>
        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">~~~SOAP Password goes
            here~~~</wsse:Password>
        </wsse:UsernameToken>
    </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
    <soap:doTransaction xmlns:ns2="http://soap.api.controller.web.payjar.com/">
        <Api>ONE_ZERO</Api>
        <Safekey>~~~SAFEKEY goes here ~~~</Safekey>
        <TransactionType>~~~a value of PAYMENT or RESERVE~~~</TransactionType>
        <AdditionalInformation>
          <deviceId>TERM003</deviceId>
          <merchantReference>~~~Merchant ref goes here ~~~</merchantReference>
          <notificationUrl> http://example.com/notification-page/</notificationUrl>
        </AdditionalInformation>
        <Customer>
          <countryCode>27</countryCode>
          <countryOfResidence>ZAR</countryOfResidence>
          <merchantUserId>0123465798</merchantUserId>
          <email>john.doe@example.com</email>
          <firstName>John</firstName>
          <lastName> Doe </lastName>
          <mobile>0827777777</mobile>
          <regionalId>5612124567897</regionalId>
          <ip>127.0.0.1</ip>
        </Customer>
        <Basket>
          <amountInCents>12000</amountInCents>
          <currencyCode>ZAR</currencyCode>
          <description>Fraud Basket</description>
          <!--Zero or more repetitions:-->
          <productLineItem>
              <amount>10000</amount>
              <costAmount>1000</costAmount>
              <description>Product 1</description>
              <giftMessage>Happy Birthday</giftMessage>
              <productCode>ABC0002</productCode>
              <quantity>1</quantity>
              <recipientAddress1>21 Example Road</recipientAddress1>
              <recipientCity>Cape Town</recipientCity>
              <recipientCountryCode>ZAR</recipientCountryCode>
              <recipientPostalCode>8000</recipientPostalCode>
              <recipientFirstName>John</recipientFirstName>
              <recipientLastName>Doe</recipientLastName>
          </productLineItem>
          <shippingDetails>
              <shippingAddress1>21 Example Road</shippingAddress1>
              <shippingAddressCity>Cape Town </shippingAddressCity>
              <shippingEmail> john.doe@example.com </shippingEmail>
              <shippingCountryCode>ZAR</shippingCountryCode>
              <shippingStateCode>WC</shippingStateCode>
              <shippingMethod>P</shippingMethod>
              <shppingFirstName>John</shppingFirstName>
              <shippingLastName>Doe</shippingLastName>
              <shippingFax>27214688020</shippingFax>shippingFax>
              <shippingPhone>27214688021</shippingPhone>
          </shippingDetails>
        </Basket>
        <Fraud>
          <checkFraudOverride>false</checkFraudOverride>
          <merchantWebSite>http://www.example.com/ </merchantWebSite>
          <pcFingerPrint>owhjiflkwhefqwoaef</pcFingerPrint>
        </Fraud>
        <Creditcard>
          <amountInCents>12000</amountInCents>
          <cardExpiry>122014</cardExpiry>
          <cardNumber>4111120000005078</cardNumber>
          <cvv>123</cvv>
          <nameOnCard>Fred Fraud</nameOnCard>
          <verified/>
        </Creditcard>
    </soap:doTransaction>
    </soapenv:Body>
</soapenv:Envelope>

Top

REQUEST - Credit Card with Handshake

<DoTransaction Api=â€�1.0â€� Safekey=â€�{86903CCB-79A9-42EE-8637-1ACE90185507}â€� TransactionType=â€�PAYMENTâ€� AuthenticationType=â€�HANDSHAKEâ€� >
    <AdditionalInformation>
        <merchantReference>CJR001</merchantReference>
    </AdditionalInformation>
    <Customer>
        <mobile>27827891249</mobile>
    </Customer>
    <Basket>
        <amountInCents>1000</amountInCents>
        <currencyCode>ZAR</currencyCode>
        <description>ORD111</description>
    </Basket>
    <PaymentMethods>
        <CreditCard pmID="jh23d29832jhdo23hu" CVV=â€�123â€� AmountInCents="2300" />
    </PaymentMethods>
</DoTransaction>

Top

REQUEST - Credit Card with Token (Save Card) - first request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soap.api.controller.web.payjar.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <soap:doTransaction xmlns:ns2="http://soap.api.controller.web.payjar.com/">
            <Api>ONE_ZERO</Api>
            <Safekey>{86903CCB-79A9-42EE-0174-1ACE90185507}</Safekey>
            <TransactionType>PAYMENT</TransactionType>
            <AuthenticationType>NA</AuthenticationType>
            <AdditionalInformation>
                <merchantReference>MerchRef001</merchantReference>
                <supportedPaymentMethods>CREDITCARD</supportedPaymentMethods>
                <storePaymentMethod>true</storePaymentMethod>
            </AdditionalInformation>
            <Customer>
                <countryCode>27</countryCode>
                <merchantUserId>MechUser001</merchantUserId>
                <email>name.surname@mail.com</email>
                <firstName>Name</firstName>
                <lastName>Surname</lastName>
                <mobile>27887592452</mobile>
                <regionalId>2345679888</regionalId>
            </Customer>
            <Basket>
                <amountInCents>1000</amountInCents>
                <currencyCode>ZAR</currencyCode>
                <description>Goods</description>
            </Basket>
            <Creditcard>
                <amountInCents>1000</amountInCents>
                <cardExpiry>122013</cardExpiry>
                <cardNumber>5111120000091349</cardNumber>
                <cvv>123</cvv>
                <nameOnCard>N Surname</nameOnCard>
            </Creditcard>
        </soap:doTransaction>
    </soapenv:Body>
</soapenv:Envelope>

Top

Credit Card with Token (Save Card) Subsequent REQUEST:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soap.api.controller.web.payjar.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:doTransaction xmlns:ns2="http://soap.api.controller.web.payjar.com/">
         <Api>ONE_ZERO</Api>
         <Safekey>{86903CCB-79A9-42EE-0174-1ACE90185507}</Safekey>
         <TransactionType>PAYMENT</TransactionType>
         <AuthenticationType>TOKEN</AuthenticationType>
         <AdditionalInformation>
          <merchantReference>MerchRef001</merchantReference>
          <supportedPaymentMethods>CREDITCARD</supportedPaymentMethods>
         </AdditionalInformation>
         <Customer>
            <countryCode>27</countryCode>
            <merchantUserId>MechUser001</merchantUserId>
            <email>name.surname@mail.com</email>
            <firstName>Name</firstName>
            <lastName>Surname</lastName>
            <mobile>27887592452</mobile>
            <regionalId>2345679888</regionalId>
         </Customer>
         <Basket>
            <amountInCents>1000</amountInCents>
            <currencyCode>ZAR</currencyCode>
            <description>Goods</description>
          </Basket>       
          <Creditcard
            <pmId>DyZ7XBB5QxF5FEoIADAkMCQAUnlDEmIRVXNTa3xUYVUWfEUT</pmId>
            <amountInCents>1000</amountInCents>
            <cvv>123</cvv>
         </Creditcard>
      </soap:doTransaction>
   </soapenv:Body>
</soapenv:Envelope>

Top

RESPONSE - Credit Card: PAYMENT or RESERVE

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:doTransactionResponse xmlns:ns2="http://soap.api.controller.web.payjar.com/">
         <return>
            <resultCode>00</resultCode>
            <resultMessage>Successful</resultMessage>
            <successful>true</successful>
            <displayMessage>Successful</displayMessage>
            <merchantReference>1234567890</merchantReference>
            <payUReference>21976214819</payUReference>
            <paymentMethodsUsed xsi:type="ns2:creditCard" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <amountInCents>1000</amountInCents>
               <cardExpiry>122015</cardExpiry>
               <cardNumber>400000******1000</cardNumber>
               <gatewayReference>37149772</gatewayReference>
               <information>VISA</information>
               <nameOnCard>John Doe</nameOnCard>
            </paymentMethodsUsed>
         </return>
      </ns2:doTransactionResponse>
   </soap:Body>
</soap:Envelope>

Top

REQUEST - Credit Card with Token (Save Card) - subsequent request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:doTransactionResponse xmlns:ns2="http://soap.api.controller.web.payjar.com/">
         <return>
            <resultCode>00</resultCode>
            <resultMessage>Successful</resultMessage>
            <successful>true</successful>
            <displayMessage>Successful</displayMessage>
            <merchantReference>1234567890</merchantReference>
            <payUReference>21976214819</payUReference>
            <paymentMethodsUsed xsi:type="ns2:creditCard" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <amountInCents>1000</amountInCents>
               <cardExpiry>122015</cardExpiry>
               <cardNumber>400000******1000</cardNumber>
               <gatewayReference>37149772</gatewayReference>
               <information>VISA</information>
               <nameOnCard>John Doe</nameOnCard>
            </paymentMethodsUsed> 
            <customFields>
               <key>bankReference</key>
               <value>DEMO12</value>
            </customFields>
         </return>
     Â </ns2:doTransactionResponse>
   </soap:Body>
</soap:Envelope>