Prerequisites

Before integrating the Merchant Onboarding API, make sure to meet the following prerequisites:

  1. Register as a member of Samsung Pay Developers.

  2. Receive the login credentials from Samsung to construct the authorization header for all requests sent to Merchant Onboarding endpoints. The credentials are usually sent through email.

  3. Allowlist the IP addresses of the servers that call the Merchant Onboarding API as follows:

    1. Log in to the Samsung Pay Portal.

    2. In the top-right corner of your dashboard, select Profile menu > Firewall IP & Onboarding API.

    3. Enter an IP address to allowlist, and then click ADD.

      Repeat this step to add all required IPs.

    4. In the Firewall IP List, tick the check boxes for all required IPs.

    5. Click REQUEST.

    6. Enter a message that describes your IP allowlisting request, and then click CONFIRM.

      The server IP addresses are allowlisted and their status changes to Active after Samsung Pay approves the request.

  4. Determine the merchant-service model you want to use.

    Samsung Pay supports 2 models for associating merchants with services. You can structure your merchant onboarding flow to use either model, according to your operational and technical requirements:

    • One-to-one (1:1): A service is associated with a single merchant.

      For example, a payment gateway (PG) with 10 merchants creates 10 services, each linked to one merchant. This model can be used when the merchants operate in different marketplaces, and the PG provides a hosted checkout window that is available for all those merchants.

    • One-to-many (1:N): A service is associated with multiple merchants.

      For example, a PG with 10 merchants creates one service and assigns all 10 merchants to that same service. This model can be used when the merchants all operate in the same marketplace with the same payment processor, and the PG handles settlements for all merchants.