Reporting Transaction to Hoox

This page describes the Transaction API call.

Overview

After an Offer was presented to the buyer, and the buyer completed the purchase in the merchants website / app, a Transaction api call is made to register the transaction with Hoox. The response object of this call contains a transactionConfirmationId which should be kept by the merchant for future inquiries.

When Should You Send This Call

Transaction API call should be made after the buyer has completed the transaction, meaning the their credit card was charged successfully.

Report a transaction to Hoox, after the buyer has completed their purchase and the card was successfully charged. Should be used only with immediate discount incentive type.

post
Body

Payload to send in the transaction request body. this request is sent after the transaction is completed.

merchantIdstring · stringRequired

The merchant ID provided by Hoox.

Example: mid@FdnU121922
branchIdstring · stringRequired

The branch ID provided by Hoox.

Example: is@FdnU121311
apiKeystringRequired

The API Key provided by Hoox.

Example: bc@ut654!
keyPolicystringRequired

The Key Policy key provided by Hoox.

Example: hkp254768901
appIdstringOptional

The App ID Key provided by Hoox.

Example: app2451d#!
hooxValidationIdstringRequired

The hash validation Id from the hash validation response object.

Example: hashValidationId12234
currencyCodestringOptional

ISO 4271 representing the curremcy code.

Example: USD
offerValuenumberOptional

The value of the offer in used currency. If not present then 0 is assumed (for none applicable offers such as BNPL).

Example: 20
numberOfInstallmentsnumberOptional

The number of installments. Applicable only for BNPL offers. If not present - assumed 1.

Example: 20
cardIssuerstringOptional

The name of the card issuer that is being typed. If the merhanct requests confiramtion, card issuer should be known before the transaction is made. Values may be one of these - Isracard, Max, Cal, Hapoalim, Leumi, Discount, Fibi, Mizrahi.

Example: Isracard
cardBrandstringOptional

The brand name of the card as given by the card issuer. If the merhanct requests confiramtion, card brand should be known before the transaction is made. Values may be one of these - Mastercard, Visa, Amex, Diners, Isracard, GiftCard.

Example: Mastercard
branchTransactionIdstringOptional

The transaction id generated by the mechant. should be unique, preferebly uuid format. Should match the string sent in the offer request.

Example: lpid24500312
requestIdstringOptional

The request id that was sent in the offer response body.

Example: visaTid24500312
Responses
200
Transaction accepted.
application/json
post
POST /transaction HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 349

{
  "merchantId": "mid@FdnU121922",
  "branchId": "is@FdnU121311",
  "apiKey": "bc@ut654!",
  "keyPolicy": "hkp254768901",
  "appId": "app2451d#!",
  "hooxValidationId": "hashValidationId12234",
  "currencyCode": "USD",
  "offerValue": 20,
  "numberOfInstallments": 20,
  "cardIssuer": "Isracard",
  "cardBrand": "Mastercard",
  "branchTransactionId": "lpid24500312",
  "requestId": "visaTid24500312"
}
{
  "transactionConfirmationId": "123e4567-e89b-12d3-a456-426614174000"
}

Merchants must send the hooxValidationId or the requestId in the request payload.

Though Hoox keeps all transactionConfirmationId for you in our platform, it is a good practice to save them in your database for future inquiries.

Last updated