OpenPayPaymentRequest

public protocol OpenPayPaymentRequest

The JSON request structure of the Openpay Payments endpoint

  • The container transaction type to use for openpay instruments

    Declaration

    Swift

    var transactionType: OpenPayPaymentRequestTransactionType { get }

  • A merchant application specific reference number.

    This number should uniquely identify the transaction in the merchant’s system.

    Declaration

    Swift

    var clientReference: String { get }

  • A merchant application specific reference number.

    This number should uniquely identify the customer in the merchant’s system.

    Declaration

    Swift

    var customerRef: String? { get }

  • The merchant order number of the transaction.

    Declaration

    Swift

    var orderNumber: String { get }

  • The channel from which this charge is originating, eg. Online, In-Store.

    Declaration

    Swift

    var channel: String { get }

  • The unique identifier for the merchants trading account.

    Declaration

    Swift

    var tradingAccountId: String? { get }

  • The merchants transaction date and time. The timestamp format is ISO8601.

    Declaration

    Swift

    var merchantTransactedAt: String? { get }

  • List of payments

    Declaration

    Swift

    var payments: [OpenPayPayments] { get }

  • OpenPay store data

    Declaration

    Swift

    var storeData: OpenPayStoreData { get }