PaymentAPI::EnrichWithExplainedPayments (open)

Enrich an array with payment explanations

Syntax

LOADLIB "mod::wrd/lib/payments.whlib";

RECORD ARRAY FUNCTION EnrichWithExplainedPayments(RECORD ARRAY payments, RECORD options)

Parameters

RECORD ARRAY payments

List contanining payments

RECORD options

Options

STRING cellname

Cell containing the payment information (defaults to the payment attribute)

STRING explaincell

Cell in which to store explained cells. If not set, explanation will be merged into the records.

Return value

RECORD ARRAY

Payment information

MONEY amountpayable

The total amount that had to be paid

STRING cardnumber

Card or account number

STRING htmlstatusforuser

Rich additional description as passed by the payment provider

DATETIME paymentdate
STRING paymentmethodtag
STRING paymentmethodtitle

Title for the selected payment method

STRING paymentref
STRING status

Current status (approved, pending, failed)