Source: https://guides.developer.iata.org/docs/download-the-latest-standards

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.

Properties

Name Description Type Required Generic Enum Ignore
amount The amount applied to the associated payment method. Example: 300 USD Amount false false
merchantAccount A person or company that sells goods or services. MerchantAccount false false
order A uniquely identified record of the agreement of one party with another to receive products and services under specified terms and conditions. Order supports the sale of a flexible range of airline products and services that are not necessarily Journey based (e.g. subscription services). Order false false
orderItem An individually priced item within an Order, made up of one or more Services. May or may not be a selected Offer Item (e.g. non-chargeable Services available on request such as a wheelchair). OrderItem false false
payer A role which provides Payment Card details and commits the payment for the Offer(s) they wish to purchase. The Payment can take place either before or after the Order has been created. Payer false false
payerContact An electronic or geographic address which a party has provided as the contact channel. For example, contact email, contact postal address, contact phone number. ContactInfo false false
paymentInfoIdentifier Uniquely identifies payment information within a message. string false false
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. PaymentMethod false false
paymentRefIdentifier If creating the order after payment authorization it is a way of linking an order to an existing payment reference. not triggering the whole process again. string true false
paymentStatusCode Indicates the current status of this payment information. PaymentStatusCode false false
paymentTrx A set of Additional identification and URLs used to further describe a secure payment transaction. PaymentTrx true false
priceVarianceAmount Price variance amount applied during Payment processing. Amount false false
priceVarianceRule A Price Variance rule supports specifying Payment Processing Rules, including payment failure. Acceptable amount and/or percentage of the total amount by which the Order item price can vary. Example: 20 USD, 2 Percent. PriceVarianceRule false false
promotion An Information item related to publicizing a product, organization, or venture so as to increase sales or public awareness. array false Promotion --- false
surchargeAmount Amount added to the final Offer/Order price, depending on which payment method is used by the client. Amount false false
ticketDocInfo An Information corresponding to a group of 1 to 4 Tickets for a single Origin Destination and a single Passenger. TicketDocInfo true false
typeCode The payment method type. Examples: Credit Card, Cash. PaymentMethodCode false false
verificationInd When true, this payment requires additional authentication. boolean false false
{
  "amount" : {
    "curCode" : "string",
    "value" : "number"
  },
  "merchantAccount" : {
    "carrier" : { },
    "country" : { },
    "merchantCategoryCode" : "string",
    "merchantIdentifier" : "string",
    "merchantName" : "string",
    "merchantRiskText" : "string",
    "paymentInfo" : [ { } ]
  },
  "order" : {
    "bilateralTimeLimit" : [ { } ],
    "bookingRef" : [ { } ],
    "carrier" : { },
    "commission" : [ { } ],
    "creationDateTime" : "string",
    "depositTimeLimitDateTime" : "string",
    "existingOrderCriteria" : { },
    "inventoryGuarantee" : { },
    "lastModifiedDateTime" : "string",
    "namingTimeLimitDateTime" : "string",
    "offer" : [ { } ],
    "order" : [ { } ],
    "orderIdentifier" : "string",
    "orderItem" : [ { } ],
    "ownerTypeCode" : { },
    "paxGroup" : { },
    "paymentInfo" : [ { } ],
    "paymentTimeLimitDateTime" : "string",
    "statusCode" : { },
    "ticketDocInfo" : { },
    "totalPrice" : { },
    "versionNumber" : "integer",
    "webAddressUri" : "string"
  },
  "orderItem" : {
    "alacarteofferitem" : { },
    "bilateralTimeLimit" : [ { } ],
    "cancelRestrictions" : [ { } ],
    "changeGroupIdentifier" : "string",
    "changeRestrictions" : [ { } ],
    "changeTypeText" : "string",
    "commission" : [ { } ],
    "creationDateTime" : "string",
    "depositTimeLimitDateTime" : "string",
    "disclosure" : [ { } ],
    "fareDetail" : [ { } ],
    "grandTotalAmount" : { },
    "inventoryGuaranteeIdentifier" : "string",
    "inventoryGuaranteeTimeLimitDateTime" : "string",
    "marketingCarrier" : { },
    "namingTimeLimitDateTime" : "string",
    "offerItem" : { },
    "order" : { },
    "orderItemIdentifier" : "string",
    "ownerTypeCode" : { },
    "paxGroup" : { },
    "paymentInfo" : [ { } ],
    "paymentTimeLimitDateTime" : "string",
    "penalty" : [ { } ],
    "price" : { },
    "priceGuaranteeTimeLimitDateTime" : "string",
    "reusableInd" : "boolean",
    "service" : [ { } ],
    "statusCode" : { },
    "ticketingTimeLimitDateTime" : "string",
    "typeCode" : "string",
    "webAddressUri" : "string"
  },
  "payer" : {
    "individual" : { },
    "paymentCard" : { },
    "paymentInfo" : [ { } ]
  },
  "payerContact" : {
    "aggregator" : { },
    "airline" : { },
    "carrier" : { },
    "contactInfoIdentifier" : "string",
    "contactPurposeText" : "string",
    "contactRefusedInd" : "boolean",
    "contactTypeText" : "string",
    "corporation" : { },
    "directBill" : { },
    "emailAddress" : [ { } ],
    "enabledSystem" : { },
    "individual" : { },
    "individualRefIdentifier" : "string",
    "org" : { },
    "otherAddress" : [ { } ],
    "pax" : { },
    "paxGroup" : { },
    "paymentCard" : { },
    "paymentInfo" : { },
    "phone" : [ { } ],
    "postalAddress" : [ { } ],
    "relationshipToPaxText" : "string",
    "retailPartner" : { },
    "travelAgency" : { }
  },
  "paymentInfoIdentifier" : "string",
  "paymentMethod" : {
    "accountableDoc" : { },
    "bankTransfer" : { },
    "carrierFee" : { },
    "cash" : { },
    "check" : { },
    "commitmentToPay" : [ { } ],
    "directBill" : { },
    "ewallet" : { },
    "iataEasyPay" : { },
    "loyaltyRedemption" : { },
    "otherPaymentMethod" : { },
    "paymentCard" : { },
    "paymentInfo" : { },
    "shoppingCriteria" : { },
    "typeCode" : { },
    "voucher" : { }
  },
  "paymentRefIdentifier" : "string",
  "paymentStatusCode" : {
    "paymentStatusCodeEnum" : { }
  },
  "paymentTrx" : {
    "descText" : "string",
    "device" : { },
    "inputCurCode" : { },
    "maximumTryInd" : "boolean",
    "notProcessedInd" : "boolean",
    "originalIdentifier" : "string",
    "paymentAddressVerification" : { },
    "paymentInfo" : { },
    "retryInd" : "boolean",
    "settlementCurCode" : { },
    "timestampDateTime" : "string",
    "trxDataText" : "string",
    "trxIdentifier" : "string",
    "trxTypeText" : "string"
  },
  "priceVarianceAmount" : {
    "curCode" : "string",
    "value" : "number"
  },
  "priceVarianceRule" : {
    "acceptableVarianceAmount" : { },
    "acceptableVariancePercent" : "number",
    "effectivePeriodDuration" : "string",
    "ownerName" : "string",
    "paymentInfo" : { },
    "remark" : [ { } ],
    "ruleIdentifier" : "string",
    "ruleName" : "string"
  },
  "promotion" : [ {
    "coupon" : { },
    "ownerName" : "string",
    "pax" : [ { } ],
    "paymentInfo" : { },
    "promotionIdentifier" : "string",
    "promotionIssuer" : { },
    "remark" : [ { } ],
    "shoppingCriteria" : { },
    "urlUri" : "string"
  } ],
  "surchargeAmount" : {
    "curCode" : "string",
    "value" : "number"
  },
  "ticketDocInfo" : {
    "bookingAgency" : { },
    "bookingRef" : [ { } ],
    "bookletQty" : "number",
    "carrierFee" : { },
    "commission" : { },
    "endorsementText" : "string",
    "fareDetail" : { },
    "orderAmendment" : { },
    "originalIssueInfo" : { },
    "originDest" : { },
    "pax" : { },
    "paymentInfo" : [ { } ],
    "penalty" : [ { } ],
    "pricingCountryCode" : { },
    "pricingDate" : "string",
    "pricingLocationCode" : { },
    "pricingTime" : "string",
    "referencedOrder" : { },
    "servicingAgency" : { },
    "ticket" : [ { } ],
    "ticketRefIdentification" : [ { } ]
  },
  "typeCode" : {
    "paymentMethodCodeEnum" : { }
  },
  "verificationInd" : "boolean"
}