Developer Docs - Tierlock

1. Create a Link

Use this URL structure (replace placeholders with your credentials and values):

https://app.payken.io/tip/merchant_id=yourMerchantId&merchant_secret=yourMerchantSecret?display_name=DonationName&user_id=user@example.com&total=amount&type=tip&order_id=orderId

Required Parameters

merchant_id: Your unique Merchant ID
merchant_secret: Your secret key for authentication

Query Parameters

display_name: Company Name
user_id: Customer email or user ID
total: Amount to collect (e.g. 10.00)
type: Must be tip
order_id: Unique reference automated
lang (optional): ISO 639‑1 code (e.g. es, fr)
currency_code (optional): Default USD (e.g. EUR, GBP)

2. Code Examples

HTML

<a href="https://app.payken.io/tip/merchant_id=...&merchant_secret=...?display_name=...&user_id=...&total=...&type=tip&order_id=...">Donate Now</a>

WordPress (PHP)

<?php
echo '<a href="'.esc_url('https://app.payken.io/tip/merchant_id=...&merchant_secret=...?display_name=...&user_id=...&total=...&type=tip&order_id=...').'">' .
     'Donate Now</a>';
?>

React

import React from 'react';
export default () => (
  <a href="https://app.payken.io/tip/merchant_id=...&merchant_secret=...?display_name=...&user_id=...&total=...&type=tip&order_id=...">
    Donate Now
  </a>
);

3. Handle Return URLs

After completion or cancellation, Tierlock redirects to your return URL with:

?status=SUCCESS|FAILED
&status_code=201|400
&transaction_id=TRANSACTION_ID
&order_id=YOUR_ORDER_ID
&amount=AMOUNT
&payment_type=tip

4. Retrieve Details

Use Tierlock’s API endpoints:

List All Transactions

POST https://api.payken.io/api/v1/auth/getinvoiceusersdetails
Body:
{
  "merchant_id":"yourMerchantId",
  "merchant_secret":"yourMerchantSecret",
  "user_info":"user@example.com",
  "page":1
}

Single Transaction by ID

POST https://api.payken.io/api/v1/auth/paymentData
Body:
{
  "merchant_id":"yourMerchantId",
  "merchant_secret":"yourMerchantSecret",
  "user_info":"user@example.com",
  "id":"TRANSACTION_ID"
}

Need Help?

Contact support@tierlock.com for personalized assistance.

Integration Guide