POST api/BackOffice/HandleCreditTransaction

Receive a credit card operation

Request Information

URI Parameters

None.

Body Parameters

Credit card transaction request object

CreditCardTransactionRequest
NameDescriptionTypeAdditional information
Source

The system that create the credit transaction

 string

Max length: 50
SourceReservationIdentifier

The unique reservation identifier in the system

 string

Max length: 50
Supplier

Credit card gateway (like credit guard)

 string

Max length: 20
Action

Debit/Refund

 string

Max length: 50
PaymentType

The type of the transaction made to the gateway

 EPaymentType

None.
CreditCardToken

Credit card token, generated by the gateway

 string

Max length: 50
CreditCardExpiration

Credit card expiration MM/yy format(05/21)

 string

Max length: 5
CardCompanyCode

Credit card company code(VI,DC,MC,AX)

 string

Max length: 2
CardHolderID

Credit card holder government ID number

 string

Max length: 50
TerminalNumber

The transaction terminal number

 string

Max length: 20
TransactionDateTime

The UTC transaction date time

 date

None.
TransactionNumber

The unique transaction number received from the gateway

 string

Max length: 50
AuthorizationNumber

The unique authorization number received from the gateway

 string

Max length: 50
Message

The transaction message received from the gateway

 string

Max length: 500
TotalAmount

The total amount of the transaction

 decimal number

None.
Currency

Transaction curecny code( USD/EUR/ILS/...)

 string

Max length: 3
NumberOfPayments

The total number of payments

 integer

None.
InstallmentsFees

Amount that collected due this payment option

 decimal number

None.
Security

SecurePayment

 SecurePayment

None.
FirstPaymentAmount

The amount of the first payment

 decimal number

None.
Mask

The mask of the credit card (4580***2963)

 string

None.
TripNumberInBackOffice

The trip number created in the back office - optional field

 string

Max length: 20
CustomerTransactionID

The trip number created in the back office - optional field

 integer

None.
CreditType

the payment method credit/regular/payments in the back office - optional field

 string

Max length: 20
CreditCardCompany

for example -Alphacard

 string

Max length: 30
CreditCardBrand

for example Visa

 string

Max length: 30
UserName

The provided user name.

 string

Required
Salt

A random number(at least 9 digits)

 integer

Required
Digest

A digest of the user credentials and the request

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "Source": "Amsalem Web-IL",
  "SourceReservationIdentifier": "WEB123456789",
  "Supplier": "Credit Guard",
  "Action": "Debit",
  "PaymentType": 2,
  "CreditCardToken": "1012163912344580",
  "CreditCardExpiration": "08/21",
  "CardCompanyCode": "VI",
  "CardHolderID": "300930468",
  "TerminalNumber": "0962832",
  "TransactionDateTime": "2025-04-26T00:03:30.47052Z",
  "TransactionNumber": "5601075",
  "AuthorizationNumber": "123456789",
  "Message": "Permitted transaction.",
  "TotalAmount": 300.0,
  "Currency": "ILS",
  "NumberOfPayments": 3,
  "InstallmentsFees": 0.0,
  "Security": {
    "Level": 1
  },
  "FirstPaymentAmount": 100.0,
  "Mask": "4580***4580",
  "TripNumberInBackOffice": null,
  "CustomerTransactionID": 0,
  "CreditType": null,
  "CreditCardCompany": null,
  "CreditCardBrand": null,
  "UserName": "AmsalemWebIL",
  "Salt": 962402951,
  "Digest": "DwIgzIpzKFsvmpQn1SB1PzwBCa04dvch19nqC3NR8dludwnPOsTK0pHMTpFTM+lzXRL2ILRvDPNuR5yE8pZGsw=="
}

application/xml, text/xml

Sample: 
<CreditCardTransactionRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="AmsalemWebIL" Salt="962402951" Digest="DwIgzIpzKFsvmpQn1SB1PzwBCa04dvch19nqC3NR8dludwnPOsTK0pHMTpFTM+lzXRL2ILRvDPNuR5yE8pZGsw==">
  <Source>Amsalem Web-IL</Source>
  <SourceReservationIdentifier>WEB123456789</SourceReservationIdentifier>
  <Supplier>Credit Guard</Supplier>
  <Action>Debit</Action>
  <PaymentType>J5</PaymentType>
  <CreditCardToken>1012163912344580</CreditCardToken>
  <CreditCardExpiration>08/21</CreditCardExpiration>
  <CardCompanyCode>VI</CardCompanyCode>
  <CardHolderID>300930468</CardHolderID>
  <TerminalNumber>0962832</TerminalNumber>
  <TransactionDateTime>2025-04-26T00:03:30.47052Z</TransactionDateTime>
  <TransactionNumber>5601075</TransactionNumber>
  <AuthorizationNumber>123456789</AuthorizationNumber>
  <Message>Permitted transaction.</Message>
  <TotalAmount>300</TotalAmount>
  <Currency>ILS</Currency>
  <NumberOfPayments>3</NumberOfPayments>
  <InstallmentsFees>0</InstallmentsFees>
  <Security>
    <Level>Secure3DS</Level>
  </Security>
  <FirstPaymentAmount>100</FirstPaymentAmount>
  <Mask>4580***4580</Mask>
  <CustomerTransactionID>0</CustomerTransactionID>
</CreditCardTransactionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Credit card transaction response object

CreditCardTransactionResponse
NameDescriptionTypeAdditional information
Result

The result of the operation

 WebOperationResult

None.

Response Formats

application/json, text/json

Sample: 
{
  "Result": {
    "Success": true,
    "Message": "",
    "Extra1": null,
    "Extra2": null,
    "Extra3": null
  }
}

application/xml, text/xml

Sample: 
<CreditCardTransactionResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>
    <Success>true</Success>
    <Message />
  </Result>
</CreditCardTransactionResponse>