Transaction

TerraCore v0

Usage#

Currently Minerva only supports following payment methods:

Online:

VNPayGateway (QR, ATM, InternationalCard, MobileBanking)
VNPayQRCode
VNPayTokenize
VNPayQRCustomer
VNPaySpos
VNPayEWallet
Loyalty
MoMoAIO

Offline:

COD
BankTransfer
Installment
InputRef (e.g: MomoPay, GrabPay...)

1. AIO Transaction#

1.1. Initialization#

AIO Transaction stands for All-in-one transaction. It means we can initialize a customize transaction contains multiple sub transactions. Ex: online, offline, loyalty.

iOS
Android

Firstly, we need to create a list of transaction requests.

let qrPortalRequest = GatewayMethodRequest(
    subMethod: .qr,
    amount: 10000
)

let loyaltyRequest = LoyaltyMethodRequest(
    points: 10000,
    amount: 10000
)

let codRequest = CodMethodRequest(
    amount: 10000
)

Then initialize AIOPaymentInfo

    let info = AIOPaymentInfo(
        orderCode: "xxx",
        orderDescription: "xxx",
        totalPaymentAmount: 10000
    )

Finally call initAIOTransaction function with AIOPaymentInfo and a list of transactionRequests.

TerraPayment
    .getInstance(by: terraApp)?
    .initAIOTransaction(
        info: info,
        requests: [qrPortalRequest, loyaltyRequest, codRequest]
    ) { result in
        switch result {
        case .success(let result):
            print(result)
        case .failure(let error):
            switch error {
            case .custom(let message):
                print(message)
            default:
                print("Error")
            }
        }
    }

Firstly, you must define which payment payload will pay for the order like below

val method1 = LoyaltyMethodRequest(
    points = 1,
    amount = 10000,
    redemptionCode = "redemptionCode")

val method2 = VNPayGatewayMethodRequest(amount = 10000)

val method3 = CODOfflineMethodRequest(amount = 10000, cashierCode = "cashierCode")

After that, using PayAIOBuilder to init request payload

val request = PayAIOBuilder()
                    .setOrderCode("yourOrderCode")
                    .setTotalPaymentAmount(20000)
                    .addPaymentMethods(method1, method2, method3)
                    .setSuccessUrl("https://payment.teko.vn")        // optional
                    .setCancelUrl("https://payment.teko.vn")         // optional
// perform request
val result = paymentGateway.initAIOTransaction(request)
// Handle the result
if (result.isSuccess()) {
// TODO: succeeded case
} else {
// TODO: failed case
}

1.2. Observe AIOTransaction result#

Observe the AIOTransaction result:

iOS
Android

Use method observePaymentResult passing 2 params: paymentRequestId and delegate for result

TerraPayment
    .getInstance(by: terraApp)?
    .observePaymentResult(
        code: paymentRequestId,
        delegate: self
    )

For result, class need implement PaymentObserverDelegate like example below:

extension XXX: PaymentObserverDelegate {
    func onPaymentResult(_ result: AIOPaymentResult) {
        // do whatever with result
    }

    func onPaymentObserve(code: String, result: PaymentObserveResult) {
        // result of observing transaction
    }

}

After init transaction successfully, You able to observe the result

paymentGateway.observePaymentResult(requestID)
            .onEach { result ->
                if (result.isSuccess()) {
                    //TODO: Handle for successfully case
                } else {
                    val errorDetail = result.errorDetail()
                    //TODO: Handle for failed case
                }
            }.launchIn(lifecycleScope)

Notes: the requestId will be available after call initAIOTransaction successfully

And when you want to cancel observing the transaction result, you use method cancelObservePaymentResult

iOS
Android

Auto cancelling based on lifecycleScope

2. Cancel Transaction#

A transaction can be canceled and unable to make payment by call this API.

iOS
Android

val request = CancelTransactionRequestBuilder()
            .setRequestId("requestId of transaction want to be canceled")
// perform request
val result = paymentGateway.cancelTransaction(request)
// Handle the result
if (result.isSuccess()) {
// TODO: succeeded case
} else {
// TODO: failed case
}

References#

PaymentError