Sign in

v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

CancelSale

post/API/PaymentPageRequest.svc/CancelSale

Request body

SaleIdstring uuid nullable

Sale Identifier.

Default: No

SalePrivateTokenstring uuid nullable

The Sale Private Identifier.

Default: No

AuthNumstring nullable

Transaction Approval Number.

Length: 1 to 9 Default: No

Example request

{
  "SaleId": "35926487-be48-408b-aaea-39c9f9efda09",
  "SalePrivateToken": "53037c08-001c-4569-bee3-08beffcbdaee",
  "AuthNum": "123456"
}

Response

Success - Sale Canceled.

ClientMessagestring

The Response Client Message (From SHVA).

DebugMessagestring

The Response Error (Same as ChargeStatus).

Statusinteger

The Response Status Number (0 = Success).

Example response

{
  "ClientMessage": "",
  "DebugMessage": "",
  "Status": 0,
  "data": {
    "DocumentIdentity": "a75d0d22-a595-4107-a95d-deee4a307580",
    "DocumentLink": "https://api.rivhit.co.il/pdf/test/FileService.svc/GetDocument/000008888/a75d0d22-a595-4107-a95d-deee4a307580/true/03_000202",
    "DocumentNumber": 202,
    "DocumentType": 3,
    "PrivateSaleToken": "ebf64612-1033-41c2-93b0-8b2cb5870ce6",
    "ReceiptIdentity": "913c2cf3-5a27-46b8-980d-6acbd10b7c26",
    "ReceiptLink": "https://api.rivhit.co.il/pdf/test/FileService.svc/GetDocument/000008888/913c2cf3-5a27-46b8-980d-6acbd10b7c26/true/01_016672",
    "ReceiptNumber": 16672,
    "ReceiptType": 1,
    "SaleToken": "09257b4b-2b3b-435c-92e3-18225788bf0a"
  }
}