Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In the case of a doTransaction for a FINALIZE. The transaction will go almost immediately from the NEW state to PROCESSING when PayU go off to the payment gateway to perform the payment. Upon receiving the response from the payment gateway the state is changed to SUCCESSFUL or FAILED.

...

doTransaction: Request Parameters

Parameter Name

Description

Data type

Required field for request

DoTransactionRequest

RESERVE_CANCEL

FINALIZE

CREDIT

Api

Version of the API. Current Version: 1.0 (SOAP: ONE_ZERO)

VarChar(4)

Y

Y

Y

Safekey

PayU Merchant Identifier. Provided to merchant upon integration

Char(38)

Y

Y

Y

TransactionType

The type of transaction being performed.
RESERVE_CANCEL
FINALIZE
CREDIT
EFFECT_STAGING

String

Y

Y

Y

PayUReference

PayU unique reference number for transaction

Integer

Y

Y

Y

AdditionalInformation

MerchantReference

Merchant identifier for transaction.

VarChar (64)

Y

Y

Y

DemoMode

To determine if the API request should be handled as a demo transaction. Values: True/False FUTURE USE

Boolean

N/A

N/A

N/A

NotificationURL

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

String

N

N

N

Customer

FirstName

Customer first name

VarChar (64)

N

N

N

LastName

Customer last name

VarChar (64)

N

N

N

RegionalId

Regional identifier for customer such as RSA ID

String

N

N

N

Mobile

Customer Mobile Number in international format without +( eg 27827891248)

String

N

N

N

Email

Customer Email Address

VarChar (64)

N

N

N

MerchUserId

Unique Customer ID in merchant system

VarChar (64)

N

N

N

Basket

Description

Basket description that will show on PayU

VarChar (64)

N/A

N/A

N/A

AmountInCents

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

Integer

Y

Y(2)

Y(2)

CurrencyCode

Currency code defined by PayU. Example: ZAR

VarChar(2)

Y

Y

Y

PaymentMethods – Credit Card

AmountInCents

Amount in cents for payment method. Format as 1000 for R10.00

Integer

Y

Y

Y

CustomFields

Key

Identification for custom field

VarChar (64)

N

N

N

Value

Value for custom field

VarChar (64)

N

N

N

...

doTransaction: Response Parameters

Parameter Name

Description

Values

Stage

Allows the merchant to stage a transaction. Values: true / false

Boolean

MerchantReference

Merchant identifier for transaction.

VarChar (64)

Successful

Boolean value to determine if the transaction was successful or not.

Boolean

PointOfFailure

Indicated on failed transactions where the point of failure was

VarChar (64)

ResultCode

Result code returned by PayU for transaction

String

ResultMessage

Result message relating to result code for transaction

String

DisplayMessage

Customer friendly message to display in a browser to the customer

String

PayUReference

PayU unique reference number for transaction

VarChar (64)

Description

Basket description that will show on PayU

VarChar (64)

AmountInCents

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

Integer

CurrencyCode

Currency code defined by PayU. Example: ZAR

String

Information

Payment method information (example: Loyalty program name)

VarChar (64)

NameOnCard

If Credit Card used, this will return Card holder name of the card

String

CardNumber

If Credit Card used, this will return a masked Credit Card number

VarChar (64)

AmountInCents

Amount in cents for payment method. Format as 1000 for R10.00

Integer

FraudIndex

If credit card is the payment method, this will be the fraud index returned from SafeShop.

Integer

doTransaction: SOAP request example

<soap:doTransaction xmlns:ns2?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://soap.api.controller.web.payjar.com/" xmlns:ns2="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
    <SOAP-ENV: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>Staging Integration Store 3</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">WSAUFbw6</wsse:Password>
            </wsse:UsernameToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <ns1:doTransaction>
            <Api>ONE_ZERO</Api>
                <Safekey>{XXXXXXXX07F70723-XXXX1B96-XXXX4B97-XXXXB891-XXXXXXXXXXXX7BF708594EEA}</Safekey>
    <TransactionType>PAYMENT<            <TransactionType>FINALIZE</TransactionType>
    <AuthenticationType>NA</AuthenticationType>
                <AdditionalInformation>
        <merchantReference>QA                <merchantReference>mercRef_Kyle<1395758911</merchantReference>
                    <payUReference>150243726115</payUReference>
            </AdditionalInformation>
                <Customer>
        <countryCode>27</countryCode>
        <merchantUserId>SOMETOKEN</merchantUserId>
        <email>clown@clown.com                <email>
                </email>
        <firstName>Joe<                <firstName>firstName_1395758911</firstName>
        <lastName>Guy<                <lastName>lastName_1395758911</lastName>
        <mobile>27887592452<                <merchantUserId>merchantUserId_1395758911</merchantUserId>
                <mobile>
                </mobile>
        <regionalId>5612124567897<                <regionalId>regionalId_1395758911</regionalId>
                </Customer>
                <Basket>
        <amountInCents>1000<                <amountInCents>8264</amountInCents>
                        <currencyCode>ZAR</currencyCode>
        <description>LoadTest</description>
                </Basket>
                <Creditcard>
        <amountInCents>1000<                <amountInCents>8264</amountInCents>
            </Creditcard>
        <cardExpiry>122012</cardExpiry>
        <cardNumber>4111120000005078</cardNumber>
        <cvv>123</cvv>
        <nameOnCard>Joe the Guy</nameOnCard>
    </Creditcard>
    <Customfield>
        <key>someName</key>
        <value>JoeJoe</value>
    </Customfield>
</soap:doTransaction></ns1:doTransaction>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

doTransaction: SOAP response example

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:doTransactionResponse xmlns:ns2="http://soap.api.controller.web.payjar.com/">
            <return>
                <merchantReference>mercRef_1395758911</merchantReference>
                <payUReference>150243726115</payUReference>
                <resultCode>00</resultCode>
                <resultMessage>Successful</resultMessage>
                <successful>true</successful>
            </return>
        </ns2:doTransactionResponse>
    </soap:Body>
</soap:Envelope>