Reference guide contains information about PC server components configuration.

Application System

For each Application System registered on PC, the next params may be configured.

Events receiver address

Address for receiving events and device information, can be set in two ways — by sending Change System Settings API request or via Conflict Resolving Tool (at presence).

Restart of PCS is not needed.

Pay you attention! For device information collecting, Collect events flag is mandatory. Learn more in PC Server REST API reference.

Callback receiver address

Callback receiver address may be set wit PC API request, or by Conflict Resolving Tool (at presence).

PC modules addresses and DB requisites

PC modules addresses changing

PC modules adressess changing method discribed in Installation guide.

DB connection requisites

Only PCS and PCSS modules needs DB connection. For PCS and PCSS there must be different bases.

DB connection requisites setted in Environment variables or in application.yml for each module in sping.datasource section. DB connecion string is set in url parameter. Username (scheme) and passwords in username and password fields.

PC Server configuration

Configurng PCS

Server module is configured via environment variables or via application.yml file.

For the module the next params for connect to PCS database must be set:

spring:
  datasource:
    url: jdbc:postgresql://db-server/pcs-db-name
    username: username
    password: password

And the next parameters may be set:

server:
  port: 8080

spring:
  jpa:
    database-platform: org.hibernate.dialect.PostgreSQLDialect

pc:
  server:
    instance-name: PCS

logging:
  level:
    tech.paycon: info

where,

When you set this params via environment variables, it need to modificate them to uppercase, whit replace dots to underscores and omit dashes. For example:

SPRING_DATASOURCE_URL=jdbc:postgresql://db-server/db-name=info
SPRING_DATASOURCE_USERNAME=username
SPRING_DATASOURCE_PASSWORD=password

Setting parameters

Another configuration params values are set up by sending HTTP POST request to PCS on endpoint http[s]://PCS/pc-api/server_settings with JSON-formatted body, where parameters names is "setting_name" from table below, and with desired value as values, for instance:

{
  "DEBUG_INFO":"1"
}

Values for parameters can also be set in Conflict resolving tool (if available) in the PCS module settings section.

PCS Configuration params

Configuring PCE

External module is configured via environment variables or via application.yml file, and the next params may be set:

server:
  port: 8081

pc:
  external:
    locale: ru
    themes-path: /opt/pc/pc_themes/
    network-timeout: 5000
    deeplink-scheme: paycontrol
    server:
      url: http://localhost:8080/pc-api/
    kyc:
      url: http://localhost:8083/
logging:
  level:
    tech.paycon: info

where,

When you set this params via environment variables, it need to modificate them to uppercase, whit replace dots to underscores and omit dashes.

LOGGING_LEVEL_TECH_PAYCON=info
PC_EXTERNAL_LOCALE=ru
PC_EXTERNAL_THEMESPATH=/opt/pc/pc_themes/
PC_EXTERNAL_NETWORKTIMEOUT=5000
PC_EXTERNAL_DEEPLINKSCHEME=paycontrol
PC_EXTERNAL_SERVER_URL=http://localhost:8080/pc-api/
PC_EXTERNAL_KYC_URL=http://localhost:8083/

Configuring PCP

Push-notifications are sent to notify a user about a new transaction created. It's optional feature, not necessary to implement, especially when PC SDK is integrated into a customer’s mobile app.

To serve different apps with different needs PC Pusher can be configured in following ways:

• to send different push-notification content at transaction creating moment;
• to send push-notifications to different apps via Apple Push Notification Service (APNS) / Google Firebase (FB) / Huawei Messaging Service (HMS) with different credentials.

If you use PayControl / PayConfirm app you have not to customize PC Pusher config.

Pusher module is configured via environment variables or via application.yml file, and the next params may be set:

server:
  port: 8082

pc:
  pusher:
    config-path:

logging:
  level:
    tech.paycon: info

where,

For applying new settings Service must be restarted.

Config files

Location

By default PC Pusher is trying to find config-files by following paths:

