partnerAPI - eBucks

partnerAPI - eBucks

The following Partner API calls is neccesary to facilitate eBucks transactions:

partnerAPI (AUTHENTICATE_ACCOUNT -  EBUCKS)

The following calls is used to create a to authenticate the eBucks customer credentials against the eBucks API.

  • 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}).

Y

Customfield

Action

Varchar

The Type of action being performed (e.g. AUTHENTICATE_ACCOUNT)

N

authenticateAccountType

Varchar

Metadata for identifying the type of action performed (Recommended).

N

ebucksMemberIdentifier

Varchar

Ebucks member's card number/Identification (e.g. RSA ID Number)

N

ebucksPin

Varchar

Pin number for the eBucks member login

N

partnerAPI (AUTHENTICATE_ACCOUNT - EBUCKS) - REQUEST
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://soap.api.controller.web.payjar.com/"><soapenv:Body> <soap:partnerApi> <Api>1.0</Api> <Safekey>{00000000-0000-0000-0000-000000000000}</Safekey> <Customfield> <key>action</key> <value>AUTHENTICATE_ACCOUNT</value> </Customfield> <Customfield> <key>authenticateAccountType</key> <value>EBUCKS</value> </Customfield> <Customfield> <key>ebucksMemberIdentifier</key> <value>7908149412253</value> </Customfield> <Customfield> <key>ebucksPin</key> <value>1969</value> </Customfield> </soap:partnerApi> </soapenv:Body> </soapenv:Envelope>
  • RESPONSE

Parameter

Type

Definition

Customfields

payUReference

Varchar(24)

PayU reference that should be used for all subsequent calls

resultCode

Integer

Result code returned by PayU for transaction.

resultMessage

Varchar(64)

Result message relating to result code for transaction.

eBucksAccountDetails

Varchar

JSON String containing member's account information such as the member's account number

partnerAPI (AUTHENTICATE_ACCOUNT - EBUCKS) - RESPONSE
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:partnerAPIResponse xmlns:ns2="http://soap.api.controller.web.payjar.com/"> <return> <customFields> <key>resultCode</key> <value>00</value> </customFields> <customFields> <key>resultMessage</key> <value>Successful</value> </customFields> <customFields> <key>payUReference</key> <value>31306435753</value> </customFields> <customFields> <key>eBucksAccountDetails</key> <value>{"sessionToken":"2c94861f4759928f014781c24285014f","firstName":"IPS","lastName":"TESTPRO", "idNumber":"7908149412253","email":"Testeucyq@ebucks.com","gender":1,"otpExempt":false,"accounts":{"account":[{"type":"EBUCKS_PERSONAL","number":"80000278865","name":"eBucks","balance":"99960493200","discountQualified":false,"rewardTier":-1,"discountRate":0}]}}</value> </customFields> </return> </ns2:partnerAPIResponse> </soap:Body> </soap:Envelope>

 

Top


partnerAPI (GENERATE_OTP -  EBUCKS)

The following is used to generate an OTP when paying with eBucks. The corresponding method API call to ebucks MEMBER API is generateOTP

  • 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}).

Y

Customfield

action

Varchar

The Type of action being performed (e.g.GENERATE_OTP)

N

generateOTPType

Varchar

Metadata for identifying the type of action performed (Recommended).

N

payUReference

Varchar(64)

PayU reference from initial authentication call to retain transaction thread.

N

ebucksAmount

Varchar

Pin number for the eBucks member login.

N

amountInCents

 Varchar

Rands amount in cents.

Y