Push Transactions (JSON)
Description
This Push Transaction message delivers a notification that a payment or refund has occurred by Levart or a third party payment gateway.
Note
Transactions can be unrelated to bookings i.e. paying for a drinks at the bar. It is still recommended to confirm every Transaction as any unconfirmed transactions will continue to be sent until confirmation is received.
Direction
Levart → PMS
Request
{
"Authentication": {
"Username": "abc1",
"Password": "abc2"
},
"TimeStamp": "2024-01-17T16:44:33+08:00",
"MessageID": "d5a5da66-e01c-4ed5-9897-3c6824a96755",
"MessageType": "PushTransaction",
"TransactionData": {
"TransactionID": "169",
"RelatedReference": "15688811",
"RelatedSource": "Levart",
"GatewayID": "StripeSmart",
"GatewayReference": "pi_3OCycjGh4NcHCnHJ1N7tufm8",
"CardMask": "XXXXXXXXXXXX6700",
"CardType": "visa",
"Type": "Payment",
"Currency": "AUD",
"CardFee": "10.61",
"TransactionFee": "0.33",
"AmountNet": "1000.00",
"AmountGross": "1010.94",
"ProcessedTime": "2024-01-16T14:00:23+08:00",
"Description": "Deposit"
}
}
Specification JSON Request
| Element | Num | Type | Description |
|---|---|---|---|
| Authentication | 1 | Object | Authentication object |
| Authentication > Username | 1 | String | Unique username for the property. |
| Authentication > Password | 1 | String | Unique password for the property. |
| MessageID | 1 | String | Unique Message ID |
| MessageType | 1 | String | Set to 'PushTransaction' |
| TimeStamp | 1 | DateTime | Date and time of the transaction in ISO 8601 format. e.g. 2024-01-28T15:15:00+08:00 |
| TransactionData | 1 | Object | TransactionData object |
| TransactionData > TransactionID | 1 | String | Unique ID for Levart |
| TransactionData > RelatedReference | 1 | String | Related booking reference. |
| TransactionData > RelatedSource | 1 | String | The source of the booking e.g. Levart, Booking.com, Expedia |
| TransactionData > GatewayID | 1 | String | The gateway identifier. e.g. LevartPay, StripeSmart |
| TransactionData > GatewayReference | 1 | String | The reference given by the payment gateway for this payment. |
| TransactionData > CardMask | 1 | String | Masked out card detailed used to make the payment. |
| TransactionData > CardType | 1 | String | Card type: visa, mastercard, amex, dinersCard |
| TransactionData > Type | 1 | String | Payment or Refund |
| TransactionData > Currency | 1 | String | Currency of the transacion e.g. AUD, USD or NZD |
| TransactionData > CardFee | 1 | Currency | Card fee included in the transaction |
| TransactionData > TransactionFee | 1 | Currency | Transaction fee included in the transaction |
| TransactionData > AmountNet | 1 | Currency | Amount of the transaction net of any TransactionFee or CardFee |
| TransactionData > AmountGross | 1 | Currency | Gross amount of the transation including all fees |
| TransactionData > ProcessedTime | 1 | DateTime | Time the transaction was processed by the payment gateway. |
| TransactionData > Description | 1 | String | Free form description text e.g. First nights accommodation. |
Response (Success)
{
"MessageID": "717b3bec-5321-4bad-84c1-075bff67f92c",
"TimeStamp": "2017-04-06T13:42:45+08:00",
"Status": "Success",
"ConfirmationID":"234234"
}Response (Error)
{
"MessageID": "717b3bec-5321-4bad-84c1-075bff67f92c",
"TimeStamp": "2017-04-06T13:42:45+08:00",
"Status": "Error",
"ErrorMessage": "Invalid username or password."
}Specification JSON Response
| Element | Num | Type | Description |
|---|---|---|---|
| MessageID | 1 | String | Unique Message ID (Same as the Request Message ID) |
| TimeStamp | 1 | DateTime | Date and time of the transaction in ISO 8601 format. e.g. 2016-01-28T15:15:00+08:00 |
| Status | 1 | String | Element contains either Error or Success |
| ErrorMessage | 0..1 | String | The description of the error (On Error only) |
| ConfirmationID | 0..1 | String | The Confirmation string provided by the PMS system. (On Success only) |