Developer Guide Menu

Optional Features

This topic provides information about electronic check features other than simple payments and credits.

Corporate Checks

Set the 
paymentInformation.bank.account.type
 field to 
X
 to indicate that the check is a corporate check.
Service:
  • Payment
Processors:
  • Chase Paymentech Solutions
  • CyberSource ACH Service
  • RBS WorldPay Atlanta
  • TeleCheck
To process corporate checks with TeleCheck, include one of these fields in your payment request:
  • buyerInformation.personalIdentification[].id and buyerInformation.personalIdentification[].issuedBy
  • buyerInformation.companyTaxId

Deferred and Partial Payments

Services:
  • Payment
  • Credit
Processors:
  • Chase Paymentech Solutions—payment only.
  • TeleCheck
Definitions:
  • Deferred payment
    —if delay occurs between the time you take the order and the time you ship the product, you need to defer your payment request.
  • Partial payment
    —if a customer orders multiple products but you ship them separately on different dates, you need to perform multiple partial payments as you ship the products.
Chase Paymentech Solutions
To request a deferred or partial payment:
  1. For the first payment request (
    /pts/v2/payments
    ), set the 
    processingInformation.bankTransferOptions.paymentCategoryCode
     field to 
    1
     to indicate that the payment uses deferred payment and full payment. If you do not, partial payments will occur later. The default value of 
    0
     indicates a normal payment with immediate payment.
  2. When you are ready to process a payment, whether it is for the full amount or a partial amount, send another payment request with the 
    processingInformation.bankTransferOptions.paymentCategoryCode
     field set to 
    2
     to indicate that you are triggering a payment.
  3. Repeat Step 2 for each partial payment for the order.
TeleCheck
To request a deferred or partial payment:
  1. For the first payment request, set the value of the 
    processingInformation.bankTransferOptions.paymentCategoryCode
     field to 
    1
     to indicate that the payment uses deferred payment and full payment. If you do not, partial payments will occur later. The default value of 
    0
     indicates a normal payment with immediate payment. Including the 
    processingInformation.reconciliationId
     field in the request is optional.
  2. When you are ready to process a payment, whether it is for the full amount or a partial amount, send another payment request and do the following:
    • Set the value of the 
      processingInformation.bankTransferOptions.paymentCategoryCode
       field to 
      2
       to indicate that you are triggering a payment.
    • Set the value of the 
      id
       field to the same value as the 
      id
       field that you received from the original payment request in Step 1.
  3. Repeat Step 2 for each partial payment for the order.
  4. For a credit request, set the value of the 
    id
     field to the value contained in the 
    id
     field that you received from the payment request in Step 2.This value is used to complete the follow-on capture of the initial request.

Encoded Account Numbers

Services:
  • Payment
  • Credit
Processors:
  • Chase Paymentech Solutions
  • RBS WorldPay Atlanta
Depending on your type of business, you might be eligible to acquire from a bank a list of customers who have accounts with that bank. The list does not include customer account numbers, but includes encoded account numbers. Some processors refer to this type of program as 
issuer encryption
 and to the numbers as 
encrypted account numbers
. This type of program is designed to protect customer data according to the provisions of the Gramm-Leach-Bliley Act.
When processing a payment or credit for one of these customers, you use the encoded account number instead of the customer’s account number. The bank then matches the encoded account number to the customer’s account number when processing the payment.
You must contact the processor to obtain information required for their account number encryption program, and you must have a relationship with the bank to acquire its list of customers.
To process an electronic check payment or credit with an encoded account number:
  • Set the 
    paymentInformation.bank.account.number
     field to the encoded account number.
  • Set the 
    paymentInformation.card.accountEncoderId
     field to the value assigned to the bank that supplied the customer information. Contact your processor to obtain the ID for the bank.

Merchant Descriptors

Services:
  • Payment
  • Credit
Processors:
  • Chase Paymentech Solutions
  • CyberSource ACH Service
  • RBS WorldPay Atlanta
You can provide a merchant descriptor to be displayed on the customer’s bank account statement. The descriptor includes your company’s name and a description of the product or service that was purchased.
The merchant descriptor field overrides the corresponding value in your CyberSource account. If you do not include this field in the request, CyberSource uses the company name from your merchant account.
Before sending a merchant descriptor with a payment or credit request, check with your processor to find out if you need to register your merchant descriptor information with them.
The 
merchantInformation.merchantDescriptor.name
 field requires a particular format:
  • Characters 1-15: name of your company. If the name is fewer than 15 characters, use spaces to fill in the full 15 characters. If the name is more than 15 characters, provide only the first 15 characters of the name.
  • Characters 16-25: description of the product or service.

NOTE

Only one space is permitted between characters. Any additional spaces between characters are removed.

