On This Page
Comparison of Business Center UI Sections and API Fields
Business Center
UI Sections and API FieldsThis table lists Recurring Billing elements as they are named in the legacy Recurring Billing system,
both in the
Business Center
and from the perspective of the Simple Order API.
Each table row also shows how migration maps the legacy fields to the new system:- CorrespondingBusiness Centerelements in the upgraded system are in the 'Business Center Section' and 'Field Name' columns for 'New Recurring Billing' and for 'TMS'.
- Corresponding API field names are in the 'REST API Field' columns for 'New Recurring Billing' and for 'TMS'.
Legacy Recurring Billing | New Recurring Billing | TMS | |||||||
|---|---|---|---|---|---|---|---|---|---|
Business Center Section | Field Name | Simple Order API Field | Business Center Section | Field Name | REST API Field | Business Center Section | Field Name | REST API Field | Type |
Customer Information | City | billTo_city | Payment Details / Billing Address | City | — | Billing Information | City | billTo.locality | Payment Instrument |
Company | billTo_company | Payment Details / Billing Address | Company | — | Billing Information | Company | billTo.company | Payment Instrument | |
— | billTo_companyTaxID | Payment Details / eCheck details / Buyer's details | Company Tax ID | — | Payment Information / Check | Company Tax ID | buyerInformation.companyTaxID | Payment Instrument | |
Billing Countries | billTo_country | Payment Details / Billing Address | Country | — | Billing Information | Country | billTo.country | Payment Instrument | |
Customer ID | billTo_customerID | Customer Details | Customer Reference | — | Customer Details | Customer Reference | buyerInformation.merchantCustomerID | Customer Token | |
Email Address | billTo_email | Payment Details / Billing Address | Email | — | Billing Information | Email | billTo.email | Payment Instrument | |
First Name | billTo_firstName | Payment Details / Billing Address | First Name | — | Billing Information | First Name | billTo.firstName | Payment Instrument | |
Last Name | billTo_lastName | Payment Details / Billing Address | Last Name | — | Billing Information | Last Name | billTo.lastName | Payment Instrument | |
Phone Number | billTo_phoneNumber | Payment Details / Billing Address | Phone | — | Billing Information | Phone Number | billTo.phoneNumber | Payment Instrument | |
Postal Code | billTo_postalCode | Payment Details / Billing Address | Zip/Postal Code | — | Billing Information | Postal Code | billTo.postalCode | Payment Instrument | |
State | billTo_state | Payment Details / Billing Address | County/Region | — | Billing Information | County/Region | billTo.administrativeArea | Payment Instrument | |
Street Address 1 | billTo_street1 | Payment Details / Billing Address | Address | — | Billing Information | Street Address 1 | billTo.address1 | Payment Instrument | |
Street Address 2 | billTo_street2 | Payment Details /
Billing Address | Flat, Suite, Floor, Building, etc. | — | Billing Information | Street Address 2 | billTo.address2 | Payment Instrument | |
Legacy Recurring Billing | New Recurring Billing | Token Management Service | |||||||
Business Center Section | Field Name | Simple Order API Field | Business Center Section | Field Name | REST API Field | Business Center Section | Field Name | REST API Field | Type |
Payment Information | Payment Type | subscriptition_paymentMethod | Payment Details | Payment Methods | — | Payment Information | Payment Type | System automatically identifies the payment method
based on default payment instrument associated to the customer token
specified in the subscription. | Payment Information |
Credit Card Number | card_accountNumber | Payment Details / Card Details | Card Number | — | Payment Information / Credit Card | Credit Card Number | card.number | Instrument Identifier | |
Card Type | card_cardType | Payment Details / Card Details | Card Types | — | Payment Information / Credit Card | Credit Card Type | card.type | Payment Instrument | |
— | card_cvIndicator | — | — | — | — | — | — | — | |
Card Verification Number | card_cvNumber | — | — | — | — | — | card.securityCode | Instrument Identifier | |
Card Expiry Date / Month | card_expirationMonth | Payment Details / Card Details | Expiry Month | — | Payment Information / Credit Card | Expiry Date | card.expirationMonth | Payment Instrument | |
Card Expiry Date / Year | card_expirationYear | Payment Details / Card Details | Expiry Year | — | Payment Information / Credit Card | Expiry Date | card.expirationYear | Payment Instrument | |
— | card_issueNumber | — | — | — | — | — | card.issueNumber | Payment Instrument | |
— | card_startMonth | — | — | — | — | — | card.startMonth | Payment Instrument | |
— | card_startYear | — | — | — | — | — | card.startYear | Payment Instrument | |
Date of Birth | billTo_dateOfBirth | Payment Details / eCheck Details / Buyer's Details | Date of Birth | — | Payment Information / Check | Date of Birth | buyerInformation.dateOfBirth | Payment Instrument | |
Driving Licence Number | billTo_driversLicenseNumber | Payment Details / eCheck Details / Buyer's Details | Driving Licence Number | — | Payment Information / Check | Driving Licence Number | buyerInformation.personalIdentification.id | Payment Instrument | |
County/Region | billTo_driversLicenseState | Payment Details / eCheck Details / Buyer's Details | Drivining Licence State | — | Payment Information / Check | Driving Licence State | buyerInformation.personalIdentification.issuedBy.administrativeArea | Payment Instrument | |
Account Number | check_accountNumber | Payment Details / eCheck Details | Account Number | — | Payment Information / Check | Account Number | bankAccount.number | Instrument Identifier | |
Account Type | check_accountType | Payment Details / eCheck details | Account Type | — | Payment Information / Check k | Account Type | bankAccount.type | Payment Instrument | |
Cheque Routing Number | check_bankTransitNumber | Payment Details / eCheck details | Routing Number | — | Payment Information / Check | Routing Number | bankAccount.routingNumber | Instrument Identifier | |
SEC Code | check_secCode | Payment Details / eCheck details | Authorization Method (SEC Code) | — | Payment Information / Check | SEC Value | processingInformation.bankTransferOptions.SECCode | Payment Instrument | |
Bill Payment with Visa | recurringSubscriptionInfo_billPayment | — | — | — | — | — | processingInformation.billPaymentProgramEnabled | Payment Instrument | |
— | paymentNetworkToken_requestorID | — | — | — | — | — | card.tokenizedInformation.requestorID | PaymentInstrument | |
— | paymentNetworkToken_transactionType | — | — | — | — | — | card.tokenizedInformation.transactionType | PaymentInstrument | |
Legacy Recurring Billing | New Recurring Billing | Token Management Service | |||||||
Business Center Section | Field Name | Simple Order API Field | Business Center Section | Field Name | REST API Field | Business Center Section | Field Name | REST API Field | Type |
Order Information | Merchant Reference Number | merchantReferenceCode | Subscription Details | Merchant Reference Number | clientReferenceInformation.code | Customer Details | Merchant Reference Number | clientReferenceInformation.code | Customer Token |
Merchant Defined Data Field 1 | merchantDefinedData_field1 | Customer Details | Merchant-Defined 1 | — | Merchant-Defined Data Fields | Merchant-Defined 1 | merchantDefinedInformation.[name] | Customer Token | |
Merchant Defined Data Field 2 | merchantDefinedData_field2 | Customer Details | Merchant-Defined 2 | — | Merchant-Defined Data Fields | Merchant-Defined 2 | merchantDefinedInformation.[name] | Customer Token | |
Merchant Defined Data Field 3 | merchantDefinedData_field3 | Customer Details | Merchant-Defined 3 | — | Merchant-Defined Data Fields | Merchant-Defined 3 | merchantDefinedInformation.[name] | Customer Token | |
Merchant Defined Data Field 4 | merchantDefinedData_field4 | Customer Details | Merchant-Defined 4 | — | Merchant-Defined Data Fields | Merchant-Defined 4 | merchantDefinedInformation.[name] | Customer Token | |
Comments | — | — | — | — | — | — | objectInformation.comment | Customer Token | |
Legacy Recurring Billing | New Recurring Billing | Token Management Service | |||||||
Business Center Section | Field Name | Simple Order API Field | Business Center Section | Field Name | REST API Field | Business Center Section | Field Name | REST API Field | Type |
Shipping Information | City | shipTo_city | Shipping Address Details | City | — | Shipping Information | City | shipTo.locality | Shipping Address |
Shipping Countries | shipTo_country | Shipping Address Details | Country | — | Shipping Information | Country | shipTo.country | Shipping Address | |
First Name | shipTo_firstName | Shipping Address Details | First Name | — | Shipping Information | First Name | shipTo.firstName | Shipping Address | |
Last Name | shipTo_lastName | Shipping Address Details | Last Name | — | Shipping Information | Last Name | shipTo.lastName | Shipping Address | |
— | shipTo_phoneNumber | Shipping Address Details | Phone | — | Shipping Information | Phone Number | shipTo.phoneNumber | Shipping Address | |
Postal Code | shipTo_postalCode | Shipping Address Details | Zip/Postal Code | — | Shipping Information | Postal Code | shipTo.postalCode | Shipping Address | |
State | shipTo_state | Shipping Address Details | County/Region | — | Shipping Information | County/Region | shipTo.administrativeArea | Shipping Address | |
Street Address 1 | shipTo_street1 | Shipping Address Details | Address | — | Shipping Information | Street Address 1 | shipTo.address1 | Shipping Address | |
Street Address 2 | shipTo_street2 | Shipping Address Details | Flat, Suite, Floor, Building, etc. | — | Shipping Information | Street Address 2 | shipTo.address2 | Shipping Address | |
Legacy Recurring Billing | New Recurring Billing | Token Management Service | |||||||
Business Center Section | Field Name | Simple Order API Field | Business Center Section | Field Name | REST API Field | Business Center Section | Field Name | REST API Field | Type |
Installment | Title | subscription_title | Subscription Details | Subscription Name | subscriptionInformation.name | — | — | — | — |
— | paySubscriptionCreateService_disableAutoAuth | — | — | — | — | — | — | — | |
— | paySubscriptionCreateService_paymentRequestID | — | — | subscriptionInformation.originalTransactionId | — | — | — | — | |
Currency | purchaseTotals_currency | Subscription Details / Subscription Billing Plan | Currency | orderInformation.amountDetails.currency | — | — | — | — | |
Recurring Amount | purchaseTotals_grandTotalAmount | Subscription Details / Subscription Billing Plan | Billing Amount | orderInformation.amountDetails.billingAmount | — | — | — | — | |
Set-up Fee | recurringSubscriptionInfo_amount | Subscription Details / Subscription Billing Plan | Set-up fee | orderInformation.amountDetails.setupFee | — | — | — | — | |
Automatically renew this subscription | recurringSubscriptionInfo_automaticRenew | — | — | — | — | — | — | — | |
Billing Frequency | recurringSubscriptionInfo_frequency | Subscription Details / Subscription Billing Plan | Billing Frequency | planInformation.billingPeriod.length +
planInformation.billingPeriod.unit If you want to
create a token for on-demand payments you need to use TMS API or
Payments API with Token Creation. | — | — | — | — | |
Number of Payments | recurringSubscriptionInfo_numberOfPayments | Subscription Details / Subscription Billing Plan | Billing Cycles | planInformation.billingCycles.total | — | — | — | — | |
Start Date | recurringSubscriptionInfo_startDate | Subscription Details | Start Date | subscriptionInformation.startDate | — | — | — | — | |
Ignore Fraud Checks | decisionManager_enabled
| Decision Manager is not supported when creating a subscription with
automatic processing of the initial transaction. If you want to use
Decision Manager , process the initial transaction yourself
and then include its Network Transaction ID in your request in the
subscriptionInformation.originalTransactionId
field. | |||||||
— | ccAuthService_commerceIndicator
| If you are using
the Recurring Billing REST API to create a subscription and you do not
process the initial transaction yourself, include the
processingInformation.commerceIndicator field. To
ensure SCA/3DS compliance, process the initial transaction yourself and
then include its Network Transaction ID in your request in the
subscriptionInformation.originalTransactionId
field. | |||||||
recurringSubscriptionInfo_subscriptionID
| The new Recurring Billing and subscriptions service uses a REST API.
Each available action on a subscription has its own dedicated
endpoint. To perform an action, specify the subscription ID as a
path parameter. For specific information, see the Recurring Billing Developer Guide . | ||||||||
paySubscriptionEventUpdateService_action
| |||||||||
paySubscriptionEventUpdateService_event_amount
| |||||||||
paySubscriptionEventUpdateService_event_approvedBy
| |||||||||
paySubscriptionEventUpdateService_event_number
| |||||||||
recurringSubscriptionInfo_numberOfPaymentsToAdd
| |||||||||
recurringSubscriptionInfo_status
| |||||||||