REST API Documentation





Function overview






Custom types overview






Functions



CancelTransaction

(String publicKey, CancelTransactionRequest request)

Description: This function will cancel a transaction.

Method: POST
Endpoint: https://premium.black/service/rest/Pay.svc/CancelTransaction
Request Body: Json
Response Body: Json

Request parameters:
NameDatatypeDescription
publicKeyString-
requestCancelTransactionRequest -
NameDatatypeMax lengthIs optional
TransactionIdString-
TransactionKeyString-
ByCustomerString-
HashString-
ErrorString-
EnvironmentString-

Descriptions
TransactionIdThe ID of the transaction.
TransactionKeyThe Key of the transaction.
ByCustomerDeclares if the customer itselfs canceled (if allowed) or the merchant (will be logged)
HashA SHA256 Bit lowercase Hash of all fields in ascending sort order (excluding the Hash field)
Error-
Environment-


Response parameters:
NameDatatypeDescription
-CancelTransactionResponse -
NameDatatype
TransactionIdString
ResultString
HashString
ErrorString
EnvironmentString

Descriptions
TransactionIdThe ID of the transaction.
ResultResult of the request. ('true' or 'false')
HashA SHA256 Bit lowercase Hash of all fields in ascending sort order (excluding the Hash field)
ErrorContains error message if failed, else it is null
Environment-