Chilkat Online Tools

Objective-C / ORACLE Hospitality OPERA Cloud REST API Workflows / Add a Payment to the Folio

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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": 429,
//       "currencyCode": "USD"
//     },
//     "cashierId": 4,
//     "hotelId": "{{HotelId}}",
//     "folioWindowNo": "1",
//     "overrideARCreditLimit": false
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateBool: @"criteria.overrideInsufficientCC" value: NO];
[json UpdateBool: @"criteria.applyCCSurcharge" value: NO];
[json UpdateBool: @"criteria.vATOffset" value: NO];
[json UpdateString: @"criteria.reservationId.idContext" value: @"OPERA"];
[json UpdateInt: @"criteria.reservationId.id" value: [NSNumber numberWithInt: 123]];
[json UpdateString: @"criteria.reservationId.type" value: @"Reservation"];
[json UpdateString: @"criteria.paymentMethod.paymentMethod" value: @"CA"];
[json UpdateString: @"criteria.postingReference" value: @"CA Posting - Window 1"];
[json UpdateInt: @"criteria.postingAmount.amount" value: [NSNumber numberWithInt: 429]];
[json UpdateString: @"criteria.postingAmount.currencyCode" value: @"USD"];
[json UpdateInt: @"criteria.cashierId" value: [NSNumber numberWithInt: 4]];
[json UpdateString: @"criteria.hotelId" value: @"{{HotelId}}"];
[json UpdateString: @"criteria.folioWindowNo" value: @"1"];
[json UpdateBool: @"criteria.overrideARCreditLimit" value: NO];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"x-hotelid" value: @"{{HotelId}}"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"x-app-key" value: @"{{AppKey}}"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/payments" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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": 429,
            "currencyCode": "USD"
        },
        "cashierId": 4,
        "hotelId": "{{HotelId}}",
        "folioWindowNo": "1",
        "overrideARCreditLimit": false
    }
}'
https://domain.com/csh/v0/hotels/{{HotelId}}/reservations/{{ReservationId}}/payments

Postman Collection Item JSON

{
  "name": "Add a Payment to the Folio",
  "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\": 429,\r\n            \"currencyCode\": \"USD\"\r\n        },\r\n        \"cashierId\": 4,\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": [
  ]
}