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.
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
agreement |
A record of agreement between parties for exchange of value under specified terms and conditions. |
Agreement |
true |
|
|
false |
clearance |
A delivery of funds from one party - payer- to another party - the payee - to fulfill contractual obligations, i.e. commitment between the two parties. |
Clearance |
true |
|
|
false |
commitmentIdentifier |
this is the identifier of the payment commitment within the agreement. In One Order and NDC this is the 'PaymentInfoID' |
string |
true |
|
|
false |
paymentCommitmentDateTime |
defines the date when the PaymentProcessingSummary, with information about amount and payment method, is accepted by ORA to be sufficient to lead to successful payment. This is the date when the status in the PaymentStatusCode is set to SUCCESSFUL |
string |
true |
|
|
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 |
true |
|
|
false |
typeCode |
this is the payment method type agreed between the two parties in the clearance request, which will be used for the transfer of funds. Currently this method can be either Cash or eWallet. |
PaymentMethodCode |
true |
|
|
false |
{
"agreement" : {
"agreementIdentifier" : "string",
"commitmentToPay" : [ { } ]
},
"clearance" : {
"airlineRefIdentifier" : "string",
"carrier" : { },
"clearanceIdentifier" : "string",
"clearancePayeeReconciliationIdentifier" : "string",
"clearancePayerReconciliationIdentifier" : "string",
"commitmentToPay" : { },
"failureReasonCode" : "string",
"nonSettledAmount" : { },
"org" : { },
"payee" : { },
"processingInstructions" : { },
"processRuleCode" : "string",
"remainingAmount" : { },
"settlementDate" : "string",
"statusCode" : { },
"travelAgency" : { }
},
"commitmentIdentifier" : "string",
"paymentCommitmentDateTime" : "string",
"paymentMethod" : {
"accountableDoc" : { },
"bankTransfer" : { },
"carrierFee" : { },
"cash" : { },
"check" : { },
"commitmentToPay" : [ { } ],
"directBill" : { },
"ewallet" : { },
"iataEasyPay" : { },
"loyaltyRedemption" : { },
"otherPaymentMethod" : { },
"paymentCard" : { },
"paymentInfo" : { },
"shoppingCriteria" : { },
"typeCode" : { },
"voucher" : { }
},
"typeCode" : {
"paymentMethodCodeEnum" : { }
}
}