On This Page
FILTER BY TAG

Getting Started with the Acceptance Devices App

Use the information to start using the Acceptance Devices app. You can process payments after setting up the device and configuring the app.

Set Up an iPhone

Before setting up an iPhone, download and install the Acceptance Devices app from the Apple App Store.
Follow these steps to set up an iPhone in the Acceptance Devices app:
  1. Open the Acceptance Devices App on an iPhone.
  2. On the Welcome screen, tap
    Start Configuration
    . The app is configured to use the production environment. To switch to the test environment, press and hold the Welcome screen for 5 seconds. The Select Environment screen appears. Choose an environment for configuration.
  3. On the Create Passcode screen, enter a unique passcode. The passcode must consist of six digits. Confirm the passcode by entering it a second time, then tap
    Save Passcode
    . You will use this passcode to access the app's settings menu, so choose a code that you will remember.
  4. If the Connect to the Internet screen appears, tap
    Connect to the internet
    , then choose an internet connection option.
  5. If the Internet Connected screen appears, tap
    Continue
    .

    ADDITIONAL INFORMATION

    You are prompted to activate your iPhone in the Acceptance Devices app.

Activating an iPhone in the Acceptance Devices App

Before you can process payments on your iPhone using the Acceptance Devices app, you must use an activation code to activate the device in the Acceptance Devices app. You can generate the code in the
Business Center
 or by using an API request. After generating the activation code, you enter it in the Acceptance Devices app.

Generate an iPhone Activation Code in the
Business Center

Before activating an iPhone in the Acceptance Devices app, you must generate a device activation code. The code is valid for 24 hours.
Follow these steps to generate an iPhone activation code in the
Business Center
:
  1. In the
    Business Center
    , go to the left navigation panel and choose
    Acceptance Devices
    >
    Activation Codes
    . The Activation Codes page appears.
  2. Click the
    Select Transacting MID
     drop-down menu.
  3. Choose a transacting MID from the list.
  4. Click the
    Select number of Activation Codes
     drop-down menu.
  5. Choose the number of activation codes that you want to generate. The maximum number of codes is 15.
  6. Click
    Generate
    . The activation codes display on the page. To copy the codes to your clipboard, click the icon next to the code.
  7. To download a text file containing the activation codes, click the
    Download codes as a .txt file
     button.
  8. Navigate to the Download folder on your computer to access the text file.

Generating an iPhone Activation Code Using a REST API Request

Before activating an iPhone in the Acceptance Devices app, you must generate a device activation code. The code is valid for 24 hours.
Use this information to generate a device activation code using a REST API request.
You must authenticate each request that you send to a
Cybersource
 API. To authenticate an API request, you can use a REST shared secret key or a REST certificate. For more information about authentication requirements, see the .

Endpoints

The POST request must include the transacting merchant ID (MID) that is sending the request and the quantity of activation codes to be generated. You can request up to 15 activation codes in a single request.
Test:
POST
https://apitest.cybersource.com
/dms/v2/merchants/{transacting mid}/activation-codes?size={number of activation codes}
Production:
POST
https://api.cybersource.com
/dms/v2/merchants/{transacting mid}/activation-codes?size={number of activation codes}

Required Fields to Generate an iPhone Activation Code

The body of the API request is empty. The POST request must include the information required to return the response.

REST Example: Generate an iPhone Activation Code

Request
The body of the request is empty. The POST request includes the information required to return the response.
{
}
Response to a Successful Request
The response includes the activation code (
token
 field) and the amount of time (
ttl
 field) that the activation code is valid. The
ttl
 field value is shown in milliseconds. The activation code is valid for 24 hours.
{
    "tokens": [
        {
            "token": "%N5wU2jH",
            "ttl": 86399805
        }
    ]
}

Enter an Activation Code in the Acceptance Devices App

Before activating an iPhone, you must generate an activation code for the device in the
Business Center
 or by using a REST API request. The activation code is valid for 24 hours.
Follow these steps to enter an activation code in the Acceptance Devices app:
  1. On the Terminal Activation screen, enter the activation code that you generated. Tap
    Continue
    . The Device Activated Successfully screen appears.
  2. When the Assigned Serial Number screen appears, record the serial number assigned to your device for future reference. You must provide the serial number when re-enrolling a device or when communicating with customer support about the device or solution. Tap
    Close
    .

Customizing the Acceptance Devices App

Use this information to customize the Acceptance Devices app in the
Business Center
 or by using a REST API request.
The Acceptance Devices Customizations feature in the
Business Center
 enables you to customize these parameters for a portfolio, merchant, or transacting merchant ID (MID):
  • User interface
  • Common
  • Standalone mode
You can use a REST API request to perform these customization tasks:
  • Retrieve and review your current parameter customization settings.
  • Update customization settings for user interface, common, and Standalone mode parameters.

