DigitalPayCreatePaymentAgreementRequest

public protocol DigitalPayCreatePaymentAgreementRequest

The JSON request structure of the Create Payment Agreement endpoint.

  • 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.

    This property is only required if the ‘immediateCharge’ property is true.

    Declaration

    Swift

    var orderNumber: String? { get }

  • Customer billing address for this payment agreement

    Declaration

    Swift

    var billingAddress: DigitalPayAddress { get }

  • Detail of the payment agreement to be created

    Declaration

    Swift

    var paymentAgreement: DigitalPayRequestPaymentAgreement { get }

  • Digital pay fraud payload

    Declaration

    Swift

    var fraudPayload: DigitalPayFraudPayload? { get }