PaymentAgreementApiRepository

interface PaymentAgreementApiRepository

Functions

charge
Link copied to clipboard

Perform charge transaction against a payment agreement.

This service will use the provided information to perform the charge transaction.

A charge payment is made by the merchant to charge a customer as per their payment agreement.

This API is IP restricted to allow unauthenticated server side calls.

abstract fun charge(chargeRequest: DigitalPayChargePaymentAgreementRequest): ApiResult<DigitalPayPaymentAgreementResponse>
create
Link copied to clipboard

Create a new payment agreement which will be added to the users wallet after validating the payment instrument.

This API is IP restricted to allow unauthenticated server side calls.

abstract fun create(paymentAgreementRequest: DigitalPayCreatePaymentAgreementRequest): ApiResult<DigitalPayPaymentAgreementResponse>
delete
Link copied to clipboard

Delete an existing payment agreement.

This API is IP restricted to allow unauthenticated server side calls.

abstract fun delete(paymentToken: String): ApiResult<Unit>
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String
update
Link copied to clipboard

Update an existing payment agreement and validate the payment instrument if changed.

This API is IP restricted to allow unauthenticated server side calls.

abstract fun update(paymentToken: String, paymentAgreementRequest: DigitalPayUpdatePaymentAgreementRequest): ApiResult<DigitalPayPaymentAgreementResponse>