CustomerPaymentAgreementsApiRepository Protocol Reference


                    
                    
                    list(completion:)

Retrieve a list of customer’s [PaymentAgreement]s

Swift

func list(completion: @escaping ApiCompletion<PaymentAgreements>)


                    
                    
                    getById(paymentToken:completion:)

Retrieve a [PaymentAgreement] by its associated payment token

Swift

func getById(paymentToken: String, completion: @escaping ApiCompletion<PaymentAgreement>)


                                paymentToken

The ID.


                    
                    
                    create(paymentAgreement:completion:)

Create a [PaymentAgreement]

Swift

func create(
	paymentAgreement: CreatePaymentAgreementRequest,
	completion: @escaping ApiCompletion<PaymentAgreement>
)


                                paymentAgreement

The details for the new payment agreement


                    
                    
                    update(paymentToken:paymentAgreement:completion:)

Update a [PaymentAgreement]

Swift

func update(
	paymentToken: String,
	paymentAgreement: UpdatePaymentAgreementRequest,
	completion: @escaping ApiCompletion<PaymentAgreement>
)

`paymentToken`	The payment token to update
`paymentAgreement`	The updates to apply to the payment agreement