On This Page
FILTER BY TAG

Enable
Payer Authentication

This section shows you how to enable
Payer Authentication
.

Endpoint

Production:
POST
https://api.cybersource.com
/boarding/v1/registrations
Test:
POST
https://apitest.cybersource.com
/boarding/v1/registrations

Required Fields for Enabling
Payer Authentication

Must be in the format
http://www.example.com
.
Set to
false
.
Set to
TRANSACTING
.
Set to
ADDPRODUCT
.

American Express SafeKey-Specific Fields

Include these fields in addition to the required fields to enable and configure American Express SafeKey:
The acquirer ID is the BIN of the merchant's acquiring bank and must be from 4 to 20 alphanumeric characters or a hyphen, and include
-1000
. For example,
123456-1000
.
For testing purposes, use Acquirer ID:
cybersource
.
Set to
true
.

Cartes Bancaires-Specific Fields

Include these fields in addition to the required fields to enable and configure Cartes Bancaires:
The acquirer ID is the BIN of the merchant's acquiring bank and must be from 4 to 20 alphanumeric characters or a hyphen, and include
-1000
. For example,
123456-1000
.
For testing purposes, use Acquirer ID:
cybersource
.
Set to
true
.

Discover/Diners Club ProtectBuy-Specific Fields

Include these fields in addition to the required fields to enable and configure Discover/Diners Club ProtectBuy:
The acquirer ID is the BIN of the merchant's acquiring bank and must be from 4 to 20 alphanumeric characters or a hyphen, and include
-1000
. For example,
123456-1000
.
For testing purposes, use Acquirer ID:
cybersource
.
Set to
true
.

ELO-Specific Fields

Include these fields in addition to the required fields to enable and configure ELO:

JCB J/Secure-Specific Fields

Include these fields in addition to the required fields to enable and configure JCB J/Secure:
The acquirer ID is the BIN of the merchant's acquiring bank and must be from 4 to 20 alphanumeric characters or a hyphen, and include
-1000
. For example,
123456-1000
.
For testing purposes, use Acquirer ID:
cybersource
.
Set to
true
.

Mastercard
/Meeza
 Identity Check-Specific Fields

Include these fields in addition to the required fields to enable and configure Mastercard
/Meeza
 Identity Check:
The acquirer ID is the BIN of the merchant's acquiring bank and must be from 4 to 20 alphanumeric characters or a hyphen, and include
-1000
. For example,
123456-1000
.
For testing purposes, use Acquirer ID:
cybersource
.
Set to
true
.

UnionPay 3-D Secure-Specific Fields

Include these fields in addition to the required fields to enable and configure UnionPay 3-D Secure:

Visa Secure-Specific Fields

Include these fields in addition to the required fields to enable and configure Visa Secure:
The acquirer ID is the BIN of the merchant's acquiring bank and must be from 4 to 20 alphanumeric characters or a hyphen, and include
-1000
. For example,
123456-1000
.
For testing purposes, use Acquirer ID:
cybersource
.
Set to
true
.

REST Example: Enabling
Payer Authentication

Request
{
  "registrationInformation": {
    "boardingFlow": "ADDPRODUCT"
  },
  "organizationInformation": {
    "organizationId": "apitester00",
    "parentOrganizationId": "nishtx",
    "type": "TRANSACTING",
    "configurable": false,
    "businessInformation": {
      "address": {
        "country": "US",
        "address1": "123 Main",
        "postalCode": "99999",
        "administrativeArea": "WA",
        "locality": "Seattle"
      },
      "businessContact": {
        "firstName": "Jane",
        "lastName": "Smith",
        "phoneNumber": "5551234567",
        "email": "[email protected]"
      },
      "name": "Test Merchant",
      "websiteUrl": "https://www.example.com"
    }
  },
  "productInformation": {
    "selectedProducts": {
      "payments": {
        "payerAuthentication": {
          "configurationInformation": {
            "configurations": {
              "cardTypes": {
                "amexSafeKey": {
                  "enabled": true,
                  "currencies": [
                    {
                      "currencyCodes": ["ALL"],
                      "acquirerId": "12345678901-1000",
                      "processorMerchantId": "procmerch123"
                    }
                  ]
                },

            "CB": {
                  "requestorId": "",
                  "enabled": true,
                  "currencies": [
                    {
                      "currencyCodes": ["ALL"],
                      "acquirerId": "211111-1000",
                      "processorMerchantId": "procmerch123"
                    }
                  ]
                 },

                "dinersClubInternationalProtectBuy": {
                  "enabled": true,
                  "currencies": [
                    {
                      "currencyCodes": ["ALL"],
                      "acquirerId": "311111-1000",
                      "processorMerchantId": "procmerch123"
                    }
                  ]
                },

            "ELO": {
                  "enabled": true,
                  "currencies": [
                    {
                      "currencyCodes": ["ALL"],
                      "acquirerId": "11111111-1000",
                      "processorMerchantId": "procmerch123"
                    }
                  ]
                },


            "jCBJSecure": {
                  "securePasswordForJCB": "jcbpass",
                  "enabled": true,
                  "currencies": [
                    {
                      "currencyCodes": ["ALL"],
                      "acquirerId": "123456-1000",
                      "processorMerchantId": "procmerch123"
                    }
                  ]
                 },

                "masterCardSecureCode": {
                  "enabled": true,
                  "currencies": [
                    {
                      "currencyCodes": ["ALL"],
                      "acquirerId": "522222-1000",
                      "processorMerchantId": "procmerch123"
                    }
                  ]
                },

            "UPI": {
                  "enabled": true,
                  "currencies": [
                    {
                      "currencyCodes": ["ALL"],
                      "acquirerId": "611111-1000",
                      "processorMerchantId": "procmerch123"
                    }
                  ]
                 },

                "verifiedByVisa": {
                  "enabled": true,
                  "currencies": [
                    {
                      "currencyCodes": ["ALL"],
                      "acquirerId": "411111-1000",
                      "processorMerchantId": "procmerch123"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}
Response to a Successful Request
{
  "id": "87304104004",
  "submitTimeUtc": "2024-05-14T15:53:19Z",
  "status": "PROCESSING",
  "registrationInformation": {
    "mode": "COMPLETE",
    "boardingPackageId": "190303004"
  },
  "organizationInformation": {
    "organizationId": "apitester00",
    "parentOrganizationId": "nishtx"
  },
  "message": "Request is being processed"
}
RELATED TO THIS PAGE