Paywizard DOCS
WizarPOS
  • Overview
  • Intro - Choose Your Best Practice
  • Cloud API
    • Quick Start - Cloud API
    • POS & Payment Terminal Binding Process
      • API 1: [Deprecated]Get Access Tokens
      • API 2: Bind POS & Payment Terminal
      • API 3: Get POS & Terminal Binding List
      • API : Unbind Terminal with POS
    • Do Transactions
      • API 4: POS Initiate Transaction
        • Transaction Request Example
      • API 5: POS System Query Transaction Results
      • Transaction Result Callback Interface
      • Transaction Type
      • Terminal API: Subscribe Transaction Results
  • HOST TO HOST INTEGRATION
    • Quick Start - Host to Host Integration
    • API: Transaction Result Push
    • API: Get Transaction Result
  • Semi integration
    • Payment App Integration Protocol
    • Payment App AIDL Integration
  • e-Receipt
    • e-Receipt Interface Intro
    • Terminal API : Upload Transaction Info
    • Terminal API : Upload Settlement Info
  • ONLINE PAYMENT INTEGRATION
    • Web Element Integration
    • Client Checkout Page SDK
Powered by GitBook
On this page
  • Through this API interface, you will be able to initiate a transaction from your Point Of Sale system or web platform.
  • Initiate a Transaction
  • Headers
  • Request Body
  • Request Sample
  • Response Body
  • Response Sample
  1. Cloud API
  2. Do Transactions

API 4: POS Initiate Transaction

PreviousDo TransactionsNextTransaction Request Example

Last updated 3 days ago

Through this API interface, you will be able to initiate a transaction from your Point Of Sale system or web platform.

This API is for Point of Sale system

The payment terminal which receiving the transaction request is the one binded to the POSID which belongs to the merchant.

Initiate a Transaction

Test Enviroment:

POST https://uat.paywizard.biz/ovstrade/semiOpen/internetTrans

Production Enviroment:

POST

Headers

Name
Value

Content-Type

application/json

jwt-token

The token responesed from Get Access Token

Request Body

Name
Type
Mandatory
Description

clientId

string

Developer ID

merchantId

String

Merchant ID

posId

String

POSID

tradeNo

String

Third-party POS systems order numbers,

must be unique under the same ISO/ISV.

transType

String

See support transaction type

transScheme

String

{Credit,Debit,EBT,ECS}

Default can be Credit if not sure

callerName

String

Merchant Name

transAmount

Long

This is the final total transaction amount.

Mandatory if it is a financial transaction.

The number of decimal places is determined by the CurrencyCode.

otherAmount

Long

Cash back amount

tipAmount

Long

Tip amount

currencyCode

String

Currency Code

Mandatory if it is a financial transaction.

reqTransDate

String

Trans Date (YYYYMMDD)

reqTransTime

String

Trans Time(hhmmss)

oriTransIndexCode

String

Origin Transaction Index Code

oriTraceNum

String

Origin Transaction Trace Number

oriInvoiceNum

String

Origin Transaction Invoice Number

oriTransId

String

Origin Transaction ID

oriRrn

String

Origin Transaction Reference Number

enableReceipt

boolean

{false,true}

Print receipt flag:

false: do not print,

true: print.

appendingReceiptInfo

String

Additional information to print on the receipt.

skipConfirmProcedure

boolean

{false,true}

Skip confirmation step:

false: do not skip.

true: skip

callBackUrl

String

If the POS system is cloud-based, the transaction result can be obtained through this URL.

Request Sample

