Appearance

Lodging ​

NOTE

All amounts have the currency code designated in Amount.Currency.

Charge Types ​

Allowed values for Detail.Lodging[].Room[].ExtraCharges[].ChargeType:

ChargeTypes
  • phone
  • restaurant-room-service
  • mini-bar
  • laundry
  • other
  • gift-shop
  • movie
  • health-club
  • valet-parking
  • cash-disbursement
  • non-room
  • business-center

Use Cases ​

🔷 Suggested Minimal Authorization ​

Below is the suggested minimal amount of details recommended for lodging use.

Authorization
sh
URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": "638.00",
        "Fee": "5.50",
        "Tax": "46.40",
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "Track2": {
                "Track2": ";6011492100001000=3112901?"
            }
        }
    },
    "Attributes": {
        "EntryMode": "magstripe",
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true
        }
    },
    "Detail": {
        "Lodging": [
            {
                "FolioNumber": "Folio12345",
                "NumberOfRoomsBooked": 1,
                "Room": [
                    {
                        "ArrivalDate": "2027-11-25",
                        "DepartureDate": "2027-11-28",
                        "NumberOfRoomNights": 3,
                        "NumberOfAdults": 2,
                        "RoomLocation": "Oceanview123",
                        "BedType": "Queen",
                        "RoomType": "Deluxe",
                        "SmokingAllowed": false,
                        "RoomRateType": "AAA",
                        "RoomRateAmount": "295.00",
                        "RoomTaxAmount": [
                            {
                                "TaxTypeIdentifier": "state-sales-tax",
                                "TaxID": "123456789012345",
                                "TaxAmount": "46.40",
                                "TaxExempt": false,
                                "TaxRate": "0.10",
                                "TaxTreatment": "net-price-with-tax-at-invoice-level",
                                "TaxDiscountTreatment": "tax-calculated-post-discount"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "TransactionEntry": {
        "Device": "Test JSON",
        "DeviceVersion": "0.0",
        "Application": "PNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-01T12:01:01"
    }
}'

🔷 Completed Stay ​

The following workflow records a typical lodging stay:

1) Authorization with prepay and promotional codes; without extra charges ​

Authorization
sh
URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": "638.00",
        "Fee": "5.50",
        "Tax": "11.90",
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "Track2": {
                "Track2": ";6011492100001000=3112901?"
            }
        }
    },
    "Attributes": {
        "EntryMode": "magstripe",
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true
        }
    },
    "Detail": {
        "Lodging": [
            {
                "FolioNumber": "Folio12345",
                "NumberOfRoomsBooked": 2,
                "PrepaidAmount": 100.00,
                "TaxDetail": [
                    {
                        "TaxTypeIdentifier": "state-sales-tax",
                        "TaxID": "123456789012345",
                        "TaxAmount": "46.40",
                        "TaxExempt": false,
                        "TaxRate": "0.10",
                        "TaxTreatment": "net-price-with-tax-at-invoice-level",
                        "TaxDiscountTreatment": "tax-calculated-post-discount"
                    }
                ],
                "ProgramCode": "Code7890",
                "TravelAgencyCode": "ABCD1234",
                "TravelAgencyName": "TestTravel",
                "TollFreePhoneNumber": "8005555555",
                "FacilityPhoneNumber": "8005555555",
                "Remarks": "Test remark",
                "Room": [
                    {
                        "ArrivalDate": "2027-11-25",
                        "DepartureDate": "2027-11-28",
                        "NumberOfRoomNights": 3,
                        "NumberOfAdults": 2,
                        "RoomLocation": "Oceanview123",
                        "BedType": "Queen",
                        "RoomType": "Deluxe",
                        "SmokingAllowed": false,
                        "RoomRateType": "AAA",
                        "RoomRateAmount": "295.00",
                        "RoomTaxAmount": [
                            {
                                "TaxTypeIdentifier": "state-sales-tax",
                                "TaxID": "123456789012345",
                                "TaxAmount": "46.40",
                                "TaxExempt": false,
                                "TaxRate": "0.10",
                                "TaxTreatment": "net-price-with-tax-at-invoice-level",
                                "TaxDiscountTreatment": "tax-calculated-post-discount"
                            }
                        ],
                        "PromotionalCode": [
                            {
                                "PromotionStartDate": "2027-08-07T00:00:00",
                                "PromotionEndDate": "2027-12-31T00:00:00",
                                "PromotionalCode": "AUG10TIME"
                            }
                        ],
                        "AdditionalCoupon": [
                            {
                                "PromotionStartDate": "2027-08-07T00:00:00",
                                "PromotionEndDate": "2027-12-31T00:00:00",
                                "PromotionalCode": "FREE-MOVIE"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "TransactionEntry": {
        "Device": "Test JSON",
        "DeviceVersion": "0.0",
        "Application": "PNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-01T12:01:01"
    }
}'

2) Incremental Authorization with extra charges ​

An incremental authorization can be used to supplement the original authorization with more purchases.

TransactionID

An incremental authorization will use the TransactionID from the original authorization.

Incremental Authorization
sh
URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": "43.00",
        "Fee": "2.50",
        "Tax": "3.90",
        "Currency": "USD"
    },
    "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
    "Detail": {
        "Lodging": [
            {
                "FolioNumber": "Folio12345",
                "Remarks": "Test remark",
                "Room": [
                    {
                        "ExtraCharges": [
                            {
                                "ChargeType": "gift-shop",
                                "ChargeAmount": "43.00"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "Attributes": {
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true,
            "IncrementalAuth": true
        }
    },
    "TransactionEntry": {
        "Device": "Test JSON",
        "DeviceVersion": "0.0",
        "Application": "PNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-01T12:01:01"
    }
}'

3) Partial Reversal ​

Partial Reversal
sh
URL=https://api.qa.paynetworx.net/v0/transaction/partialreversal
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 681.00,
        "Currency": "USD"
    },
    "ReplacementAmount": {
        "Total": 648.00,
        "Currency": "USD"
    },
    "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
    "Reason": "system-error",
    "Attributes": {
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true
        }
    },
    "TransactionEntry": {
        "Device": "Test JSON",
        "DeviceVersion": "0.0",
        "Application": "PNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-01T12:01:01"
    }
}'

4) Capture with lodging stay completed ​

Capture
sh
URL=https://api.qa.paynetworx.net/v0/transaction/capture
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": 648.00,
        "Currency": "USD"
    },
    "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
    "Attributes": {
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true
        }
    },
    "TransactionEntry": {
        "Device": "Fake test JSON",
        "DeviceVersion": "0.0",
        "Application": "PsuedoPNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-14T17:01:44"
    }
}'

🔷 No Show with prepay and promotional codes, capturing original amount ​

The following workflow records a generic lodging stay where the customer did not show up for their stay:

1. Authorization with prepay and promotional codes; without extra charges ​

Authorization
sh
URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": "638.00",
        "Fee": "5.50",
        "Tax": "46.40",
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "Track2": {
                "Track2": ";6011492100001000=3112901?"
            }
        }
    },
    "Attributes": {
        "EntryMode": "magstripe",
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true
        }
    },
    "Detail": {
        "Lodging": [
            {
                "FolioNumber": "Folio12345",
                "NumberOfRoomsBooked": 1,
                "Room": [
                    {
                        "ArrivalDate": "2027-11-25",
                        "DepartureDate": "2027-11-28",
                        "NumberOfRoomNights": 3,
                        "NumberOfAdults": 2,
                        "RoomLocation": "Oceanview123",
                        "BedType": "Queen",
                        "RoomType": "Deluxe",
                        "SmokingAllowed": false,
                        "RoomRateType": "AAA",
                        "RoomRateAmount": "295.00",
                        "RoomTaxAmount": [
                            {
                                "TaxTypeIdentifier": "state-sales-tax",
                                "TaxID": "123456789012345",
                                "TaxAmount": "46.40",
                                "TaxExempt": false,
                                "TaxRate": "0.10",
                                "TaxTreatment": "net-price-with-tax-at-invoice-level",
                                "TaxDiscountTreatment": "tax-calculated-post-discount"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "TransactionEntry": {
        "Device": "Test JSON",
        "DeviceVersion": "0.0",
        "Application": "PNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-01T12:01:01"
    }
}'

2. Capture the prepay and promotional codes with No Show; original full prepaid amount ​

Capture
sh
URL=https://api.qa.paynetworx.net/v0/transaction/capture
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": "150.00",
        "Fee": "3.20",
        "Tax": "7.90",
        "Currency": "USD"
    },
    "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
    "Detail": {
        "Lodging": [
            {
                "FolioNumber": "Folio12345",
                "NumberOfRoomsBooked": 2,
                "ExtraChargesTotalAmount": 41.00,
                "PostCheckoutAdjustmentAmount": 2.00,
                "PrepaidAmount": 100.00,
                "TaxDetail": [
                    {
                        "TaxTypeIdentifier": "state-sales-tax",
                        "TaxID": "123456789012345",
                        "TaxAmount": "7.90",
                        "TaxExempt": false,
                        "TaxRate": "0.10",
                        "TaxTreatment": "net-price-with-tax-at-invoice-level",
                        "TaxDiscountTreatment": "tax-calculated-post-discount"
                    }
                ],
                "NoShowIndicator": true,
                "ProgramCode": "Code7890",
                "TravelAgencyCode": "ABCD1234",
                "TravelAgencyName": "TestTravel",
                "TollFreePhoneNumber": "8005555555",
                "FacilityPhoneNumber": "8005555555",
                "Remarks": "Test remark",
                "Room": [
                    {
                        "ArrivalDate": "2027-11-25",
                        "DepartureDate": "2027-11-28",
                        "NumberOfRoomNights": 3,
                        "NumberOfAdults": 2,
                        "RoomLocation": "Oceanview123",
                        "BedType": "Queen",
                        "RoomType": "Deluxe",
                        "SmokingAllowed": false,
                        "RoomRateType": "AAA",
                        "RoomRateAmount": "295.00",
                        "RoomTaxAmount": [
                            {
                                "TaxTypeIdentifier": "state-sales-tax",
                                "TaxID": "123456789012345",
                                "TaxAmount": "46.40",
                                "TaxExempt": false,
                                "TaxRate": "0.10",
                                "TaxTreatment": "net-price-with-tax-at-invoice-level",
                                "TaxDiscountTreatment": "tax-calculated-post-discount"
                            }
                        ],
                        "PromotionalCode": [
                            {
                                "PromotionStartDate": "2027-08-07T00:00:00",
                                "PromotionEndDate": "2027-12-31T00:00:00",
                                "PromotionalCode": "AUG10TIME"
                            }
                        ],
                        "AdditionalCoupon": [
                            {
                                "PromotionStartDate": "2027-08-07T00:00:00",
                                "PromotionEndDate": "2027-12-31T00:00:00",
                                "PromotionalCode": "FREE-MOVIE"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "TransactionEntry": {
        "Device": "Test JSON",
        "DeviceVersion": "0.0",
        "Application": "PNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-01T12:01:01"
    }
}'

🔷 No Show with prepay and promotional codes, capturing less than the original amount ​

The following workflow records a generic lodging stay where the customer did not show up for their stay:

1. Authorization with prepay and promotional codes; without extra charges ​

Authorization
sh
URL=https://api.qa.paynetworx.net/v0/transaction/auth
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": "638.00",
        "Fee": "5.50",
        "Tax": "46.40",
        "Currency": "USD"
    },
    "PaymentMethod": {
        "Card": {
            "Track2": {
                "Track2": ";6011492100001000=3112901?"
            }
        }
    },
    "Attributes": {
        "EntryMode": "magstripe",
        "ProcessingSpecifiers": {
            "InitiatedByPOS": true
        }
    },
    "Detail": {
        "Lodging": [
            {
                "FolioNumber": "Folio12345",
                "NumberOfRoomsBooked": 1,
                "Room": [
                    {
                        "ArrivalDate": "2027-11-25",
                        "DepartureDate": "2027-11-28",
                        "NumberOfRoomNights": 3,
                        "NumberOfAdults": 2,
                        "RoomLocation": "Oceanview123",
                        "BedType": "Queen",
                        "RoomType": "Deluxe",
                        "SmokingAllowed": false,
                        "RoomRateType": "AAA",
                        "RoomRateAmount": "295.00",
                        "RoomTaxAmount": [
                            {
                                "TaxTypeIdentifier": "state-sales-tax",
                                "TaxID": "123456789012345",
                                "TaxAmount": "46.40",
                                "TaxExempt": false,
                                "TaxRate": "0.10",
                                "TaxTreatment": "net-price-with-tax-at-invoice-level",
                                "TaxDiscountTreatment": "tax-calculated-post-discount"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "TransactionEntry": {
        "Device": "Test JSON",
        "DeviceVersion": "0.0",
        "Application": "PNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-01T12:01:01"
    }
}'

2. Capture the prepay and promotional codes with No Show; less than the original prepaid amount ​

Capture
sh
URL=https://api.qa.paynetworx.net/v0/transaction/capture
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "Amount": {
        "Total": "100.00",
        "Fee": "3.20",
        "Tax": "7.90",
        "Currency": "USD"
    },
    "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
    "Detail": {
        "Lodging": [
            {
                "FolioNumber": "Folio12345",
                "NumberOfRoomsBooked": 2,
                "ExtraChargesTotalAmount": 41.00,
                "PostCheckoutAdjustmentAmount": 2.00,
                "PrepaidAmount": 100.00,
                "TaxDetail": [
                    {
                        "TaxTypeIdentifier": "state-sales-tax",
                        "TaxID": "123456789012345",
                        "TaxAmount": "7.90",
                        "TaxExempt": false,
                        "TaxRate": "0.10",
                        "TaxTreatment": "net-price-with-tax-at-invoice-level",
                        "TaxDiscountTreatment": "tax-calculated-post-discount"
                    }
                ],
                "NoShowIndicator": true,
                "ProgramCode": "Code7890",
                "TravelAgencyCode": "ABCD1234",
                "TravelAgencyName": "TestTravel",
                "TollFreePhoneNumber": "8005555555",
                "FacilityPhoneNumber": "8005555555",
                "Remarks": "Test remark",
                "Room": [
                    {
                        "ArrivalDate": "2027-11-25",
                        "DepartureDate": "2027-11-28",
                        "NumberOfRoomNights": 3,
                        "NumberOfAdults": 2,
                        "RoomLocation": "Oceanview123",
                        "BedType": "Queen",
                        "RoomType": "Deluxe",
                        "SmokingAllowed": false,
                        "RoomRateType": "AAA",
                        "RoomRateAmount": "295.00",
                        "RoomTaxAmount": [
                            {
                                "TaxTypeIdentifier": "state-sales-tax",
                                "TaxID": "123456789012345",
                                "TaxAmount": "46.40",
                                "TaxExempt": false,
                                "TaxRate": "0.10",
                                "TaxTreatment": "net-price-with-tax-at-invoice-level",
                                "TaxDiscountTreatment": "tax-calculated-post-discount"
                            }
                        ],
                        "PromotionalCode": [
                            {
                                "PromotionStartDate": "2027-08-07T00:00:00",
                                "PromotionEndDate": "2027-12-31T00:00:00",
                                "PromotionalCode": "AUG10TIME"
                            }
                        ],
                        "AdditionalCoupon": [
                            {
                                "PromotionStartDate": "2027-08-07T00:00:00",
                                "PromotionEndDate": "2027-12-31T00:00:00",
                                "PromotionalCode": "FREE-MOVIE"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "TransactionEntry": {
        "Device": "Test JSON",
        "DeviceVersion": "0.0",
        "Application": "PNXApp-V1",
        "ApplicationVersion": "0.0",
        "Timestamp": "2026-08-01T12:01:01"
    }
}'