/opt/pc/pc_pusher # for linux-based systems
C:\\pc\\pc_pusher # for Windows-based systems

Config content

Config folder content will be interpreted as following

config_root
├── apps
│   └── [app-bundle-id-1].json
│   └── [app-bundle-id-2].json
│   └── [app-bundle-id-N].json
├── systems
│   └── default.json
│   └── [system-id-1].json
│   └── [system-id-N].json
└── pusher.conf.json

• apps folder contains credentials to send notification to different apps
• systems folder contains push-notifications templates
• pusher.conf.json is general config

General config

To customize general PC Pusher options do following

1. Create a folder with default config location or pick your own config location (see config location)
2. Create file [config_root]/pusher.conf.json
3. Put in the file customized values

Default config is following

{
  "notification_status_buffer_size": 1000,
  "proxy": {
    "host": null,
    "port": 3128,
    "username": null,
    "password": null
  },
  "push_tasks_pool": {
    "core_size": 5,
    "max_core_size": 50,
    "queue_size": 500
  },
  "performance_log": false,
  "performance_log_period": 1000
}

You can pick required param only. No need to pick all of the params.

To turn on debug for PC Pusher add to application.yml:

logging:
  level:
    tech.paycon: debug

Apps credentials for your own apps

To add your own app credentials to PC Pusher config do following:

1. Create a folder with default config location or pick your own config location (see config location)
2. Create file [config_root]/apps/[your-app-bundle-id].json (for example com.example.my-best-app.json)
3. Put in the file your credentials

Credentials file content

{
  "android": {
    "type": "service_account",
    "project_id": "...",
    "private_key_id": "...",
    "private_key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----",
    "client_email": "...",
    "client_id": "...",
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://oauth2.googleapis.com/token",
    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
    "client_x509_cert_url": "...",
    "universe_domain": "googleapis.com"
  },
  "ios": {
    "use_fcm": false,
    "apns_p8": {
      "use_dev_gate": false,
      "apns_key_id": "...",
      "apns_team_id": "...",
      "apns_key": "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----"
    }
  },
  "huawei": {
    "client_secret": "...",
    "client_id": "..."
  }
}

1. Your iOS / Android / Huawei apps can have different bundle-ids. In this case, you should pick required section only in credentials-file (for example, only andoird or android and huawei)
2. How to to get android section content - see here
3. apns_key content should be copied from p8-file, provided by APNS configuration in Apple's developer account for your app
4. use_dev_gate param in ios section configures PC Pusher to use APNS Developer Gate (true value) or Production Gate (false value)
5. If you use FCM to send push-notifications to iOS, then set use_fcm value to true in ios section. In this case android section will be used as credentials for iOS-pushes via FCM. Other fields in ios section will be ignored.
6. Values for huawei section should be gathered from Huawei Developer Console for you app

Push-notifications content configuration

Default config

By default PC Pusher is configured to send push-notifications to following apps:

• PayControl (APNS / FB / HMS)
• PayConfirm (APNS / FB / HMS)

Push-notifications content is designed for this apps and can be found in sample Templates file content below.

Set your own push-templates

To set your own push template do following:

1. Create a folder with default config location or pick your own config location (see config location)
2. Create file [config_root]/systems/default.json (for all of system-ids in PC) or [config_root]/systems/[system-id].json (for particular system-id in PC)
3. Put in the file your push templates

Templates file content

