View on GitHub
MerchantPaymentsRepository Protocol Reference
MerchantPaymentsRepository
public protocol MerchantPaymentsRepositoryUndocumented
-
Retrieve a list of the payments initiated by the merchant, both pending and complete
Declaration
Swift
func listPayments( type: String?, page: Int?, pageSize: Int?, completion: @escaping ApiCompletion<MerchantPaymentSummaries> )Parameters
typeThe type of payment requests to return
pageThe page of results to return with 1 indicating the first page (defaults to 1).
pageSizeThe number of records to return for this page (current default is 25)
-
Create a new payment request for a customer
Declaration
Swift
func createPaymentRequest( paymentRequest: NewPaymentRequest, completion: @escaping ApiCompletion<CreatePaymentRequestResult> )Parameters
paymentRequestThe details of the new payment request
-
Retrieve a payment request by it’s ID. The request may have been “completed” that is the customer has made a payment.
Declaration
Swift
func getPaymentRequestDetailsBy( paymentRequestId: String, completion: @escaping ApiCompletion<MerchantPaymentDetails> )Parameters
paymentRequestIdThe ID of the payment request to return.
-
Delete a payment request
Declaration
Swift
func deletePaymentRequest( paymentRequestId: String, completion: @escaping ApiCompletion<Void> )Parameters
paymentRequestIdThe payment request to delete
-
Refund a transaction to a customer
Declaration
Swift
func refundTransaction( transactionId: String, refundDetails: TransactionRefundDetails, completion: @escaping ApiCompletion<MerchantTransactionSummary> )Parameters
transactionIdThe transaction to refund.
refundDetailsThe details of the refund.