Sign inGet started
Docs
Get started

aamarPay API Authentication

How to authenticate aamarPay API requests: one Bearer API key plus a connectionId. MindCloud handles aamarPay's custom auth scheme for you.

Every aamarPay API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your aamarPay account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a aamarPay connection in Connections. aamarPay uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected aamarPay account that should run the action. MindCloud stores and refreshes the aamarPay credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling Search Transaction with an aamarPay connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/aamarPay/actions/search-transaction/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which aamarPay account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Set up your aamarPay connection

You need an aamarPay Store ID and Signature Key. Sandbox and live credentials are different.

  1. Choose your aamarPay environment

    Use the sandbox environment while you are testing. If you need live processing, request live credentials from aamarPay support before you connect the live environment.

    Sandbox Credentials
  2. Copy your Store ID and Signature Key

    Open the official aamarPay credentials documentation or the credential details aamarPay sent you, then copy the Store ID and Signature Key for the environment you chose.

    Sandbox Credentials
  3. Paste the values into MindCloud

    In the MindCloud connection form, enter your Store ID and Signature Key, then save the connection and run the test.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.