Developer ZoneRecipesAPI ReferenceChangelog
Developer Zone

APIs Interface

SoftPOS SDK API Interface


Class SoftPOSSDK
Methods Data Type Mandatory Description

Constructors initialize(params)

PGWSDKParams

M

Init class constructor with PGW SDK params initialise.

• SDK constructor
• params: Refer to: Init PGW SDK

instance

SoftPOSSDK

M

SoftPOS SDK instance methods.

pay(request, response)

PaymentRequest, PaymentResultResponseCallback

O

Payment API method.

Request: Refer to Payment Request

Response: Refer to SoftPOS Payment Result Response

voidTransaction(request, response)

PaymentRequest, PaymentResultResponseCallback

O

Void payment API method.

Request: Refer to Payment Request

Response: Refer to SoftPOS Payment Result Response


Payment Request


Class PaymentRequest
Parameter Data Type Mandatory Description

Constructors (activity, paymentToken)

Activity, String

M

Init class constructor with Android activity and PGW paymentToken.

• SDK constructor
• activity: Android activity. Refer to: Activity
• paymentToken: retrieve from PGW Payment Token API. Refer to: Payment Token

profileId

String

M

SoftPOS provider profile id.

transactionId

String

C

SoftPOS provider transaction id.

Refer to: SoftPOS Result

posType

SoftPOSType

O

SoftPOS device type.

Refer to: SoftPOS Type


SoftPOS Payment Result Response


Class SoftPOSPaymentResultResponse
Parameter Data Type Mandatory Description

paymentToken

String

M

PGW payment token.

Refer to: Payment Token

transactionStatusResponse

TransactionStatusResponse

M

PGW transaction status inquiry response.

Refer to: Transaction Status Response API

result

SoftPOSResult

M

SoftPOS provider result.

Refer to: SoftPOS Result

responseCode

String

M

API response code.

Refer to: SoftPOS Payment Response Code

responseDescription

String

M

API response description.

Refer to: SoftPOS Payment Response Code