PaymentMethod
A form of procedure for the payment of goods or services, plus any transactional information specific to the payment method other than the amount.
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
accountableDoc |
A Form of payment which utilizes a previously issued accountable travel document (ticket, EMD, coupon, etc.) which has an outstanding credit value. |
AccountableDoc |
false |
|
|
false |
bankTransfer |
A Bank Account payment method definition. Customer bank accounts for payments, either for paper checks or electronic funds transfer. |
BankTransfer |
false |
|
|
false |
carrierFee |
A Carrier imposed fee detail, typically related to booking, ticketing, or servicing. |
CarrierFee |
true |
|
|
false |
cash |
A payment that is collected by the agent and settled between the Airline and the agent. Refer to IATA Resolution 728 Attachment A for full details. |
Cash |
true |
|
|
false |
check |
A written order instructing a financial institution to pay immediately on demand a specified amount of money from the check writer's account to the person named on the check or, if a specific person is not named, to whoever bears the check to the institution for payment. |
Check |
false |
|
|
false |
commitmentToPay |
A commitment to settle a transaction through monetary or other compensations. This is the trigger to request clearance and it refers to the commitment to make payment within the agreement. |
array |
true |
CommitmentToPay |
--- |
false |
directBill |
A system in which a corporation's travel agency bills employees for their business travel. The employee must then submit an expense accounting and be reimbursed by the corporation. |
DirectBill |
false |
|
|
false |
eWallet |
A payment that is facilitated through virtual wallet, where the paying party has deposited funds and the payee is receiving the payment from the wallet rather than the party committing to the payment. |
EWallet |
true |
|
|
false |
iataEasyPay |
An IATA EasyPay is a payment instrument with a specific remittance mechanism. This FOP is not limited to BSP. |
IataEasyPay |
false |
|
|
false |
loyaltyRedemption |
A form of payment by which the customer uses a virtual currency of a Loyalty Program Account (such as air miles) in exchange for goods or services. |
LoyaltyRedemption |
false |
|
|
false |
otherPaymentMethod |
A non-standard form of payment which may be used in exchange for goods or services. |
OtherPaymentMethod |
false |
|
|
false |
paymentCard |
A device that enables its owner (the cardholder) to make a payment by electronic funds transfer. |
PaymentCard |
false |
|
|
false |
paymentInfo |
An information related to the settlement of a transaction through monetary or other compensations. For example, a payment may be applied to an entire Order or individual Order Items. |
PaymentInfo |
true |
|
|
false |
shoppingCriteria |
A set of criteria which qualifies the flight request by influencing which results are returned in the shopping response, including preferred or required criteria. |
ShoppingCriteria |
true |
|
|
false |
typeCode |
The payment method type. Examples: Credit Card, Cash. |
PaymentMethodCode |
false |
|
|
false |
voucher |
A document that entitles the holder to a discount or that may be exchanged for goods or services. |
Voucher |
false |
|
|
false |
{
"accountableDoc" : {
"docTypeText" : "string",
"paymentMethod" : { },
"ticketIdentifier" : "string"
},
"bankTransfer" : {
"accountTypeText" : "string",
"bankAccountIdentifier" : "string",
"bankIdentifier" : "string",
"checkNumber" : "number",
"ownerName" : "string",
"paymentMethod" : { },
"subCode" : "string"
},
"carrierFee" : {
"amount" : { },
"appCode" : "string",
"carrier" : { },
"fareComponent" : [ { } ],
"originDest" : { },
"paymentMethod" : { },
"rbdCode" : { },
"reportingCodeText" : "string",
"taxSummary" : { },
"ticketDocInfo" : { },
"typeCode" : "string"
},
"cash" : {
"collectionAddress" : { },
"commitmentToPay" : { },
"receiptIdentifier" : "string",
"settlementData" : { },
"terminalIdentifier" : "string",
"travelAgent" : { }
},
"check" : {
"checkNumber" : "number",
"payeeName" : "string",
"paymentMethod" : { },
"signedDate" : "string"
},
"commitmentToPay" : [ {
"agreement" : { },
"clearance" : { },
"commitmentIdentifier" : "string",
"paymentCommitmentDateTime" : "string",
"paymentMethod" : { },
"typeCode" : { }
} ],
"directBill" : {
"orgIdentifier" : "string",
"orgName" : "string",
"payerContact" : { },
"paymentMethod" : { }
},
"ewallet" : {
"authorizationIdentifier" : "string",
"commitmentToPay" : { },
"iataEasyPay" : { }
},
"iataEasyPay" : {
"accountNumber" : "number",
"approvalCode" : "string",
"ewallet" : { },
"expirationDateText" : "string",
"iataEasyPayEncryptedData" : { },
"paymentMethod" : { },
"paymentMethodCriteria" : { },
"settlementData" : { }
},
"loyaltyRedemption" : {
"certificateNumber" : "number",
"loyaltyCurAmount" : { },
"loyaltyProgramAccount" : { },
"paymentMethod" : { }
},
"otherPaymentMethod" : {
"paymentMethod" : { },
"remark" : [ { } ]
},
"paymentCard" : {
"approvalTypeCode" : { },
"cardBrandCode" : { },
"cardHolderContactInfo" : { },
"cardIssuerName" : "string",
"cardNumber" : "string",
"cardProductTypeCode" : "string",
"cardSecurityCode" : "string",
"cardSeqNumber" : "number",
"cardTypeText" : "string",
"creditCardIssuerCode" : { },
"effectiveDate" : "string",
"expirationDate" : "string",
"payer" : { },
"paymentMethod" : { },
"protectedCardIdentifier" : "string",
"reconciliationIdentifier" : "string",
"securePayerAuthentication" : { },
"securePayerAuthenticationInstructions" : { },
"secureProgram" : { },
"sellerOwnCardInd" : "boolean"
},
"paymentInfo" : {
"amount" : { },
"merchantAccount" : { },
"order" : { },
"orderItem" : { },
"payer" : { },
"payerContact" : { },
"paymentInfoIdentifier" : "string",
"paymentMethod" : { },
"paymentRefIdentifier" : "string",
"paymentStatusCode" : { },
"paymentTrx" : { },
"priceVarianceAmount" : { },
"priceVarianceRule" : { },
"promotion" : [ { } ],
"surchargeAmount" : { },
"ticketDocInfo" : { },
"typeCode" : { },
"verificationInd" : "boolean"
},
"shoppingCriteria" : {
"allianceCriteria" : { },
"baggagePricingCriteria" : { },
"cabinTypeCriteria" : { },
"connectionCriteria" : { },
"existingOrderCriteria" : { },
"fareCriteria" : [ { } ],
"flightCriteria" : { },
"fopCriteria" : [ { } ],
"paymentCardCriteria" : [ { } ],
"programCriteria" : [ { } ],
"promotionCriteria" : { },
"seatCriteria" : [ { } ],
"serviceCriteria" : { },
"specialNeedsCriteria" : { },
"tripPurposeCode" : { }
},
"typeCode" : {
"paymentMethodCodeEnum" : { }
},
"voucher" : {
"effectiveDate" : "string",
"expirationDate" : "string",
"paymentMethod" : { },
"remainingAmount" : { },
"voucherIdentifier" : "string"
}
}