Page Comparison

...

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 - eBucks: PAYMENT
- REQUEST - Credit Card with Handshake
- REQUEST - Credit Card with Token (Save Card) - first request
- REQUEST - Credit Card with Token (Save Card) - subsequent request
- REQUEST - Crediting a transaction
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 3D Secure enabled - card enrolled)
  This is the default API response for either a PAYMENT or RESERVE API call using credit cards, but the store is 3D enabled.
- 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.
- RESPONSE - Credit Card: PAYMENT or RESERVE (with Fraud enabled - APPROVE)
  This is the default API response for either a PAYMENT or RESERVE API call using credit cards, where Fraud is enabled and an APPROVE response was recieved from the Fraud service provider.
- RESPONSE - Credit Card: PAYMENT or RESERVE (with Fraud enabled - CHALLENGE)
  This is the default API response for either a PAYMENT or RESERVE API call using credit cards, where Fraud is enabled and a CHALLENGE response was recieved from the Fraud service provider.
- RESPONSE - Credit Card: PAYMENT or RESERVE (with Fraud enabled - DENY)
  This is the default API response for either a PAYMENT or RESERVE API call using credit cards, where Fraud is enabled and a DENY response was recieved from the Fraud service provider.
- RESPONSE - eBucks: PAYMENT
  This is the default API response for either a PAYMENT or RESERVE API call using eBucks

Anchor

	example_without_fraud
	example_without_fraud

...

Code Block

language	xml
title	Credit Card with Token (Save Card) Subsequent REQUEST:
linenumbers	true

<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>

doTransaction (PAYMENT - EBUCKS)

The following is to send the payment instruction to the ebucks' API when paying with eBucks and can have a transaction type of payment or reserve. The corresponding method API call to ebucks PAYMENT API is Auth or AuthSettle

REQUEST

...

Parameter

...

Type

...

Definition

...

Required

...

Api

...

Varchar

...

Version of the API (e.g.ONE_ZERO).

...

Y

...

Safekey

...

Varchar(38)

...

PayU Merchant Identifier ('{GUID}'). Provided to merchant upon integration (e.g. {86903CCB-79A9-42EE-0174-1ACE90185507}).

...

TransactionType

...

Varchar

...

The type of transaction being performed (e.g. PAYMENT, RESERVE).

...

Y

...

payUReference

...

Varchar(24)

...

PayU reference from initial authenticate call to retain transaction thread

...

Additional Information

...

merchantReference

...

Varchar(64)

...

Unique merchant identifier for transaction.

...

Y

...

payUReference

...

Varchar(24)

...

PayU reference from initial authentication call to retain transaction thread (Transaction record will be created with supplied reference).

...

N

...

notificationUrl

...

Varchar

...

URL where the merchant would like to be notified of transaction result via IPN (Instant Payment Notification).

Needed for "secure3d=true" transactions.

...

N

...

returnUrl

...

Varchar

...

URL to return browser to after a customer has completed transaction. Needed for "secure3d=true" transactions.

...

N

...

Customer

...

merchantUserId

...

Varchar(64)

...

Unique Customer ID in merchant system

...

Y

...

email

...

Varchar(64)

...

Customer Email Address.

...

N

...

firstName

...

Varchar(64)

...

Customer first name.

...

N

...

lastName

...

Varchar(64)

...

Customer last name.

...

N

...

mobile

...

Varchar

...

Customer Mobile Number in international format without "+" (e.g. 27827891248).

...

N

...

Basket

...

amountInCents

...

Integer

...

Total amount of the basket in cents. Format as 1000 for R10.00.

...

Y

...

currencyCode

...

Varchar(2)

...

Currency code defined by PayU. Example: ZAR.

...

Y

...

description

...

Varchar(64)

...

Basket description that will show on PayU.

...

Y

...

Ebucks

...

amountInCents

...

Integer

...

Amount in eBucks cents.

...

Y

...

Customfield

...

ebucksOtp

...

Integer

...

OTP retrieved from customer which was generated during the GenerateOTP process.

...

Y

...

ebucksAccountNumber

...

Varchar

...

eBucks Member's account number retrieved from the AUTHENTICATE_ACCOUNT call.

...

    </Creditcard>
      </soap:doTransaction>
   </soapenv:Body>
</soapenv:Envelope>

Anchor

	REQUEST_eBucks_PAYMENT
	REQUEST_eBucks_PAYMENT

Top

Code Block

language	xml
title	doTransaction REQUEST - eBucks (PAYMENT - EBUCKS) - REQUEST
linenumbers	true

<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/" xmlns:SOAP-ENV="SOAP-ENV">
      <soapenv:Body>
      <soap:doTransaction xmlns:ns2="http://soap.api.controller.web.payjar.com/">
         <Api>ONE_ZERO</Api>
         <Safekey>{00000000-0000-0000-0000-000000000000}</Safekey>
         <TransactionType>PAYMENT/RESERVE</TransactionType>
         <AdditionalInformation>
            <merchantReference>1234567890</merchantReference>           
         </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>
         </Customer>
         <Basket>
            <amountInCents>12000</amountInCents> <!-- amount in zar cents -->
            <currencyCode>ZAR</currencyCode>
         </Basket>
         <Ebucks>
            <amountInCents>12000</amountInCents> <!-- amount in eBucks cents (EB * 10) -->
         </Ebucks>
        <Customfield>
            <key>ebucksOtp</key>
            <value>909059</value>
         </Customfield>
         <Customfield>
            <key>ebucksAccountNumber</key>
            <value>80000278865</value>
         </Customfield>
      </soap:doTransaction>
   </soapenv:Body>
</soapenv:Envelope>

...

Code Block

language	xml
title	RESPONSE - Credit Card: PAYMENT or RESERVE (with Fraud enabled - DENY)
linenumbers	true

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:doTransactionResponse xmlns:ns2="http://soap.api.controller.web.payjar.com/">
            <return>
                <fraud>
                    <resultCode>V039</resultCode>
                    <resultMessage>DENY - 0700</resultMessage>
                </fraud>
                <merchantReference>mercRef_1403098545</merchantReference>
                <payUReference>185879181093</payUReference>
                <resultCode>P044</resultCode>
                <resultMessage>Rejected for fraud</resultMessage>
                <successful>false</successful>
            </return>
        </ns2:doTransactionResponse>
    </soap:Body>
</soap:Envelope>

Anchor

	response_witheBucks_fraud_denyPAYMENT
	response_witheBucks_fraud_denyPAYMENT

Top

Code Block

language	xml
title	RESPONSE - doTransaction eBucks (PAYMENT - EBUCKS)
linenumbers	true

<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:ebucks" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <amountInCents>12000</amountInCents>
            </paymentMethodsUsed>
         </return>
      </ns2:doTransactionResponse>
   </soap:Body>
</soap:Envelope>

...

Versions Compared

Old Version 56

New Version 57

Key

doTransaction (PAYMENT - EBUCKS)