↔️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 [e-mail] to configure your preferred payout process.

• Tenant Distribution Wallets can be funded via bank transfers or crypto deposits. Contact [e-mail] 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

/transactions/payout

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

thirdPartyIdstring

Third party unique transaction id.

userIdstring

Tyga user id.

amountnumber

Amount to credit.

notifyUrlstring

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/transactions/payout' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "thirdPartyId": "text",
    "userId": "text",
    "amount": 1,
    "notifyUrl": "text"
  }'

200

409

500

200

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

Payout request successfully created.

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 [e-mail].

Create a staking payout transaction.

post

/transactions/staking/payout

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

thirdPartyIdstring

Third party unique transaction id.

userIdstring

Tyga user id.

usdAmountnumber

USD amount to stake.

assetstring · enum

Type of staking - Supported KRU

Options: KRU

durationInMonthsnumber

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/transactions/staking/payout' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "thirdPartyId": "text",
    "userId": "text",
    "usdAmount": 1,
    "asset": "KRU",
    "durationInMonths": 1
  }'

200

409

500

200

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

Staking Payout request successfully created.

Revoke Staking Payout

Revoke a staking payout transaction.

post

/transactions/staking/payout/revoke

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

transactionIdstring

Transaction Id for the staking request.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/transactions/staking/payout/revoke' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "transactionId": "text"
  }'

200

500

200

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

Revoked Staking Transaction Successfully.

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

/transactions/users

Query parameters

idstring

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/transactions/users?userId=text' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

409

500

200

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

OK

Search Transactions

Fetches a transaction by order number or transaction hash.

get

/transactions

Query parameters

txHashstring

The transaction hash to retrieve.

orderNumberstring

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/transactions' \
  --header 'x-tenant-id: text' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

400

500

200

{
  "id": "text",
  "userId": "text",
  "tenantId": "text",
  "status": "text",
  "side": "text",
  "type": "text",
  "orderId": "text",
  "orderNumber": "text",
  "amount": 1,
  "txHash": "text",
  "createdDate": "2025-03-13T17:00:39.949Z",
  "completedDate": "2025-03-13T17:00:39.949Z"
}

OK

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

/transactions/refund

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

txIdstring

Payment transaction id.

emailstring

TygaPay account email that will receive the refund.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/transactions/refund' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "txId": "text",
    "email": "text"
  }'

200

500

200

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

Refund Payment Transaction Successfully.