{
    "clientId": "825420368247390208",
    "merchantId": "10800000003",
    "posId": "testPos",
    "tradeNo": "202404231080000000908",
    "transType": "Purchase",
    "transScheme": "Credit",
    "callerName": "test merchant",
    "transAmount": 100,
    "otherAmount": 0,
    "tipAmount": 0,
    "currencyCode": "458",
    "reqTransDate": "20241219",
    "reqTransTime": "095200",
    "enableReceipt": false,
    "appendingReceiptInfo": "",
    "skipConfirmProcedure": false
}
{
    "clientId": "825420368247390208",
    "merchantId": "10800000003",
    "posId": "testPos",
    "tradeNo": "202404231080000000909",
    "transType": "Refund",
    "transScheme": "Credit",
    "callerName": "test merchant",
    "transAmount": 100,
    "otherAmount": 0,
    "tipAmount": 0,
    "currencyCode": "458",
    "reqTransDate": "20241219",
    "reqTransTime": "095200",
    "enableReceipt": false,
    "appendingReceiptInfo": "",
    "skipConfirmProcedure": false,
    "oriTransId": "250520170313",
    "oriInvoiceNum": "250520170313",
    "oriTransIndexCode": "202404231080000000908"
}
{
    "clientId": "825420368247390208",
    "merchantId": "10800000003",
    "posId": "testPos",
    "tradeNo": "202404231080000000911",
    "transType": "Reversal",
    "transScheme": "Credit",
    "callerName": "test merchant",
    "transAmount": 100,
    "otherAmount": 0,
    "tipAmount": 0,
    "currencyCode": "458",
    "reqTransDate": "20241219",
    "reqTransTime": "095200",
    "enableReceipt": false,
    "appendingReceiptInfo": "",
    "skipConfirmProcedure": false,
    "oriTransId": "250520171016",
    "oriInvoiceNum": "250520171016",
    "oriTransIndexCode": "202404231080000000910"
}
{
    "clientId": "825420368247390208",
    "merchantId": "10800000003",
    "posId": "testPos",
    "tradeNo": "202404231080000000912",
    "transType": "PreAuth",
    "transScheme": "Credit",
    "callerName": "test merchant",
    "transAmount": 100,
    "otherAmount": 0,
    "tipAmount": 0,
    "currencyCode": "458",
    "reqTransDate": "20241219",
    "reqTransTime": "095200",
    "enableReceipt": false,
    "appendingReceiptInfo": "",
    "skipConfirmProcedure": false,
}
{
    "clientId": "825420368247390208",
    "merchantId": "10800000003",
    "posId": "testPos",
    "tradeNo": "202404231080000000913",
    "transType": "IncrementalAuth",
    "transScheme": "Credit",
    "callerName": "test merchant",
    "transAmount": 100,
    "otherAmount": 0,
    "tipAmount": 0,
    "currencyCode": "458",
    "reqTransDate": "20241219",
    "reqTransTime": "095200",
    "enableReceipt": false,
    "appendingReceiptInfo": "",
    "skipConfirmProcedure": false,
    "oriTransId": "250520171409",
    "oriInvoiceNum": "250520171409",
    "oriTransIndexCode": "202404231080000000912"
}
{
    "clientId": "825420368247390208",
    "merchantId": "10800000003",
    "posId": "testPos",
    "tradeNo": "202404231080000000914",
    "transType": "PartialReversal",
    "transScheme": "Credit",
    "callerName": "test merchant",
    "transAmount": 100,
    "otherAmount": 0,
    "tipAmount": 0,
    "currencyCode": "458",
    "reqTransDate": "20241219",
    "reqTransTime": "095200",
    "enableReceipt": false,
    "appendingReceiptInfo": "",
    "skipConfirmProcedure": false,
    "oriTransId": "250520171409",
    "oriInvoiceNum": "250520171409",
    "oriTransIndexCode": "202404231080000000912"
}
{
    "clientId": "825420368247390208",
    "merchantId": "10800000003",
    "posId": "testPos",
    "tradeNo": "202404231080000000915",
    "transType": "AuthCompletion",
    "transScheme": "Credit",
    "callerName": "test merchant",
    "transAmount": 100,
    "otherAmount": 0,
    "tipAmount": 0,
    "currencyCode": "458",
    "reqTransDate": "20241219",
    "reqTransTime": "095200",
    "enableReceipt": false,
    "appendingReceiptInfo": "",
    "skipConfirmProcedure": false,
    "oriTransId": "250520171409",
    "oriInvoiceNum": "250520171409",
    "oriTransIndexCode": "202404231080000000912"
}

Response Body

Name
Type
Mandatory
Description

code

int

Response Code

(200 Success,

Non-200 Failed)

msg

String

Response Message

timestamp

String

Date/Time(UTC)

Response Sample

{
    "code": 200,
    "msg": "200",
    "timestamp": "2024-08-12 14:45:54"
}

Please see:

https://portal.paywizard.biz/ovstrade/semiOpen/internetTrans
Transaction result callback interface