How To Implement


How To Implement Payment Link

To get started, you should provide the Magnatefy account team with the following:

  • Account

  • Redirects

    • Success Redirect Base URL

    • Fail Redirect Base URL

  • Your account team will then provide your:

    • User link UUID

    • Product(s) Page link UUID

    • SHA-1 Secret Key link

Entry Links

Each client’s session begins with an entry link unique to that client. Entry links are generated by the user using the following client:

  • Base URL

  • Required Parameters

  • Optional Parameters

  • Hash Signature

{info} Note: Following the base URL, the available parameters can be applied to the URL string in any given order, but the hash signature must be appended to the end of the URL string.

Base URL

All Payment Link entry links begin with: https://magnatefy.com/api/v1/payment

Required Parameters

Entry links must contain the following required parameters. Parameter names should be lower case.​

Entry Link Parameters - Required

Variable Description
sid Your user link UUID provided by Magnatefy. Example: sid=835b35a1-4779-4ea5-ad0d-8061eac02a04
cid Unique panelist identifier defined by user. May contain alphanumeric characters only, no special characters except underscore and dash. 128 character limit. Example: pid=TestProd001_19-781
pid Your product(s) page link UUID provided by Magnatefy. Example: pid=835b35a1-4779-4ea5-ad0d-8061eac02a05

Example Entry Link With Required Parameters

https://magnatefy.com/api/v1/payment?sid=835b35a1-4779-4ea5-ad0d-8061eac02a04&pid=835b35a1-4779-4ea5-ad0d-8061eac02a05&cid=TestProduct001&

Optional Parameters

Entry Link Parameters - Optional

Parameter names should be lower case.​

Variable Description
gid Your product link UUID provided by Magnatefy to redirect directly to the payment page for the selected product. Example: gid=835b35a1-4779-4ea5-ad0d-8061eac02a06
mid Custom variable for additional client identifier data. Must contain alphanumeric characters only, no special characters except underscore and dash. 128 character limit.

Example Entry Link With Optional Parameters

https://magnatefy.com/api/v1/payment?sid=bm1dk26e-ae93-474a-adb1-e19cd686619&pid=835b35a1-4779-4ea5-ad0d-8061eac02a05s&mid=testUserMID&gid=835b35a1-4779-4ea5-ad0d-8061eac02a06&

Hash Signature

HMAC SHA1 hash signature of the entire URL. More details: Security

Example Entry Link with Hash Signature

Before Hash added:

https://magnatefy.com/api/v1/payment?sid=bm1dk26e-ae93-474a-adb1-e19cd686619&pid=835b35a1-4779-4ea5-ad0d-8061eac02a05s&mid=testUserMID&gid=835b35a1-4779-4ea5-ad0d-8061eac02a06&

After Hash added:

https://magnatefy.com/api/v1/payment?sid=bm1dk26e-ae93-474a-adb1-e19cd686619&pid=835b35a1-4779-4ea5-ad0d-8061eac02a05s&mid=testUserMID&gid=835b35a1-4779-4ea5-ad0d-8061eac02a06&hash=yESPcX92n5TiYZbPud89uFYhvkM

Not Permitted:

https://magnatefy.com/api/v1/payment?sid=bm1dk26e-ae93-474a-adb1-e19cd686619&pid=835b35a1-4779-4ea5-ad0d-8061eac02a05s&mid=testUserMID&hash=yESPcX92n5TiYZbPud89uFYhvkM&gid=835b35a1-4779-4ea5-ad0d-8061eac02a06