PaymentServiceProtocol

public protocol PaymentServiceProtocol : AnyObject

Undocumented

  • Returns a payment request.

    Declaration

    Swift

    func paymentRequest(id: String,
                    completion: @escaping CompletionResult<PaymentRequest>)

    Parameters

    id

    The id of the payment request
    completion

    A completion callback, returning the payment request on success

  • Returns a list of payment requests.

    Declaration

    Swift

    func paymentRequests(limit: Int?,
                     offset: Int?,
                     completion: @escaping CompletionResult<PaymentRequests>)

    Parameters

    limit

    The maximum number of payment requests to return (default 20), (optional)
    offset

    A starting offset (default 0), (optional)
    completion

    A completion callback, returning the request list on success

  • Resolves a payment request. A payment is sent by a payment provider in order to resolve a payment request after it was paid.

    Declaration

    Swift

    func resolvePaymentRequest(id: String,
                           recipient: String,
                           iban: String,
                           bic: String?,
                           amount: String,
                           purpose: String,
                           completion: @escaping CompletionResult<ResolvedPaymentRequest>)

    Parameters

    recipient

    The recipient of the payment
    iban

    The iban (international bank account number) of the payment recipient
    bic

    The bic (bank identifier code) for the payment
    amount

    The amount of the paymentt
    purpose

    The purpose of the payment, eg. the invoice or the customer identifier
    completion

    A completion callback, returning the resolved payment request structure on success

  • Returns a payment.

    Declaration

    Swift

    func payment(id: String,
             completion: @escaping CompletionResult<Payment>)

    Parameters

    id

    The the payment request’s unique identifier
    completion

    A completion callback, returning the payment on success