paymentDetails

paymentDetails is a  list of payments made for the cart. This only applies for payments which are incomplete. A complete payment converts the cart to an order so it can no longer be retrieved by view cart. Only vouchers can be used for partial payment. Each voucher payment is represented by a payment detail.

Field ID Description Type Occurrence
paymentDetails Payment details paymentDetail

Complex Type

0..*

paymentDetail

A single payment

Field ID Description Type Occurrence
paymentType Payment type String
paymentTypeDesc Payment type description String
paymentReceiptAmount Payment receipt amount Decimal
paymentBankCode Payment bank code String
paymentTransactionId Payment transaction ID String
paymentPreauthorisedFlag Payment pre-authorised flag Boolean
paymentFields Payment fields paymentFields

Complex Type

0.11

paymentFields

This object represents a list of required fields for a payment type (dependent on IP1 configuration). For example, payment by credit card will require the following fields:

  • credit card number
  • credit card name
  • Amount
Field ID Description Type Occurrence
paymentField Payment field paymentField

Complex Type

0..*

paymentField

Field ID Description Type Occurrence
paymentFieldId Payment field ID String 0..1
paymentFieldDesc Payment field description String 0..1
paymentFieldVal Payment field value String 0..1