Package-level declarations

Types

Link copied to clipboard
data class GetPurchaseOrdersParameters(val limit: Int? = null, val offset: Int? = null, val merchantRefNum: String? = null, val serviceCode: String? = null, val slipId: String? = null, val status: PaymentStatus? = null)

Data class containing the optional filters when retrieving purchase orders.

Link copied to clipboard
data class PaymentFunding(val wallet: WalletFunding, val discounts: List<DiscountOption>?)

Data class representing the payment funding distribution attached to a purchase order.

Link copied to clipboard
data class PurchaseOrder(val id: String, val amount: Long, val currencyCode: String, val recipient: PurchaseOrderRecipient, val merchantRefNum: String, val paymentFunding: PaymentFunding?, val fees: List<SimpleFeePayment>?, val creationTime: Calendar, val expirationTime: Calendar, val status: PaymentStatus, val statusReason: String?, val slipId: String?, val nextStatus: List<PaymentStatus>, val action: PaymentCompletionAction?, val scaDetails: ScaAuthenticationEventResponse?, val discountDetails: DiscountDetails?, val purchaseOrderDetails: PurchaseOrderDetails)

Data class representing a Purchase Order returned across preview, pending, processing, and completed phases.

Link copied to clipboard

Enum class representing a purchase order category.

Link copied to clipboard
data class PurchaseOrderConfirm(val scaDetails: ScaAuthenticationEventRequest?, val paymentProperties: List<PaymentProperty>?)

Data class representing a Purchase Order confirm request body, transitioning a purchase order from PENDING to PROCESSING.

Link copied to clipboard
data class PurchaseOrderCreate(val discounts: List<DiscountOption>?, val paymentProperties: List<PaymentProperty>?)

Data class representing a Purchase Order create request body, transitioning a purchase order from PREVIEW to PENDING.

Link copied to clipboard
data class PurchaseOrderDetails(val serviceCode: String, val provider: PurchaseOrderProvider, val category: PurchaseOrderCategory, val description: String? = null, val creationTime: Calendar? = null, val expirationTime: Calendar? = null)

Data class describing the external purchase order.

Link copied to clipboard
data class PurchaseOrderList(val purchaseOrders: List<PurchaseOrder>, val meta: PagingResultMeta?)

Data class containing a list of purchase orders for the current customer and metadata for paginated results.

Link copied to clipboard

Enum class identifying the external partner system that originated the purchase order (for example the upstream checkout or bill-pay channel).

Link copied to clipboard
data class PurchaseOrderRecipient(val externalId: String?, val fullName: String?, val type: PurchaseOrderRecipientType?)

Data class representing the payee presented to the customer for an external purchase order.

Link copied to clipboard

Enum class representing the PurchaseOrderRecipient classification used for display.

Link copied to clipboard
data class PurchaseOrderRequest(val purchaseOrderDetails: PurchaseOrderDetails)

Data class representing the request body for a purchase order preview.

Link copied to clipboard
data class WalletFunding(val amount: Long, val currencyCode: String)

Data class representing the wallet funding part of a payment when initiating a purchase order.