Partner Payments Deposit

The Partner Payments Deposit API enables partners to notify the system about funds they've deposited into the designated wallet address (provided in the deposit instructions). After the system verifies this payment transaction, an equivalent amount of partner utility tokens is minted directly to the partner's account. These tokens can then be used for various payment operations within the platform.

Example Payload:

{
  "transactionHash": "23RE436L8B1mrP7Nq0FQolg7FUKteMesh7Uh3yPu3EKMvAyjEEuNeha8uaej4r5rCwKqzbTREuwA9qvZkKgodQ5A",
  "base64Signature": "0E/r1DoY8Zi3Quuk54X9qg7OrWwbYNzxXa1Iot9YMCKkQfpM+DHvHi6pkJUVyRHs/Q4iiCpJClFEkZu6gpr8Aw=="
}

Request Body

Parameter	Type	Required	Description
transactionHash	string	Yes	The hash of the deposit transaction made on the blockchain.
base64Signature	string	Optional	A Base64-encoded signature of the `transactionHash`, created using the private key of the wallet that initiated the transaction. This signature proves ownership of the transaction.

Signature Generation(optional)

The base64Signature field is essential for verifying that you are the rightful owner of the transaction. To generate this signature:

Use the same private key/wallet that initiated the blockchain transaction

Sign the transactionHash value as the message

Encode the resulting signature in Base64 format
You can generate this signature using a publicly available, open-source tool: Solana Message Signer

This security measure prevents unauthorized users from claiming deposits made by others and ensures that only legitimate deposit claims are processed.

Example Response:

{
  "success": true,
  "data": {
    "mintTransactionHash": "3We4SfK0sn3eD5spVNlLJtc23JNTj7R28pAy1bH9oksxHq88p6UbXbag6XNwbaRWPwhi6vz5t2o981usJxKtZ8kMhi",
    "mintAddress": "14jX8fW3qZRejGTpAs9YDmACWidDrABCPqR3Spjcbljn4",
    "amountMinted": 0.6
  }
}

The response includes:

mintTransactionHash: The hash of the mint transaction which was created to mint the deposit equivalent of partner payment token. This represents the transaction that credits your account.

mintAddress: The address of the partner payment token that was created or credited in your account.

amountMinted: The amount that was credited to your account based on the deposit.

Complete Deposit Process

Follow these steps to successfully deposit funds to your partner payments account:

Get Deposit Instructions

GET /api/v1/transformer/payments/balance

Note the chain, network, currency, tokenAddress, and toWalletAddress from the response.

Make the Deposit

Send funds to the specified toWalletAddress using the correct blockchain network

Use the correct token as specified in the deposit instructions

Save the transaction hash from this transaction

Generate Signature(optional)

Use the same wallet/private key that initiated the transaction

Sign the transaction hash as a message

Encode the signature in Base64 format

You can use the publicly available Solana Message Signer tool for this step

Notify About the Deposit

POST /api/v1/transformer/payments/deposit

Include both the transaction hash and the Base64 signature in the request body.

Verify the Deposit

Check the response to confirm the deposit was successful

You can also call the Partner Payments Balance API again to verify your updated balance

Usage Notes

Each transaction hash can only be used for a single deposit. Attempting to reuse a transaction hash will result in an error.

The deposit amount credited is determined based on the actual amount transferred in the blockchain transaction.

After a successful deposit, your balance can be used for various payment operations without including a transaction hash in each operation.

The signature verification ensures that only the rightful owner of a transaction can claim the deposit, preventing fraudulent claims.

Partner Payments Deposit

Request Body#

Signature Generation(optional)#

Complete Deposit Process#

Usage Notes#

Request

Responses

Request Body

Signature Generation(optional)

Complete Deposit Process

Usage Notes