Multiple Partial Credits

Service:
  • Credit
Processors:
  • RBS WorldPay Atlanta
  • TeleCheck
When you perform multiple partial credits:
  • The amount of each individual credit cannot exceed the payment amount.
  • The total amount of all credits cannot exceed the payment amount.
In your follow-on credit request, use the ID returned in the 
id
 field. Do not use the ID from a previous partial credit. For each partial credit, set the 
processingInformation.bankTransferOptions.partialPaymentId
 field to a value of your choice that is unique within the scope of the order. The processor uses the payment IDs to identify the credits that are related to an order.
If you performed partial payments for this order, you specified a unique value for the 
processingInformation.bankTransferOptions.partialPaymentId
 field for each payment. You cannot reuse any of those values for the order’s partial credits. For example, if you used 
1
 and 
2
 for the partial payments, you must use different values, such as 
3
 and 
4
, for the partial credits.

Non-Sufficient Funds (NSF) Service

Service:
  • Payment
Processor:
  • CyberSource ACH Service
A non-sufficient funds (NSF) return occurs when the customer’s bank account does not have sufficient funds to cover a specific electronic check transaction. CyberSource does not automatically resubmit charges returned from a customer’s bank due to NSF. You can resubmit transactions returned as NSF one or two additional times for a total of three submissions. Continued attempts after this point can result in a fine and possible sanctions from the National Automated Clearing House Association (NACHA).
Contact your ODFI to enable the NSF service at your bank.

Token Management Services (TMS)

Services:
  • Payment
  • Credit
Processors:
  • Chase Paymentech Solutions
  • CyberSource ACH Service
  • RBS WorldPay Atlanta
  • TeleCheck
If you are using Token Management Services (TMS), you can process a payment or credit by using information that is stored in a customer profile. CyberSource uses the subscription ID to reference the customer profile information in the CyberSource database. The following example shows how to send a TMS request without providing all the information that is normally required for CyberSource requests.
POST https://<url_prefix>/pts/v2/payments/
Request Payload
{
}, "processingInformation": { "commerceIndicator": "internet" },
"paymentInformation": { "customer": { "customerId": "7500BB199B4270EFE05340588D0AFCAD"
} }, "orderInformation": {
"amountDetails": { "totalAmount": "22", "currency": "USD"
}, "billTo": { "firstName": "John", "lastName": "Doe", "company": "Visa", "address1": "1 Market St", "locality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@cybs.com", "phoneNumber": "4158880000" } } }
You can override most of the information stored in the customer profile by including the relevant API fields in the payment or credit request. For example, you could provide a different billing or shipping address in the request. You cannot override the account number.
For complete information about tokenized payments, see Token Management Services.

Recurring Billing

Services:
  • Payment
  • Credit
Processors:
  • Chase Paymentech Solutions
  • CyberSource ACH Service
    • Recurring payments and credits for telephone-initiated orders are supported. You must set the 
      processingInformation.bankTransferOptions.secCode
       field to 
      TEL
      .
  • RBS WorldPay Atlanta
  • TeleCheck
If you are using Recurring Billing, you can process a payment or credit by using information that is stored in a subscription. CyberSource uses the subscription ID to reference the subscription information in the CyberSource database. Instead of providing all the information that is normally required for a transaction, you need to provide only the following values:
  • Merchant ID
  • Merchant reference number
  • Amount of the payment or credit
  • Subscription ID
You can override most of the information stored in the subscription by including the relevant API fields in the payment or credit request. For example, you could provide a different billing or shipping address in the request. You cannot override the account number.
For complete information about standard entry class codes, see "SEC Codes."
For complete information about recurring billing, see .

Service Fees

Services:
  • Payment
  • Credit
  • Void
For information about service fees and the processors for which CyberSource supports service fees, see "Service Fees."

Settlement Delivery Methods

Services:
  • Payment
  • Credit
Processor:
  • Chase Paymentech Solutions
You must specify a default method for delivering settlements to and receiving them from the customer’s bank.You can use the 
processingInformation.bankTransferOptions.settlementMethod
 field to override the default method for a single transaction.
The following delivery methods are available:
  • A
     (Automated Clearing House (ACH) for U.S. accounts or Canadian Payment Association (CPA) for Canadian accounts):
    The transaction is deposited through the ACH or CPA. If the check fails the validation or verification process, the transaction is rejected.
  • F
     (Facsimile draft):
    The transaction is deposited as a facsimile draft. Available only for transactions in U.S. dollars. Use this method when the issuing bank is not an ACH member.
  • B
     (Best possible):
    The transaction is deposited through the ACH system unless the customer’s bank is not an ACH participant, in which case, a facsimile draft is created and deposited on your behalf. Available only for transactions in U.S. dollars.
Top