TMS
API Reference
Overview

Legacy /api/v2 configuration endpoints are deprecated. Existing integrations can keep using them for now — and refer to the legacy documentation. Plan your move to this version.

What's new

This is the current version of the MMS Service API, on base path /api/openapi/v1. Whether you work with one acquirer or several, this is the version to integrate against.

  • Acquirer bindings live in their own sub-resource. A merchant's acceptance setup is configured through Merchant payment config, which also lets one merchant settle different payment methods through different acquirer profiles if you need that.
  • Acquirer profiles are typed. Each profile has an acqType of card or qr and accepts payment methods of the matching type only — see PaymentMethod.
  • currency is explicit. Merchants, EMV configs, and acquirer profiles all carry a currency, and payment-method bindings are made per (acquirer profile, currency) pair.
  • Deleting a payment config drops a whole binding, not a single payment method — see Delete Payment Config.

Authentication

Every request carries an Authorization: Bearer {jwt} header. See Authentication for how to retrieve your token.

Resources

ResourceUse it to
PBO OwnerLook up the PBO behind your token
EMV ConfigManage the EMV parameter sets referenced by acquirer profiles
Acquirer ProfileManage connections to acquirer hosts
MerchantManage merchants and their payment config
DeviceIssue activation codes and manage terminals
TransactionLook up, void, refund and capture transactions
SettlementView and trigger settlement batches