Chilkat Online Tools

phpAx / ORACLE Hospitality OPERA Cloud REST API Workflows / 17. Check-Out - postBillingPayment

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "criteria": {
//     "overrideInsufficientCC": false,
//     "applyCCSurcharge": false,
//     "vATOffset": false,
//     "reservationId": {
//       "idContext": "OPERA",
//       "id": 123,
//       "type": "Reservation"
//     },
//     "paymentMethod": {
//       "paymentMethod": "CA"
//     },
//     "postingReference": "CA Posting - Window 1",
//     "postingAmount": {
//       "amount": 175,
//       "currencyCode": "USD"
//     },
//     "cashierId": 3,
//     "hotelId": "{{HotelId}}",
//     "folioWindowNo": "1",
//     "overrideARCreditLimit": false
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateBool('criteria.overrideInsufficientCC',0);
$json->UpdateBool('criteria.applyCCSurcharge',0);
$json->UpdateBool('criteria.vATOffset',0);
$json->UpdateString('criteria.reservationId.idContext','OPERA');
$json->UpdateInt('criteria.reservationId.id',123);
$json->UpdateString('criteria.reservationId.type','Reservation');
$json->UpdateString('criteria.paymentMethod.paymentMethod','CA');
$json->UpdateString('criteria.postingReference','CA Posting - Window 1');
$json->UpdateInt('criteria.postingAmount.amount',175);
$json->UpdateString('criteria.postingAmount.currencyCode','USD');
$json->UpdateInt('criteria.cashierId',3);
$json->UpdateString('criteria.hotelId','{{HotelId}}');
$json->UpdateString('criteria.folioWindowNo','1');
$json->UpdateBool('criteria.overrideARCreditLimit',0);

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('x-hotelid','{{HotelId}}');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('x-app-key','{{AppKey}}');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/payments','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "x-hotelid: {{HotelId}}"
	-H "x-app-key: {{AppKey}}"
	-d '{
  "criteria": {
    "overrideInsufficientCC": false,
    "applyCCSurcharge": false,
    "vATOffset": false,
    "reservationId": {
      "idContext": "OPERA",
      "id": {{ReservationId}},
      "type": "Reservation"
    },
    "paymentMethod": {
      "paymentMethod": "CA"
    },
    "postingReference": "CA Posting - Window 1",
    "postingAmount": {
      "amount": 175,
      "currencyCode": "USD"
    },
    "cashierId": 3,
    "hotelId": "{{HotelId}}",
    "folioWindowNo": "1",
    "overrideARCreditLimit": false
  }
}'
https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/payments

Postman Collection Item JSON

{
  "name": "17. Check-Out - postBillingPayment",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{Token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "x-hotelid",
        "type": "text",
        "value": "{{HotelId}}"
      },
      {
        "key": "x-app-key",
        "value": "{{AppKey}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n  \"criteria\": {\r\n    \"overrideInsufficientCC\": false,\r\n    \"applyCCSurcharge\": false,\r\n    \"vATOffset\": false,\r\n    \"reservationId\": {\r\n      \"idContext\": \"OPERA\",\r\n      \"id\": {{ReservationId}},\r\n      \"type\": \"Reservation\"\r\n    },\r\n    \"paymentMethod\": {\r\n      \"paymentMethod\": \"CA\"\r\n    },\r\n    \"postingReference\": \"CA Posting - Window 1\",\r\n    \"postingAmount\": {\r\n      \"amount\": 175,\r\n      \"currencyCode\": \"USD\"\r\n    },\r\n    \"cashierId\": 3,\r\n    \"hotelId\": \"{{HotelId}}\",\r\n    \"folioWindowNo\": \"1\",\r\n    \"overrideARCreditLimit\": false\r\n  }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{HostName}}/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/payments",
      "host": [
        "{{HostName}}"
      ],
      "path": [
        "csh",
        "v0",
        "hotels",
        "{{HotelId}}",
        "reservations",
        "{{ReservationId}}",
        "payments"
      ]
    }
  },
  "response": [
  ]
}