Skip to main content

Payment Points

This topic explains what payment points are and how to manage them.


After signing up to use Payments API, merchant needs to create a payment point.

Single business can have multiple payment points. Each payment point is as a location and it has a MobilePay-assigned PaymentPointId. Establishing multiple payment points is optional but useful for reporting and tracking sales over time. Most customer-related transactions must be to a specific payment point in the API call.

Management of payment points#

Creating, editing payment points is done in MobilePay Portal. The payment point name and bank account are mandatory fields. If no logo image is provided the default one will be used.

Setup payment points

Retrieve a list of payment points#

In order to get the details of payment points like PaymentPointId, you need to use Payment Points API. The following request retrieves information about all payment points for a merchant account usable with Payments API.

Retrieve all payment points
curl \  -X GET \  -H 'x-ibm-client-id: {CLIENT_ID}' \  -H 'Authorization: Bearer {ACCESS_TOKEN}' \  -H 'Content-Type: application/json'
Response JSON example
{  "pageSize": 100,  "nextPageNumber": null,  "paymentPoints": [    {      "paymentPointId": "04e8a246-bc31-425b-928a-10808f8497a0",      "paymentPointName": "test",      "state": "active"    },    {      "paymentPointId": "68170df8-c6e1-4938-915b-c09abce96ae4",      "paymentPointName": "test2",      "state": "active"    }  ]}

Setting up Custom Transfer Reference#

If you have any transactions during the day, then you will receive collected money during the night. MobilePay runs a job that transfers all the money to your specified bank account. There is one transfer per payment point. When configuring payment points you can choose default MobilePay references or set up custom references that would reflect in your bank account statement. One of the use cases is when there is a need to set up automation to transfer money further, i.e. franchisee. Custom transfer reference consists of 20 characters: 19 - set by you and a check digit is always automatically added at the end of the reference. Allowed characters are:

0-9Will not be replaced
YYWill be replaced with the current year
MMWill be replaced with the current month
DDWill be replaced with the current day
RRRWill be replaced with the running number (incremented with each transfer)
X (added automatically)Check digit

Example: Payment point has custom transfer reference set to "RRR5555555555YYMMDD". Reference in bank statement "00155555555552110013" indicates that the transfer was the first transfer for this payment point and it was made on 2021-10-01.