CreateRemittanceRequest

public struct CreateRemittanceRequest : Encodable, Sendable

Create remittance transaction request model.

  • The UUID of the quote that is being used for the transaction.

    Declaration

    Swift

    public let quoteUuid: String

  • UUID of the payment method to use to fund this transaction. Is none provided, the transaction will be funded from the wallet balance

    Declaration

    Swift

    public let paymentMethodUuid: String?

  • A small description to identify the transaction.

    Declaration

    Swift

    public let description: String?

  • The unique identifier of this remittance in your own system.

    Declaration

    Swift

    public let externalId: String?

  • The purpose of the transaction.

    Declaration

    Swift

    public let transactionPurpose: String?

  • The source of funds for the transaction.

    Declaration

    Swift

    public let sourceOfFunds: TransactionSourceOfFunds?

  • If the transaction is to be funded with cash.

    Declaration

    Swift

    public let fundingMethod: String?

  • Allows for any number of custom metadata keys and values to be stored with a given transaction.

    Declaration

    Swift

    public let metadata: [String : CustomValue]?

  • Auxiliary constructor.

    Declaration

    Swift

    public init(quoteUuid: String,
            description: String? = nil,
            paymentMethodUuid: String? = nil,
            externalId: String? = nil,
            transactionPurpose: String? = nil,
            sourceOfFunds: TransactionSourceOfFunds? = nil,
            fundingMethod: String? = nil,
            metadata: [String: CustomValue]? = nil)

    Parameters

    quoteUuid

    The UUID of the quote that is being used for the transaction.
    description

    A small description to identify the transaction.
    paymentMethodUuid

    UUID of the payment method to use to fund this transaction. Is none provided, the transaction will be funded from the wallet balance
    externalId

    The unique identifier of this remittance in your own system.
    transactionPurpose

    The purpose of the transaction.
    sourceOfFunds

    The source of funds for the transaction.
    fundingMethod

    If the transaction is to be funded with cash.
    metadata

    Allows for any number of custom metadata keys and values to be stored with a given transaction.