Update Form of Payment API Reference

PUT

payment/reservationworkbench/{workbenchID}/formofpayment/{FormOfPayment_Identifier}

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

For {FormOfPayment_Identifier} send the id of the form of payment to update.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Related Content: Booking Guide, Ticketing Guide

Send an Update Form of Payment (FOP) request to replace one form of payment with another FOP. Supported in the initial booking workflow for both GDS and NDC, where it updates an FOP added in the same booking workbench. Supported for an existing booking only for GDS, where it can update either the FOP stored with the booking, or an FOP sent in the same session.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Send the request payload from the Add Form Of Payment API Reference for the type of payment you want to add. Update FOP is supported for all forms of payment supported in Add FOP. For example, to update a credit card FOP to a cash FOP, send the cash FOP payload from Add FOP.

Response

A successful response returns a 204[No Content] message. There is no response message payload.

Example Request

In the endpoint, send the workbench identifier and the id of the existing FOP to update:

PUT https://api.travelport.com/11/air/payment/reservationworkbench/cfa7a3a6-fefa-47e7-87a7-5c5cbde146cf/formofpayment/formOfPayment_1

The following example payload replaces the current FOP with the cash FOP below. You can send any of the payloads in the Add Form Of Payment API Reference. 

{
	"FormOfPaymentCash": {
		"id": "formOfPayment_1",
		"FormOfPaymentRef": "formOfPayment_1",
		"agentNonRefundableInd": true,
		"Identifier": {
			"value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
			"authority": "Travelport"
		},
	}
}

Example Response

A successful response returns a 204[No Content] message. There is no response message payload.