On This Page
Enable Unified Checkout Using the Boarding Registration Service API
Unified Checkout
Using the Boarding Registration Service APIThis section shows you how to enable
Unified Checkout
using the Boarding
Registration Service (BRS) API.For information about using the BRS API to configure your portfolio, see
the Merchant Boarding Developer Guide
Prerequisites
Portfolio users can enable
Unified Checkout
and its features using the
API, but must enable them at the portfolio level before enabling them for the
merchant.Endpoint
Production:
POST
https://api.cybersource.com
/boarding/v1/registrationsTest:
POST
https://apitest.cybersource.com
/boarding/v1/registrationsRequired Fields for Enabling Unified Checkout
Unified Checkout
Common Required Fields to Enable Unified Checkout
Unified Checkout
- organizationInformation.organizationId
- organizationInformation.businessInformation.name
- organizationInformation.businessInformation.websiteUrl
- organizationInformation.businessInformation.merchantCategoryCode
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation.enabled
- Set totrue.
Enable Unified Checkout with Default Features
Unified Checkout
with Default FeaturesUse these required fields to enable
Unified Checkout
with the default features enabled.- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.tokenManagement.enabled
- Set totrueto enable token management onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.applePay.enabled
- Set totrueto enable Apple Pay onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.googlePay.enabled
- Set totrueto enable Google Pay onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.decisionManager.enabled
- Set totrueto enable Decision Manager onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.payerAuthentication.enabled
- Set totrueto enable payer authentication onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.clickToPay.enabled
- Set totrueto enableClick to PayonUnified Checkout.
All Features
Use these required fields to enable
Unified Checkout
with all features enabled.- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.pazeForUnifiedCheckout.enabled
- Set totrueto enable Paze onUnified Checkout. Enable this explicitly for each merchant, because Paze requires the merchant to sign an agreement with their acquiring partner.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.tokenManagement.enabled
- Set totrueto enable token management onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.payPal.enabled
- Set totrueto enable PayPal onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.venmo.enabled
- Set totrueto enable Venmo onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.applePay.enabled
- Set totrueto enable Apple Pay onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.googlePay.enabled
- Set totrueto enable Google Pay onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.tinkPayByBank.enabled
- Set totrueto enable Pay by Bank through Tink onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.eCheck.enabled
- Set totrueto enable eCheck onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.p24.enabled
- Set totrueto enable Przelewy24 onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.myBank.enabled
- Set totrueto enable MyBank onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.dragonPay.enabled
- Set totrueto enable DragonPay onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.decisionManager.enabled
- Set totrueto enable Decision Manager onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.payerAuthentication.enabled
- Set totrueto enable payer authentication onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.afterPay.enabled
- Set totrueto enable Afterpay onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.ideal.enabled
- Set totrueto enable iDEAL onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.multibanco.enabled
- Set totrueto enable Multibanco onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.bancontact.enabled
- Set totrueto enable Bancontact onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.clickToPay.enabled
- Set totrueto enableClick to PayonUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.unifiedClickToPaySDK.enabled
- Set totrueto enable the unifiedClick to PaySDK onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.portfolioAccessofSensitiveData.enabled
- Set totrueto enable merchant access of sensitive data onUnified Checkout.
- productInformation.selectedProducts.payments.unifiedCheckout.configurationInformation. configurations.features.paze.financialInstitution
- Required iffeatures.pazeForUnifiedCheckout.enabledis set totrue.
- productInformation.selectedProducts.payments.unifiedCheckout.configurationInformation. configurations.features.paze.financialInstitutionContract
- Required iffeatures.pazeForUnifiedCheckout.enabledis set totrue. Set totrueto confirm the merchant has a contract with the financial institution for Paze.
- productInformation.selectedProducts.payments.unifiedCheckout.configurationInformation. configurations.features.paze.pazeEnabledInProfile
- Required iffeatures.pazeForUnifiedCheckout.enabledis set totrue. Set totrueto enable Paze in the merchant's profile.
Related Information
REST Example: Enabling Unified Checkout
Unified Checkout
Enable
Unified Checkout
with Default Features Enabled{ "organizationInformation": { "organizationId": "stuartwickedfasteatz01", "parentOrganizationId": "apitester00", "type": "MERCHANT", "configurable": true, "businessInformation": { "name": "StuartWickedFastEatz", "address": { "country": "US", "address1": "123456 SandMarket", "locality": "ORMOND BEACH", "administrativeArea": "FL", "postalCode": "32176" }, "websiteUrl": "https://www.StuartWickedEats.com", "phoneNumber": "6574567813", "businessContact": { "firstName": "Stuart", "lastName": "Stuart", "phoneNumber": "6574567813", "email": "[email protected]" }, "merchantCategoryCode": "5999" } }, "productInformation": { "selectedProducts": { "payments": { "unifiedCheckout": { "subscriptionInformation": { "enabled": true, "features": { "tokenManagement": { "enabled": true }, "applePay": { "enabled": true }, "googlePay": { "enabled": true }, "decisionManager": { "enabled": true }, "payerAuthentication": { "enabled": true }, "clickToPay": { "enabled": true } } } } } } } }
Enable
Unified Checkout
with All Features Enabled{ "organizationInformation": { "organizationId": "stuartwickedfasteatz01", "parentOrganizationId": "apitester00", "type": "MERCHANT", "configurable": false, "businessInformation": { "name": "StuartWickedFastEatz", "address": { "country": "US", "address1": "123456 SandMarket", "locality": "ORMOND BEACH", "administrativeArea": "FL", "postalCode": "32176" }, "websiteUrl": "https://www.StuartWickedEats.com", "phoneNumber": "6574567813", "businessContact": { "firstName": "Stuart", "lastName": "Stuart", "phoneNumber": "6574567813", "email": "[email protected]" }, "merchantCategoryCode": "5999" } }, "productInformation": { "selectedProducts": { "payments": { "unifiedCheckout": { "subscriptionInformation": { "enabled": true, "features": { "pazeForUnifiedCheckout": { "enabled": false }, "tokenManagement": { "enabled": true }, "payPal": { "enabled": true }, "venmo": { "enabled": true }, "applePay": { "enabled": true }, "googlePay": { "enabled": true }, "tinkPayByBank": { "enabled": true }, "eCheck": { "enabled": true }, "p24": { "enabled": true }, "myBank": { "enabled": true }, "dragonPay": { "enabled": true }, "decisionManager": { "enabled": true }, "payerAuthentication": { "enabled": true }, "afterPay": { "enabled": true }, "ideal": { "enabled": true }, "multibanco": { "enabled": true }, "bancontact": { "enabled": true }, "clickToPay": { "enabled": true }, "unifiedClickToPaySDK": { "enabled": true }, "portfolioAccessofSensitiveData": { "enabled": true } } }, "configurationInformation": { "configurations": { "features": { "paze": { "financialInstitution": "FinancialInstitution", "financialInstitutionContract": true, "pazeEnabledInProfile": true } } } } } } } } }
Update Create Registration Sample to Include
Unified Checkout
{ "organizationInformation": { "parentOrganizationId": "apitester00", "type": "MERCHANT", "configurable": true, "businessInformation": { "name": "StuartWickedFastEatz", "address": { "country": "US", "address1": "123456 SandMarket", "locality": "ORMOND BEACH", "administrativeArea": "FL", "postalCode": "32176" }, "websiteUrl": "https://www.StuartWickedEats.com", "phoneNumber": "6574567813", "businessContact": { "firstName": "Stuart", "lastName": "Stuart", "phoneNumber": "6574567813", "email": "[email protected]" }, "merchantCategoryCode": "5999" } }, "productInformation": { "selectedProducts": { "payments": { "cardProcessing": { "subscriptionInformation": { "enabled": true, "features": { "cardNotPresent": { "enabled": true } } }, "configurationInformation": { "configurations": { "common": { "processors": { "tsys": { "merchantId": "123456789101", "terminalId": "1231", "industryCode": "D (Direct Marketing)", "vitalNumber": "71234567", "merchantBinNumber": "123456", "merchantLocationNumber": "00001", "storeID": "1234", "settlementCurrency": "USD" } }, "merchantCategoryCode": "1234", "merchantDescriptorInformation": { "name": "r4ef", "city": "Bellevue", "country": "US", "phone": "4255547845", "state": "WA", "street": "StreetName", "zip": "98007" } }, "features": { "cardNotPresent": { "visaStraightThroughProcessingOnly": true } } } } }, "payerAuthentication": { "subscriptionInformation": { "enabled": true }, "configurationInformation": { "configurations": { "cardTypes": { "verifiedByVisa": { "currencies": [ { "currencyCodes": [ "ALL" ], "acquirerId": "469216", "processorMerchantId": "678855" } ] } } } } }, "virtualTerminal": { "subscriptionInformation": { "enabled": false } }, "customerInvoicing": { "subscriptionInformation": { "enabled": false } }, "payouts": { "subscriptionInformation": { "enabled": false } }, "unifiedCheckout": { "subscriptionInformation": { "enabled": true, "features": { "tokenManagement": { "enabled": true }, "applePay": { "enabled": true }, "googlePay": { "enabled": true }, "decisionManager": { "enabled": true }, "payerAuthentication": { "enabled": true }, "clickToPay": { "enabled": true } } } } }, "risk": { "fraudManagementEssentials": { "subscriptionInformation": { "enabled": false }, "configurationInformation": { "templateId": "E4EDB280-9DAC-4698-9EB9-9434D40FF60C" } } }, "commerceSolutions": { "tokenManagement": { "subscriptionInformation": { "enabled": false } } } } } }