↔️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

Body

application/json

thirdPartyIdstring

Third party unique transaction id.

userIdstring

Tyga user id.

amountnumber

Amount to credit.

notifyUrlstring

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

Response

200409500

Payout request successfully created.

Body

application/json

transactionIdstring

Unique Id for the transaction.

thirdPartyIdstring

Unique Id of the third party involved in the transaction.

Request

JavaScriptCurlPython

const response = await fetch('/transactions/payout', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

Create a staking payout transaction.

POST/transactions/staking/payout

Header parameters

Body

application/json

thirdPartyIdstring

Third party unique transaction id.

userIdstring

Tyga user id.

usdAmountnumber

USD amount to stake.

assetenum

Type of staking - Supported KRU

KRU

durationInMonthsnumber

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

Response

200409500

Staking Payout request successfully created.

Body

application/json

transactionIdstring

Unique Id for the transaction.

thirdPartyIdstring

Unique Id of the third party involved in the transaction.

Request

JavaScriptCurlPython

const response = await fetch('/transactions/staking/payout', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

Revoke Staking Payout

Revoke a staking payout transaction.

POST/transactions/staking/payout/revoke

Header parameters

Body

application/json

transactionIdstring

Transaction Id for the staking request.

Response

200500

Revoked Staking Transaction Successfully.

Body

application/json

transactionIdstring

Unique Id for the transaction.

thirdPartyIdstring

Unique Id of the third party involved in the transaction.

Request

JavaScriptCurlPython

const response = await fetch('/transactions/staking/payout/revoke', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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/transactions/users

Query parameters

Header parameters

Response

200409500

OK

Body

application/json

idstring

The unique Id of the transaction.

userIdstring

The Id of the user who initiated the transaction.

tenantIdstring

The Id of the tenant associated with the transaction.

statusstring

The current status of the transaction.

amountnumber

The amount of the transaction.

Request

JavaScriptCurlPython

const response = await fetch('/transactions/users?userId=text', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();

Response

200

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

Search Transactions

Fetches a transaction by order number or transaction hash.

GET/transactions

Query parameters

Header parameters

Response

200400500

OK

Body

application/json

idstring

The unique Id of the transaction.

userIdstring

The Id of the user who initiated the transaction.

tenantIdstring

The Id of the tenant associated with the transaction.

statusstring

The current status of the transaction.

sidestring

The side of the transaction.

typestring

The type of the transaction.

orderIdstring

The order Id associated with the transaction.

orderNumberstring

The order number associated with the transaction.

amountnumber

The amount of the transaction.

txHashstring

The transaction hash.

createdDatestring (date-time)

The date the transaction was created.

completedDatestring (date-time)

The date the transaction was completed.

Request

JavaScriptCurlPython

const response = await fetch('/transactions', {
    method: 'GET',
    headers: {
      "x-tenant-id": "text",
      "x-api-key": "text",
      "x-api-hash": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "userId": "text",
  "tenantId": "text",
  "status": "text",
  "side": "text",
  "type": "text",
  "orderId": "text",
  "orderNumber": "text",
  "amount": 0,
  "txHash": "text",
  "createdDate": "2024-11-21T07:30:15.722Z",
  "completedDate": "2024-11-21T07:30:15.722Z"
}

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

Body

application/json

txIdstring

Payment transaction id.

emailstring

TygaPay account email that will receive the refund.

Response

200500

Refund Payment Transaction Successfully.

Body

application/json

statusstring

Status of the refund transaction.

messagestring

Message indicating the status of the refund transaction.

Request

JavaScriptCurlPython

const response = await fetch('/transactions/refund', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "x-api-hash": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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