Sale
Use this transaction to process a standard sale.
Endpoint : /sale
{
"siteid":"123456",
"txndate":"2023-02-01:16:13:20",
"terminalserialnumber":"6789654678",
"type":"sale",
"amount":"20.00",
"refid":"12345678987654321",
"wait":"y"
}
{
"siteid":"123456",
"terminalserialnumber":"6789654678",
"resultcode":"Approved",
"amount":"20.00",
"authcode":"abc1234",
"refid":"12345678987654321",
"cardtype":"Visa",
"last4":"0026",
"receipt":"Sample output",
"merchantreceipt":"Sample output",
"finalamount":"20.00"
}
- The transaction will be automatically settled at end of day.
- For DCC, the PED will process in the card currency if requested.
Void
Use this transaction to void a previously submitted transaction.
Endpoint : /void
{
"siteid":"123456",
"txndate":"2023-02-01:16:13:20",
"terminalserialnumber":"6789654678",
"type":"void",
"refid":"12345678987654321"
}
{
"siteid":"123456",
"resultcode":"Approved",
"refid":"12345678987654321234"
}
The refid refers to the original transaction refid.
Refund
Use this transaction to refund to a card.
Endpoint : /refund
{
"siteid":"123456",
"txndate":"2023-02-01:16:13:20",
"terminalserialnumber":"6789654678",
"type":"refund",
"amount":"20.00",
"refid":"12345678987654321234"
}
{
"siteid":"123456",
"terminalserialnumber":"6789654678",
"resultcode":"Approved",
"refid":"12345678987654321234",
"amount":"20.00",
"receipt":"Sample output",
"merchantreceipt":"Sample output"
}
- The refid refers to the original.
- The refund can be up to the amount of the original transaction.
- For CNP transactions, the card number should be keyed into the Terminal.
- Set linked to “n” to process a non-linked refund. By default all refunds are linked.
PreAuth
The PreAuth transaction processes a standard authorisation transaction to hold funds from the customer's card. Follow this with a Capture to complete the transaction.
Endpoint : /preauth
{
"siteid":"123456",
"txndate":"2023-02-01:16:13:20",
"terminalserialnumber":"6789654678",
"type":"preauth",
"amount":"60.00",
"refid":"89045432",
"wait":"y"
}
{
"siteid":"123456",
"terminalserialnumber":"6789654678",
"resultcode":"Approved",
"amount":"60.00",
"authcode":"abc1234",
"refid":"123456789876543212345",
"topuptoken":"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"expiry":"2023-02-08:04:13:20",
"cardtype":"Visa",
"last4":"0026",
"receipt":"Sample output",
"finalamount":"60.00",
"merchantreceipt":"Sample output"
}
- This transaction type will handle PreAuth CP and CNP. For CNP transactions, the Card number can be entered on the PED.
- The topuptoken returned in the response can be used to increase the amount authorized at a later time. Submit the value in the field topuptoken in a new PreAuth request and the new amount specified will be added to the total pre-authorized amount. This functionality is currently only limited to some Visa/Mastercard issuers. If the issuer doesn't support top ups, the transaction will decline.
Capture
Use this transaction to capture a previously authorized transaction.
Endpoint : /capture
{
"siteid":"123456",
"txndate":"2023-02-01:16:13:20",
"type":"capture",
"amount":"40.00",
"refid":"123456789876543212345"
}
{
"siteid":"123456",
"resultcode":"Approved",
"refid":"123456789876543212345",
"receipt":"Sample output",
"finalamount":"40.00",
"merchantreceipt":"Sample output"
}
- Use the refid to identify the original authorization.
- The capture can be up to 100% of the original authorization.
- The capture can only be executed once for a PreAuth.
- The transaction can be captured on a different terminal than the original transaction. If no terminalserialnumber is received, the system will use the terminalserialnumber used in the PreAuth.
Status
Use this transaction to retrieve the status of a previously submitted transaction. This can be used in cases such as communications or hardware failures.
Endpoint : /status
{
"siteid":"123456",
"txndate":"2023-02-01:16:13:20",
"refid":"123456789876543212345"
}
{
"siteid":"123456",
"resultcode":"Approved",
"authcode":"abc1234",
"refid":"123456789876543212",
"type":"sale",
"error":"",
"errorcode":"",
"topuptoken":"",
"cardtype":"Visa",
"last4":"0026",
"finalamount":"20.00"
}
Use the refid to identify the original authorization.
