Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

↔️Transactions

API's to manage Transactions.

Production URL: https://transactions-v1-api-rdqehkur6a-ey.a.run.app

Create Payout Request

Payouts can be created for users which will be deducted from the Tenant Distribution Wallet.

Good to know:

  • Payouts can be processed automatically or manually via the TygaPay dashboard. Contact support@tygapay.com to configure your preferred payout process.

  • Tenant Distribution Wallets can be funded via bank transfers or crypto deposits. Contact support@tygapay.com for more information.

Create a payout request that will credit a user's balance. All credits will be locked/pending until the funds are confirmed.

post
Header parameters
x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Body
thirdPartyIdstringOptional

Third party unique transaction id.

userIdstringOptional

Tyga user id.

amountnumberOptional

Amount to credit.

notifyUrlstringOptional

URL to notify after the payout is completed. (Webhook)

Responses
200

Payout request successfully created.

application/json
transactionIdstringOptional

Unique Id for the transaction.

thirdPartyIdstringOptional

Unique Id of the third party involved in the transaction.

post/transactions/payout
POST /transactions/payout HTTP/1.1
Host: transactions-v1-api-rdqehkur6a-ey.a.run.app
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "thirdPartyId": "text",
  "userId": "text",
  "amount": 1,
  "notifyUrl": "text"
}
{
  "transactionId": "text",
  "thirdPartyId": "text"
}

Create Staking Payout Request

Staking allows users to earn rewards by holding and locking their cryptocurrencies over a period.

Good to know:

  • Rewards are calculated based on the asset configuration.

  • For more details about staking terms and conditions, please contact support@tygapay.com.

Create a staking payout transaction.

post
Header parameters
x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Body
thirdPartyIdstringOptional

Third party unique transaction id.

userIdstringOptional

Tyga user id.

usdAmountnumberOptional

USD amount to stake.

assetstring · enumOptional

Type of staking - Supported KRU

Possible values:
durationInMonthsnumberOptional

Staking duration in months. Defaults to 3 months if not set.

Responses
200

Staking Payout request successfully created.

application/json
transactionIdstringOptional

Unique Id for the transaction.

thirdPartyIdstringOptional

Unique Id of the third party involved in the transaction.

post/transactions/staking/payout
POST /transactions/staking/payout HTTP/1.1
Host: transactions-v1-api-rdqehkur6a-ey.a.run.app
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "thirdPartyId": "text",
  "userId": "text",
  "usdAmount": 1,
  "asset": "KRU",
  "durationInMonths": 1
}
{
  "transactionId": "text",
  "thirdPartyId": "text"
}

Revoke Staking Payout

Revoke a staking payout transaction.

post
Header parameters
x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Body
transactionIdstringOptional

Transaction Id for the staking request.

Responses
200

Revoked Staking Transaction Successfully.

application/json
transactionIdstringOptional

Unique Id for the transaction.

thirdPartyIdstringOptional

Unique Id of the third party involved in the transaction.

post/transactions/staking/payout/revoke
POST /transactions/staking/payout/revoke HTTP/1.1
Host: transactions-v1-api-rdqehkur6a-ey.a.run.app
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "transactionId": "text"
}
{
  "transactionId": "text",
  "thirdPartyId": "text"
}

Payout Completed Notify Url

POST https://your-notify-url

Request Body

Name
Type
Description

transactionId*

string

Unique Transaction Id.

thirdPartyId*

string

Unique Id of the third party involved in the transaction.

amount*

number

The transaction payout amount.

status*

string

success: Payout has been processed successfully. cancelled: Payout has been cancelled.

Get User Transactions

Fetches a list of transactions for a user.

get
Query parameters
idstringOptional

The Id of the transaction to retrieve.

userIdstringRequired

The Id of the user whose transactions to retrieve.

Header parameters
x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Responses
200

OK

application/json
idstringOptional

The unique Id of the transaction.

userIdstringOptional

The Id of the user who initiated the transaction.

tenantIdstringOptional

The Id of the tenant associated with the transaction.

statusstringOptional

The current status of the transaction.

amountnumberOptional

The amount of the transaction.

get/transactions/users
GET /transactions/users?userId=text HTTP/1.1
Host: transactions-v1-api-rdqehkur6a-ey.a.run.app
x-api-key: text
x-api-hash: text
Accept: */*

[
  {
    "id": "text",
    "userId": "text",
    "tenantId": "text",
    "status": "text",
    "amount": 1
  }
]

Search Transactions

Fetches a transaction by order number or transaction hash.

get
Query parameters
txHashstringOptional

The transaction hash to retrieve.

orderNumberstringOptional

The order number to retrieve.

Header parameters
x-tenant-idstringRequired

The tenant ID.

x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Responses
200

OK

application/json
idstringOptional

The unique Id of the transaction.

userIdstringOptional

The Id of the user who initiated the transaction.

tenantIdstringOptional

The Id of the tenant associated with the transaction.

statusstringOptional

The current status of the transaction.

sidestringOptional

The side of the transaction.

typestringOptional

The type of the transaction.

orderIdstringOptional

The order Id associated with the transaction.

orderNumberstringOptional

The order number associated with the transaction.

amountnumberOptional

The amount of the transaction.

txHashstringOptional

The transaction hash.

createdDatestring · date-timeOptional

The date the transaction was created.

completedDatestring · date-timeOptional

The date the transaction was completed.

get/transactions
GET /transactions HTTP/1.1
Host: transactions-v1-api-rdqehkur6a-ey.a.run.app
x-tenant-id: text
x-api-key: text
x-api-hash: text
Accept: */*

{
  "id": "text",
  "userId": "text",
  "tenantId": "text",
  "status": "text",
  "side": "text",
  "type": "text",
  "orderId": "text",
  "orderNumber": "text",
  "amount": 1,
  "txHash": "text",
  "createdDate": "2026-01-01T00:00:00.000Z",
  "completedDate": "2026-01-01T00:00:00.000Z"
}

Refund Pending Confirmation Transactions

In some instances, customers may make a duplicate payment or send a payment to a crypto wallet address that is no longer associated with an order. In such cases, the payment will remain unlinked to an order and be placed in a 'pending_confirmation' status until it can be confirmed or refunded.

Refund Pending Confirmation Payment Transactions.

post
Header parameters
x-api-keystringRequired

Your unique API Key.

x-api-hashstringRequired

Your API Hash.

Body
txIdstringOptional

Payment transaction id.

emailstringOptional

TygaPay account email that will receive the refund.

Responses
200

Refund Payment Transaction Successfully.

application/json
statusstringOptional

Status of the refund transaction.

messagestringOptional

Message indicating the status of the refund transaction.

post/transactions/refund
POST /transactions/refund HTTP/1.1
Host: transactions-v1-api-rdqehkur6a-ey.a.run.app
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "txId": "text",
  "email": "text"
}
{
  "status": "text",
  "message": "text"
}

PreviousUsers
NextOrders

Last updated