FILTER BY TAG

Enable
Unified Checkout
Using the Boarding Registration Service API

This 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/registrations
Test:
POST
https://apitest.cybersource.com
/boarding/v1/registrations

Required Fields for Enabling
Unified Checkout

Common Required Fields to Enable
Unified Checkout

organizationInformation.organizationId
organizationInformation.businessInformation.name
organizationInformation.businessInformation.websiteUrl
organizationInformation.businessInformation.merchantCategoryCode
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation.enabled
Set to
true
.

Enable
Unified Checkout
with Default Features

Use these required fields to enable
Unified Checkout
with the default features enabled.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.tokenManagement.enabled
Set to
true
to enable token management on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.applePay.enabled
Set to
true
to enable Apple Pay on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.googlePay.enabled
Set to
true
to enable Google Pay on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.decisionManager.enabled
Set to
true
to enable Decision Manager on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.payerAuthentication.enabled
Set to
true
to enable payer authentication on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.clickToPay.enabled
Set to
true
to enable
Click to Pay
on
Unified Checkout
.

All Features

Use these required fields to enable
Unified Checkout
with all features enabled.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.pazeForUnifiedCheckout.enabled
Set to
true
to enable Paze on
Unified 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 to
true
to enable token management on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.payPal.enabled
Set to
true
to enable PayPal on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.venmo.enabled
Set to
true
to enable Venmo on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.applePay.enabled
Set to
true
to enable Apple Pay on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.googlePay.enabled
Set to
true
to enable Google Pay on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.tinkPayByBank.enabled
Set to
true
to enable Pay by Bank through Tink on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.eCheck.enabled
Set to
true
to enable eCheck on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.p24.enabled
Set to
true
to enable Przelewy24 on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.myBank.enabled
Set to
true
to enable MyBank on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.dragonPay.enabled
Set to
true
to enable DragonPay on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.decisionManager.enabled
Set to
true
to enable Decision Manager on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.payerAuthentication.enabled
Set to
true
to enable payer authentication on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.afterPay.enabled
Set to
true
to enable Afterpay on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.ideal.enabled
Set to
true
to enable iDEAL on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.multibanco.enabled
Set to
true
to enable Multibanco on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.bancontact.enabled
Set to
true
to enable Bancontact on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.clickToPay.enabled
Set to
true
to enable
Click to Pay
on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.unifiedClickToPaySDK.enabled
Set to
true
to enable the unified
Click to Pay
SDK on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.subscriptionInformation. features.portfolioAccessofSensitiveData.enabled
Set to
true
to enable merchant access of sensitive data on
Unified Checkout
.
productInformation.selectedProducts.payments.unifiedCheckout.configurationInformation. configurations.features.paze.financialInstitution
Required if
features.pazeForUnifiedCheckout.enabled
is set to
true
.
productInformation.selectedProducts.payments.unifiedCheckout.configurationInformation. configurations.features.paze.financialInstitutionContract
Required if
features.pazeForUnifiedCheckout.enabled
is set to
true
. Set to
true
to confirm the merchant has a contract with the financial institution for Paze.
productInformation.selectedProducts.payments.unifiedCheckout.configurationInformation. configurations.features.paze.pazeEnabledInProfile
Required if
features.pazeForUnifiedCheckout.enabled
is set to
true
. Set to
true
to enable Paze in the merchant's profile.

REST Example: Enabling
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 } } } } } }