{
  "android": {
    "templates": {
      "transaction": [
        {
          "message": {
            "token": "%DEVICE_TOKEN%",
            "android" : {
              "data": {
                "type": "PayControl_v2"
              },
              "notification": {
                "tag": "%USER_ID%",
                "title": "PayControl",
                "body": "Новая операция для подтверждения",
                "icon": "paycontrol_push",
                "sound": "default"
              }
            }
          }
        },
        {
          "message": {
            "token": "%DEVICE_TOKEN%",
            "data": {
              "type": "PayControl_v2",
              "userid": "%USER_ID%",
              "transactionid": "%TRANSACTION_ID%"
            }
          }
        }
      ]
    }
  },
  "ios": {
    "templates": {
      "transaction": [
        {
          "aps": {
            "alert": "Новая операция для подтверждения",
            "sound": "default",
            "badge": 1,
            "mutable-content": 1,
            "category": "NEW_OPERATION"
          },
          "type": "PayControl",
          "userid": "%USER_ID%",
          "transactionid": "%TRANSACTION_ID%",
          "pc_notification_type": "alert",
          "pc_notification_priority": 10,
          "pc_notification_timeout": 600,
          "pc_collapse_id": "%USER_ID%"
        }
      ]
    }
  },
  "huawei": {
    "templates": {
      "transaction": [
        {
          "validate_only": false,
          "message": {
            "android": {
              "notification": {
                "tag": "%USER_ID%",
                "title": "PayControl",
                "body": "Новая операция для подтверждения",
                "icon": "paycontrol_push",
                "click_action": {
                  "type": 3
                }
              }
            },
            "token": [
              "%DEVICE_TOKEN%"
            ]
          }
        },
        {
          "validate_only": false,
          "message": {
            "android": {
              "collapse_key": -1,
              "urgency": "HIGH",
              "ttl": "86400",
              "data": "{\"type\": \"PayControl_v2\",\n\"userid\": \"%USER_ID%\",\"transactionid\": \"%TRANSACTION_ID%\"}"
            },
            "token": [
              "%DEVICE_TOKEN%"
            ]
          }
        }
      ]
    }
  }
}

Templates should be placed in [os-type]->templates->transaction array and MUST be corresponded with APNS / FB / HMS specifications.
Each value in the array is interpreted as particular push-notification (e.g. you can sent a few notifications for one transaction).

Following variables can be used in templates

Appendix

Where to get credentials for Android

PC Pusher does use FCM API to send push-notifications.

To get credentials, please, do following:

1. Open Firebase Console https://console.firebase.google.com/
2. Open your project page
3. Open Project settings for the App or create a new App
4. Go to Cloud Messaging tab
5. Be sure that Firebase Cloud Messaging API (V1) is enabled for your App
6. Click Manage Service Accounts link, Google Cloud Console will be opened
7. Click on your service-account record (should be like firebase-adminsdk-AAAAAA@AAAAAAAA.iam.gserviceaccount.com)
8. Go to Keys tab
9. Click ADD KEY and choose JSON option
10. Save JSON-file, provided by the Console, to your computer
11. Open this file in text-editor, copy its content to android section of your app's credentials-file

Where to get credentials for Huawei

Please, follow the official Huawei docs

Where to get credentials for APNS

1. Go to your Apple Developer Account
2. Click "Certificates"
3. Click "Keys"
4. Click the "+" button
5. Name the Key
6. Click "Enable" on "Apple Push Notifications Service (APNs)"
7. Click "Continue"
8. Click "Register"
9. Click "Download", p8-file will be downloaded

Key ID will be provided to you during key creation process.

Team ID is identifier of your team in Apple Developer program.

Configuring PCCRT

Conflict Resolving Tool module is configured via environment variables or via application.yml file, and the next params may be set:

server:
  port: 8084

pc:
  crt:
    pcs-url: http://localhost:8080/pc-api/

logging:
  level:
    tech.paycon: info

where,

Configuring PCSS

Server Signer module is configured via environment variables or via application.yml file.

For the module the next params for connect to PCSS database must be set:

spring:
  datasource:
    url: jdbc:postgresql://db-server/pcss-db-name
    username: username
    password: password

And the next parameters may be set:

server:
  port: 8083

spring:
  jpa:
    database-platform: org.hibernate.dialect.PostgreSQLDialect

pc:
  signer:
    secret: ********************************
    url: http://localhost:8083/pc-server-signer-api/confirm_async
    pcs-url: http://localhost:8080/pc-api/

logging:
  level:
    tech.paycon: info

where,

Services error codes