PaymentAgreementApiRepository Protocol Reference


                    
                    
                    create(paymentAgreementRequest:completion:)

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.

Declaration

Swift

func create(
	paymentAgreementRequest: DigitalPayCreatePaymentAgreementRequest,
	completion: @escaping ApiCompletion<DigitalPayPaymentAgreementResponse>
)

Parameters


                                paymentAgreementRequest

detail of payment agreement to be created


                    
                    
                    update(paymentToken:paymentAgreementRequest:completion:)

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

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

Declaration

Swift

func update(
	paymentToken: String,
	paymentAgreementRequest: DigitalPayUpdatePaymentAgreementRequest,
	completion: @escaping ApiCompletion<DigitalPayPaymentAgreementResponse>
)

Parameters

`paymentToken`	The payment agreement to update
`paymentAgreementRequest`	detail of payment agreement to be updated


                    
                    
                    charge(chargeRequest:completion:)

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.

Declaration

Swift

func charge(
	chargeRequest: DigitalPayChargePaymentAgreementRequest,
	completion: @escaping ApiCompletion<DigitalPayPaymentAgreementResponse>
)

Parameters


                                chargeRequest

detail of payment agreement to be charged


                    
                    
                    delete(paymentToken:completion:)

Delete an existing payment agreement.

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

Declaration

Swift

func delete(paymentToken: String, completion: @escaping ApiCompletion<Void>)

Parameters


                                paymentToken

The payment agreement to delete