Salesforce Billing Developer Guide

Salesforce Billing Fields on Standard Objects
Salesforce Billing Custom Objects
Salesforce Billing Standard Objects
Salesforce Billing Developer Guides & Lightning Components
Salesforce Billing Payment Gateway Developer Guide
Get Started with Salesforce Billing Payment Gateway API
Payment Gateway Class Reference
CaptureInputParameter Class
CaptureOutputResult Class
Payment Gateway Core Classes
InputParameter Class
OutputResult Class
PaymentGateway Interface
PaymentGateways Interface
PaymentGatewayParameter Class
PaymentGatewayStatus Interface
TransactionAPI Class
TransactionParameter Class
TransactionParameter Methods
TransactionResult Class
TransactionResult.GatewayStatusType Enum
Custom Gateway Classes
Salesforce Billing Tax Integration Developer Guide
Revenue Recognition Service Developer Guide
Hosted Card Payments Lightning Component
REST API for Converting Invoice Lines with Negative Balances
Set Up Standalone Orders with API
Salesforce Billing Apex Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

TransactionParameter Class

Acts as a container to store calculation-specific information.

Namespace

blng

TransactionParameter Methods

The following are methods for TransactionParameter.

setRequestingInvoiceId(requestingInvoiceId)

Sets RequestingInvoiceId.

Signature

global void setRequestingInvoiceId(Id requestingInvoiceId)

Parameters

requestingInvoiceId
Type: Id

Return Value

Type: void

getRequestingInvoiceId()

Gets Requesting InvoiceId.

Signature

global Id getRequestingInvoiceId()

Return Value

Type: Id

setCardCodeResponse(cardCodeResponse)

Sets cardCodeResponse.

Signature

global void setCardCodeResponse(String cardCodeResponse)

Parameters

cardCodeResponse
Type: String

Return Value

Type: void

getCardCodeResponse()

Gets cardCodeResponse.

Signature

global String getCardCodeResponse()

Return Value

Type: String

setCardNumber(requestingCreditCardNumber)

Sets requestingCreditCardNumber.

Signature

global void setCardNumber(String requestingCreditCardNumber)

Parameters

requestingCreditCardNumber
Type: String

Return Value

Type: void

getCardNumber()

Gets requestingCreditCardNumber.

Signature

global String getCardNumber()

Return Value

Type: String

setPayment(paymentInstance)

Sets payment details like merchantRefId, RequestCreditCardNumber__c, CardCodeResponse__c, GatewayID__c. Also sets payment method details for PaymentType__c, CardExpirationYear__c, CardExpirationMonth__c, BankName__c, BankAccountType__c, BankAccountNumber__c, BankAccountName__c, CardType__c, BankRoutingCode__c if they aren't already set.

Signature

global void setPayment(Payment__c paymentInstance)

Parameters

paymentInstance
Type: Payment__c

Return Value

Type: void

getPayment()

Gets Payment.

Signature

global Payment__c getPayment()

Return Value

Type: Payment__c

getMerchantId()

Gets merchantRefId.

Signature

global String getMerchantId()

Return Value

Type: String

setMerchantId()

Sets MerchantId.

Signature

global String setMerchantId()

Return Value

Type: String

getGatewayId()

Gets Gateway ID.

Signature

global String getGatewayId()

Return Value

Type: String

getResponseValueByKey()

Gets ResponseValueByKey

Signature

global Map<String, String> getResponseValueByKey()

Return Value

Type: Map<String, String>

setGateway(gateway)

Sets Gateway ID.

Signature

global void setGateway(PaymentGateway__c gateway)

Parameters

gateway
Type: PaymentGateway__c

Return Value

Type: void

setPaymentMethod(paymentMethod)

Sets PaymentMethod.

Signature

global void setPaymentMethod(PaymentMethod__c paymentMethod)

Parameters

paymentMethod
Type: PaymentMethod__c

Return Value

Type: void

getPaymentMethod()

Gets PaymentMethod.

Signature

global PaymentMethod__c getPaymentMethod()

Return Value

Type: PaymentMethod__c

setInvoice(invoice)

Sets invoice.

Signature

global void setInvoice(Invoice__c invoice)

Parameters

invoice
Type: Invoice__c

Return Value

Type: void

getInvoice()

Gets Invoice.

Signature

global Invoice__c getInvoice()

Return Value

Type: Invoice__c