Customizable User Interface Parameters

You can customize these user interface parameters for the Acceptance Devices app when it is operating in Standalone mode.
Home screen logo
This parameter defines the logo that is shown on the home screen of the app.
Toolbar logo
This parameter defines the logo that is shown during transaction processing.
Primary color
This parameter defines the color of the primary buttons.
Color on primary
This parameter defines the color of the text on the primary buttons.
Background color
This parameter defines the color of the screen background.
Color on background
This parameter defines the color of the text on the screen background.
Button shape
This parameter defines the shape of the buttons.

Customizable Common Parameters

You can customize these common parameters for the Acceptance Devices app when it is operating in Standalone mode.
Operating mode
The Acceptance Devices app on iPhone solution operates in Standalone mode only. Other modes can be enabled for other Acceptance Devices solutions.
Tipping options
This parameter enables you to choose one of these tipping types:
  • Percentage:
     The customer chooses from three pre-defined tip percentages or enters a custom tip amount. Define the tip values in the Tipping percentage values parameter. This setting is the default tipping type.
  • Tip amount:
     The customer enters a custom tip amount.
  • Total amount:
     The customer enters the total amount to be charged, including the tip amount.
Tipping percentage values
This parameter defines the three tipping percentage choices that appear on the screen for the customer to choose. This parameter applies only if the Tipping Type parameter is set to
Percentage
. The default settings are
10, 15, 20
.
Transaction history view
This parameter defines whether the transaction history view is shown at the merchant or device level. The default setting is
Merchant
.

Customizable Standalone Mode Parameters

You can customize this Standalone mode parameter for the Acceptance Devices app.
Additional transaction types
This parameter enables you to choose additional transaction types that the app supports. Sale and refund transactions are supported by default. The default setting for additional transaction types is
None
.

Customize Parameters in the
Business Center

Follow these steps to customize common and Standalone mode parameters for the Acceptance Devices app.
  1. In the
    Business Center
    , go to the left navigation panel and choose
    Acceptance Devices
    >
    Customizations
    . The Customizations screen appears.
  2. Click the
    Load customization parameter for
     drop-down menu.
  3. Choose a user level from the list. Click
    Load
    .
  4. Scroll down to see the various parameter sections and which elements are available to customize for the chosen user level.
  5. Choose parameters to customize. To see a description of a parameter, hover your mouse over the Information icon.
  6. Click
    Apply Changes
    .

Retrieve Parameters Using a REST API Request

You can use a REST API request to retrieve and view customizable parameters and their current values. Your account settings determine the values you can view for a portfolio, merchant, or transacting merchant ID (MID).
You must authenticate each request that you send to a
Cybersource
 API. To authenticate an API request, you can use a REST shared secret key or a REST certificate. For more information about authentication requirements, see the .

Endpoints

The GET request must include the organization ID for the portfolio, merchant, or transacting merchant ID that is sending the request.
Test:
GET
https://apitest.cybersource.com
/dms/v2/customization?type=organization&id={{organization id}}
Production:
GET
https://api.cybersource.com
/dms/v2/customization?type=organization&id={{organization id}}

Required Fields to Retrieve Parameters Using a REST API Request

The body of the API request is empty. The GET request must include the information required to return the response.

REST Example: Retrieve Parameters Using a REST API Request

Request
The body of the request is empty. The GET request includes the information required to return the response.
{
}
Response to a Successful Request
{
    "id": "{{organization id}}",
    "customizations": {
        Your configured parameters response data appears here.
    },
    "customizationMetadata": {
        Your possible values for parameters response data appears here.
    }
}

Customize Parameters Using a REST API Request

You can use a REST API request to update customizable parameters for a portfolio, merchant, or transacting merchant ID (MID).
You must authenticate each request that you send to a
Cybersource
 API. To authenticate an API request, you can use a REST shared secret key or a REST certificate. For more information about authentication requirements, see the .

Endpoints

The PUT request must include the organization ID for the portfolio, merchant, or transacting merchant ID that is sending the request.
Test:
PUT
https://apitest.cybersource.com
/dms/v2/customization
Production:
PUT
https://api.cybersource.com
/dms/v2/customization

Required Fields to Customize Parameters Using a REST API Request

type
Set the value to
organization
.
id
Set the value to
organization id
 for the portfolio, merchant, or transacting MID.
customizations
Set the value to the parameters to be updated.

REST Example: Customize Parameters Using a REST API Request

Request
{
    "type": "organization",
    "id": "{{organization id}}",
    "customizations":
    {
        "OPERATING_MODE": "STANDALONE",
        "TIPPING_TYPE": "TIP_AMOUNT",
        "SIGNATURE_TYPE": "ON_RECEIPT"
    }
}
Response to a Successful Request
The body of the response is empty. A successful response is indicated with a
200 OK
 status.
{
}
RELATED TO THIS PAGE