v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

CompleteSale

post/API/PaymentPageRequest.svc/CompleteSale

Request body

CustomerTransactionIdstring uuid required

Transaction Identifier - Generated With Method ChargeSimple.

Format: UUID Default: No

SaleTokenstring uuid required

Sale Identifier - Generated With Method CreateSale*..

~ Requires a Tokenization service Format: UUID Default: No

Example request

{
  "CustomerTransactionId": "24644836-fc10-4274-a523-b23036d9c030",
  "SaleToken": "38a267b3-aa62-4817-9207-9d935725128f"
}

Response

Payment With Token was Successful

ChargeStatusinteger

The Response Status Number (0 = Success, From SHVA).

ClientMessagestring

The Response Client Message (From SHVA).

DebugMessagestring

The Response Error (Same as ChargeStatus).

DocumentIdentitystring uuid

The Document Identifier.

DocumentLinkstring url

The Document URL.

DocumentNumberinteger nullable

The Sale Produced Document Number.

DocumentTypeinteger nullable

The Sale Produced Document Type.

PrintStatusinteger

Digital Signature Production Status (0 = Success).

ReceiptIdentitystring uuid

The Receipt Identifier.

ReceiptLinkstring url

The Receipt URL.

ReceiptNumberinteger nullable

The Sale Produced Receipt Number.

ReceiptTypeinteger nullable

The Sale Produced Receipt Type.

Statusinteger

iCredit Server Status Number (0 = Success).

Example response

{
  "DocumentIdentity": "3524c0e1-69eb-406b-a49b-fdbf261a65ff",
  "DocumentLink": "https://api.rivhit.co.il/pdf/test/FileService.svc/GetDocument/000008888/3524c0e1-69eb-406b-a49b-fdbf261a65ff/true/02_109855",
  "DocumentNumber": 109855,
  "DocumentType": 2,
  "ReceiptIdentity": "3524c0e1-69eb-406b-a49b-fdbf261a65ff",
  "ReceiptLink": "https://api.rivhit.co.il/pdf/test/FileService.svc/GetDocument/000008888/e3d7b93b-0d6a-4f9c-9719-bcddf4876b2b/true/01_016251",
  "ReceiptNumber": 16251,
  "ReceiptType": 1
}