# Getting Started

Payment Bridge API is a straightforward API composed of a single endpoint, which can have multiple payloads for each of the necessary actions.

# Prerequisites

To begin using this API you must keep into account the following prerequisites and initial steps.

  1. You must generate the necessary API credentials such as appId and private key by creating a cloud app. Remember to make sure that your Application has a "Cloud Messages" WRITE permission.

  2. Use the Merchant Login URL of your application to Authorize one of your test merchants.

# Terminal Connectivity

Terminals maintain a consistent connection to the Poynt cloud, but from time to time the connection may be dropped. By default, terminals send a ping message to check if the connection is active every 5 minutes.

Nevertheless, we recommend setting a more aggressive connectivity profile to ensure that the connection does not get dropped by sending the following message to the terminal:

{
  "ttl": 86400,
  "businessId": "{{bizId}}",
  "storeId": "{{strId}}",
  "deviceId": "{{deviceId}}",
  "data": "{\"action\":\"setCustomPcmProfile\"}"
}

The message does not use a callback URL as it does not require a postback. if you are testing this on a developer terminal, you can confirm that the profile has been applied by checking the logcat:

I//PcmService.java:671( 2202): main PcmService: onStartCommand: ACTION_SET_PCM_PROFILE
I//PcmService.java:338( 2202): main PCM Saving profile to sys prop: PCM_PROFILE: PAYMENT BRIDGE,true,4000,30000,30000,30000,0,0
Last Updated: 4/2/2024, 6:17:20 AM