setInputParameter(inputParameter)

Sets the input parameters for a payment capture transaction.

Signature

global void setInputParameter(InputParameter inputParameter)

Parameters

inputParameter
Type: InputParameter

Return Value

Type: void

getInputParameter()

Returns the input parameters sent from the inputParameter class.

Signature

global InputParameter getInputParameter()

Return Value

Type: InputParameter

setInvoiceLine(line)

Sets listOfInvoiceLine.

Signature

global void setInvoiceLine(InvoiceLine__c line)

Parameters

line
Type: InvoiceLine__c

Return Value

Type: void

getInvoiceLine()

Gets listOfInvoiceLine.

Signature

global List<InvoiceLine__c> getInvoiceLine()

Return Value

Type: List<InvoiceLine__c>

setTransaction(transactionInstance)

Sets transaction instance and details like merchantRefId, RequestCreditCardNumber, ResponseCode, and GatewayID.

Signature

global void setTransaction(PaymentTransaction__c transactionInstance)

Parameters

transactionInstance
Type: PaymentTransaction__c

Return Value

Type: void

getTransaction()

Gets Transaction.

Signature

global PaymentTransaction__c getTransaction()

Return Value

Type: PaymentTransaction__c

setAccount(accountInstance)

Sets Account.

Signature

global void setAccount(Account accountInstance)

Parameters

accountInstance
Type: Account

Return Value

Type: void

getAccount()

Gets Account.

Signature

global Account getAccount()

Return Value

Type: Account

setRequestBody(requestBody)

Sets RequestBody.

Signature

global void setRequestBody(String requestBody)

Parameters

requestBody
Type: String

Return Value

Type: void

getRequestBody()

Gets RequestBody.

Signature

global String getRequestBody()

Return Value

Type: String

setFirstName(firstName)

Sets FirstName.

Signature

global void setFirstName(String firstName)

Parameters

firstName
Type: String

Return Value

Type: void

getFirstName()

Gets FirstName.

Signature

global String getFirstName()

Return Value

Type: String

setLastName(lastName)

Sets LastName.

Signature

global void setLastName(String lastName)

Parameters

lastName
Type: String

Return Value

Type: void

getLastName()

Gets LastName.

Signature

global String getLastName()

Return Value

Type: String

setEmailId(emailId)

Sets EmailId.

Signature

global void setEmailId(String emailId)

Parameters

emailId
Type: String

Return Value

Type: void

getEmailId()

Gets EmailId.

Signature

global String getEmailId()

Return Value

Type: String

setStreet(street)

Sets street.

Signature

global void setStreet(String street)

Parameters

street
Type: String

Return Value

Type: void

getStreet()

Gets Street.

Signature

global String getStreet()

Return Value

Type: String

setCity(city)

Sets City.

Signature

global void setCity(String city)

Parameters

city
Type: String

Return Value

Type: void

getCity()

Gets City.

Signature

global String getCity()

Return Value

Type: String

setState(state)

Sets state.

Signature

global void setState(String state)

Parameters

state
Type: String

Return Value

Type: void

getState()

Gets State.

Signature

global String getState()

Return Value

Type: String

setZipCode(zipCode)

Sets zip code.

Signature

global void setZipCode(String zipCode)

Parameters

zipCode
Type: String

Return Value

Type: void

getZipCode()

Gets ZipCode.

Signature

global String getZipCode()

Return Value

Type: String

setCountry(country)

Sets Country.

Signature

global void setCountry(String country)

Parameters

country
Type: String

Return Value

Type: void

getCountry()

Gets Country.

Signature

global String getCountry()

Return Value

Type: String

setPhone(phone)

Sets phone.

Signature

global void setPhone(String phone)

Parameters

phone
Type: String

Return Value

Type: void

getPhone()

Gets Phone.

Signature

global String getPhone()

Return Value

Type: String

setCurrencyId(currencyId)

Sets Currency Id.

Signature

global void setCurrencyId(String currencyId)

Parameters

currencyId
Type: String

Return Value

Type: void

getCurrencyId()

Gets Currency Id.

Signature

global String getCurrencyId()

Return Value

Type: String

setAmount(amount)

Sets amount.

Signature

global void setAmount(String amount)

Parameters

amount
Type: String

Return Value

Type: void

getAmount()

Gets Amount.

Signature

global String getAmount()

Return Value

Type: String