Authentication and API End Points

Authentication with the mCommerce SDK

The mCommerce SDK needs to know for which merchant it should process a transaction. Therefore you need to initialize the mCommerce SDK with two parameters:

profileToken
The profileToken identifies the merchant which should receive the payment. It never changes as long as the merchant exists and should be kept private.
applicationIdentifier
The applicationIdentifier identifies your application on the platform. Each application has its own set of merchants and transactions.
You will receive a profileToken and an applicationIdentifier from your account manager for immediate testing. This allows you to quickly test the integration of the mCommerce SDK into your app and to accept test payments. For actual live processing later on, you will a have a separate profileToken for each merchant.

Authentication with the Platform

Your backend system needs to authenticate itself to use the platform APIs. You will receive the following credentials from your account manager:

apiIdentifier
The apiIdentifier identifies your backend on the platform and is tied to a set of permissions you are allowed to perform on the API. They include retrieval of events for the WebHooks.
apiSecretKey
The apiSecretKey ensures that its really you who is using the apiIdentifier.
applicationIdentifier
The applicationIdentifier identifies your application on the platform. Each application has its own set of merchants and transactions.

For each HTTP request your backend makes to the platform API, make sure to send along the following Authorization HTTP header:

payworks-apiIdentifier apiIdentifier=<API_IDENT.>,apiSecretKey=<API_SECRET_KEY>
You will receive a separate pair of apiIdentifier and apiSecretKey for both the test and the live platform. Make sure to use the right pair depending on whether you want to perform test or live transactions.

API End Points

All partial URLs in this guide are specified relative to one of these two end points:
https://test.payworks.io
This is the test platform. Use it to get started with your integration and to perform test transactions.
https://api.payworks.io
This is the production platform. Use it for live transaction processing.

Can we help you?

If you cannot find your answer, contact us and we'll get in touch with you soon.

© Copyright 2018 Payworks GmbH. Legal.