-
Returns a list of payment providers
Declaration
Swift
public func paymentProviders(completion: @escaping CompletionResult<PaymentProviders>)
Parameters
completion
A completion callback, returning the payment list on success
-
Returns a payment provider
Declaration
Swift
public func paymentProvider(id: String, completion: @escaping CompletionResult<PaymentProvider>)
Parameters
id
The the payment provider’s unique identifier
completion
A completion callback, returning the payment provider on success
-
createPaymentRequest(sourceDocumentLocation:paymentProvider:recipient:iban:bic:amount:purpose:completion:)
Creates a payment request
Declaration
Swift
public func createPaymentRequest(sourceDocumentLocation: String?, paymentProvider: String, recipient: String, iban: String, bic: String?, amount: String, purpose: String, completion: @escaping CompletionResult<String>)
Parameters
sourceDocumentLocation
The URI of the source document whenever the payment details were extracted by the Gini system beforehand (optional)
paymentProvider
The id of the target payment provider - see payment providers
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 payment request on success
-
Returns a payment request
Declaration
Swift
public func paymentRequest(id: String, completion: @escaping CompletionResult<PaymentRequest>)
Parameters
id
The the payment request’s unique identifier
completion
A completion callback, returning the payment request on success
-
Returns a list of payment requests
Declaration
Swift
public func paymentRequests(limit: Int? = 20, offset: Int? = 0, 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
public func resolvePaymentRequest(id: String, recipient: String, iban: String, bic: String? = nil, 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
public 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
-
Undocumented
Declaration
Swift
public var apiDomain: APIDomain
-
Undocumented
Declaration
Swift
func paymentProviders(resourceHandler: ResourceDataHandler<APIResource<PaymentProviders>>, completion: @escaping CompletionResult<PaymentProviders>)
-
Undocumented
Declaration
Swift
func paymentProvider(id: String, resourceHandler: ResourceDataHandler<APIResource<PaymentProvider>>, completion: @escaping CompletionResult<PaymentProvider>)
-
Undocumented
Declaration
Swift
func createPaymentRequest(paymentRequestBody: PaymentRequestBody, resourceHandler: ResourceDataHandler<APIResource<String>>, completion: @escaping CompletionResult<String>)
-
Undocumented
Declaration
Swift
func paymentRequest(id: String, resourceHandler: ResourceDataHandler<APIResource<PaymentRequest>>, completion: @escaping CompletionResult<PaymentRequest>)
-
Undocumented
Declaration
Swift
func paymentRequests(limit: Int?, offset: Int?, resourceHandler: ResourceDataHandler<APIResource<PaymentRequests>>, completion: @escaping CompletionResult<PaymentRequests>)
-
Undocumented
Declaration
Swift
func resolvePaymentRequest(id: String, resolvingPaymentRequestBody: ResolvingPaymentRequestBody, resourceHandler: ResourceDataHandler<APIResource<ResolvedPaymentRequest>>, completion: @escaping CompletionResult<ResolvedPaymentRequest>)
-
Undocumented
Declaration
Swift
func payment(id: String, resourceHandler: ResourceDataHandler<APIResource<Payment>>, completion: @escaping CompletionResult<Payment>)