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

Transactions - old

Here is the complete Transactions API page for Reveel PayID. It includes detailed request/response formats, error cases, and a parameter reference table.


Parameter Reference

Field
Type
Required
Description

userId

string

Yes

Sender’s user ID

recipientPayId

string

Required*

PayID of the recipient (optional if walletAddress is provided)

walletAddress

string

Required*

Recipient's wallet address (alternative to PayID)

amount

number

Yes

Amount to send

token

string

Yes

Token symbol (e.g. ETH, USDC)

network

string

Yes

Network symbol (e.g. ETH, POL, BNB)

message

string

Optional

Optional message

privateKey

string

Yes (in test endpoint)

Sender's private key for testing submission

transaction

object

Yes (in test endpoint)

Raw transaction object for signing

confirmed

boolean

Yes (webhook)

Whether the tx is confirmed

txs

object[]

Yes (webhook)

Array of transaction metadata

page

number

Optional

Page number (for activity pagination)

pageSize

number

Optional

Items per page (pagination)

1. Initialize Transaction

POST /transact/init-transaction Authentication: Required

Description

Initializes a payment transaction for a user. The API computes routing logic, swap requirements, fees, and returns all data needed to sign and broadcast the transaction.

Request Body

Note: Either recipientPayId or walletAddress must be provided.

Success Response — 200 OK

Error Responses

HTTP Code
Description

400 Bad Request

Missing fields, invalid types, unsupported token or network

404 Not Found

PayID or wallet not found

500 Internal Server Error

Transaction setup failed

Example:


2. Transaction Webhook

POST /transact/txn-webhook Authentication: None Description: Receives real-time transaction confirmations (from Moralis or equivalent).

Request Body

Success Response — 200 OK

Error Responses

HTTP Code
Description

200 OK

If payload is invalid, returns success: false with error message

500 Internal Server Error

Unexpected error during processing


3. Get User Activity

GET /transact/get-activity Authentication: Required

Query Parameters

  • userId (string, required)

  • page (number, optional, default: 1)

  • pageSize (number, optional, default: 10)

Success Response — 200 OK

Error Responses

HTTP Code
Description

400 Bad Request

Missing userId

401 Unauthorized

Invalid/missing API key

500 Internal Server Error

Data fetch failed

Last updated

Was this helpful?