Newer Version Available

This content describes an older version of this product. View Latest

Sending Transaction Information with TransactionParameter

The transaction parameter class represents a list of transaction field values that Salesforce Billing sends to the payment gateway package. You can set the class’s attributes through Salesforce Billing global API, the Payment Center, or a payment run.

For complete reference information on the TransactionParameter class’s methods and parameters, review TransactionParameter Class.

This table shows how to set TransactionParameter’s attributes for transactions made through Salesforce Billing Global API, the Payment Center, or payment runs. Billing Global API attributes are optional unless otherwise indicated.

TransactionParameter Attribute Source: Billing Global API Source: Payment Center Source: Payment Run
PaymentMethod setPaymentMethod(paymentMethod) Set by the Billing package. Set by the Billing package.
Invoice setInvoice(invoice)

Required for sending L2 and L3 parameters when making a payment against an invoice.

Set by the Billing package for payments made against an invoice. Set by the Billing package for all payments.
InvoiceLine setInvoiceLine(line)

Sets a list of invoice lines. Required for sending L2 and L3 parameters when making a payment against one or more invoice lines.

Set by the Billing package for payments made against an invoice line. Not set.
Account setAccount(accountInstance) Set by the Billing package. Set by the Billing package.
RequestBody setRequestBody(requestBody) Set by the payment gateway package. Contains the request sent to the gateway. Set by the payment gateway package. Contains the request sent to the gateway.
FirstName setFirstName(firstName) Set by the Billing package. Set by the Billing packag.e
LastName setLastName(lastName) Set by the Billing package. Set by the Billing package.
EmailId setEmailId(emailId) Set by the Billing package. Set by the Billing package.
Street setStreet(street) Set by the Billing package. Set by the Billing package.
City setCity(city) Set by the Billing package. Set by the Billing package.
State setState(state) Set by the Billing package. Set by the Billing package.
ZIP code setZipCode(zipCode) Set by the Billing package. Set by the Billing package.
Country setCountry(country) Set by the Billing package. Set by the Billing package.
Phone setPhone(phone) Set by the Billing package. Set by the Billing package.
Amount setAmount(amount) Set by the Billing package. Set by the Billing package.
Transaction Not set Not set Set by the Billing package.
RequestingInvoiceId setRequestingInvoiceId(requestingInvoiceId) Set by the Billing package for L2 and L3 parameters. Set by the Billing package for L2 and L3 parameters.
CardCodeResponse setCardCodeResponse

Required only for reference refund transactions made through Payeezy.

Set by the Billing package for reference refunds made through Payeezy. Not set
MerchantId setMerchantId() Set by the Billing package for reference refunds made through Payeezy. Not set
GatewayId setGateway(gateway)

Sets the transaction ID for the payment. Required only for reference refund transactions.

Required to set by caller for Reference Refund transaction. It is transaction id for the payment.
Set by the Billing package as Gateway reference ID for payment. Used in reference refund transactions. Not set
CurrencyId setCurrencyId(currencyId)

Set only for transactions made through Payeezy.

Set only for transactions made through Payeezy. Set only for transactions made through Payeezy.
Gateway setGateway(gateway)

Required. Contains the ID of the Salesforce Billing payment gateway record used in the transaction.

Set by the Billing package. Set by the Billing package.
ResponseValueByKey Not set Not set. NA
Payment setPayment(paymentInstance)Required to set when calling refundTransaction. Must query all fields from the payment instance except system fields. Set by the Billing package when RefundTransaction is called. Must query all fields from the payment instance except system fields. NA

Example