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
Salesforce Billing Tax Integration Developer Guide
Revenue Recognition Service Developer Guide
Hosted Card Payments Lightning Component
Attributes for the Card Hosted Payments Component
Guidelines for the Hosted Card Payments Lightning Component
HostedPaymentPageTransactionAPI Class
HostedPaymentPageTransactionAPI Methods
REST API for Converting Invoice Lines with Negative Balances
Set Up Standalone Orders with API
Salesforce Billing Apex Reference
PDF

Newer Version Available

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

HostedPaymentPageTransactionAPI Class

Global API Apex class for Salesforce Billing. Contains methods that customers can call to save a credit card with tokenization or make a transaction using a new credit card.

Namespace

blng

Usage

The HostedPaymentPageTransactionAPI class contains the chargeTransaction method, which allows users to make a transaction using a new credit card, and the savePaymentMethod method, which allows users to save a credit card with tokenization.

Inputs

Table 1. Address Inputs
Name Type Description Required or Optional Available Version
addressLine1 String First line in the address of the user making the payment. Optional 48.0
addressLine2 String Second line in the address of the user making the payment. Optional 48.0
city String City Optional 48.0
country String Country Optional 48.0
postalCode String Postal code Optional 48.0
state String State Optional 48.0
Table 2. CardPaymentMethod Inputs
Name Type Description Required or Optional Available Version
cardHolderName String Full name of the card holder. Required 48.0
cardNumber String Number of the credit card. Required 48.0
cardType String Card network type. Valid values are:
  • AmericanExpress
  • Discover
  • MasterCard
  • Visa
 Required 48.0
cvv String CVV Required 48.0
expiryMonth Integer Card expiration month. Required 48.0
expiryYear Integer Card expiration year. Required 48.0
Table 3. PaymentMethod Inputs
Name Type Description Required or Optional Available Version
address String Address of the payment method holder. Required 48.0
autopay Boolean Defines whether Salesforce Billing saves a record of the payment method to the customer’s account for use in future payment runs. One account can have only one payment method with autopay enabled. Optional 48.0
email String Email of the payment method holder. Optional 48.0
firstName String First name of the payment method holder. Required 48.0
lastName String Last name of the payment method holder. Required 48.0
cardPaymentMethod cardPaymentMethod Card details for the payment method. Required 48.0
paymentType String Type of payment method. Valid values are:
  • Credit Card
 Required 48.0
saveForFuture Boolean Indicates whether Salesforce saves a record of the payment method for future use. Optional 48.0

HostedPaymentPageTransactionAPI Methods

The following are methods for HostedPaymentPageTransactionAPI.

chargeTransaction(chargeRequest)

Use this method to charge the desired amount from the buyer’s card.

Signature

global static String chargeTransaction(String chargeRequest)

Parameters

chargeRequest
Type: String
Represents a charge request made to the payment gateway.

Return Value

Type: String

Represents a charge transaction response.

Example

Example format for a charge request input.

1{
2    "accountId": "0018A00000QcPDpQAN",
3    "gatewayId": "a1x8A000000OZG2",
4    "amount": 10,
5    "paymentMethod": {
6        "firstName": "Muneer Ahmed",
7        "lastName": "Shaik",
8        "email": "mas@sf.com",
9        "saveForFuture": true,
10        "autoPay": true,
11        "paymentType": "Credit Card",
12        "address": {
13            "addressLine1": "Address 1",
14            "addressLine2": "Address 2",
15            "city": "SF",
16            "state": "CA",
17            "country": "United States",
18            "postalCode": "41111"
19        },
20        "cardPaymentMethod": {
21            "cardHolderName": "Muneer Ahmed Shaik",
22            "cardType": "Visa",
23            "cardNumber": "4111111111111111",
24            "cvv": "111",
25            "expiryMonth": "2",
26            "expiryYear": "2021"
27        }
28    }    
29  }

savePaymentMethod(paymentMethodRequest)

Use this method to save a payment method. Currently supports saving only credit cards.

Signature

global static String savePaymentMethod(String paymentMethodRequest)

Parameters

paymentMethodRequest
Type: String
Represents a request to save a payment method.

Return Value

Type: String

Represents a save payment method response.

Example

Example format for a save payment method request input.

1{
2    "accountId": "0018A00000QcPDpQAN",
3    "gatewayId": "a1x8A000000OZG2",
4    "paymentMethod": {
5        "firstName": "Muneer Ahmed",
6        "lastName": "Shaik",
7        "email": "mas@sf.com",
8        "paymentType": "Credit Card",
9        "address": {
10            "addressLine1": "Address 1",
11            "addressLine2": "Address 2",
12            "city": "SF",
13            "state": "CA",
14            "country": "United States",
15            "postalCode": "41111"
16        },
17        "cardPaymentMethod": {
18            "cardHolderName": "Muneer Ahmed Shaik",
19            "cardType": "Visa",
20            "cardNumber": "4111111111111111",
21            "cvv": "111",
22            "expiryMonth": "2",
23            "expiryYear": "2021"
24        }
25    }
26  }