Transaction request
Transaction request API specification
Generate 🔓
To create a transaction request as a dApp, you will need to provide a sign in token and a transaction.
Create a new transaction request with a signInToken and a transaction object
application/json
application/json
The timestamp of the request
The signature of the request
The API key of the dApp
The signIn token that was used to create the transaction request
The transaction request content
{"cellProvider":null,"cellDeps":[],"headerDeps":[],"inputs":[],"outputs":[],"witnesses":[],"fixedEntries":[],"signingEntries":[],"inputSinces":{}}
POST /api/transaction-request HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"signInToken": "text",
"transaction": {}
}
{
"id": 1,
"transactionToken": "text",
"status": "pending",
"transaction": {
"id": 1,
"transactionHash": "text",
"transaction": {}
},
"createdAt": "2025-07-24T00:25:31.327Z",
"expiresAt": "2025-07-24T00:25:31.327Z",
"signInRequest": {
"id": 1,
"signInToken": "text",
"status": "pending",
"createdAt": "2025-07-24T00:25:31.327Z",
"expiresAt": "2025-07-24T00:25:31.327Z",
"sessionExpiresAt": "2025-07-24T00:25:31.327Z"
}
}
Remember that to create a transaction request successfully you need to provide a signed sign in token. If the provided token is not signed your request will be rejected.
This is a protected call which uses API authentication. See how to implement it in API authentication section.
Get
With the provided transaction token, this method will return all pertinent information from the transaction request, including the sign in request and transaction data
Transaction request identifier
application/json
application/json
GET /api/transaction-request/{transactionToken} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
{
"id": 1,
"transactionToken": "text",
"status": "pending",
"transaction": {
"id": 1,
"transactionHash": "text",
"transaction": {}
},
"createdAt": "2025-07-24T00:25:31.327Z",
"expiresAt": "2025-07-24T00:25:31.327Z",
"signInRequest": {
"id": 1,
"signInToken": "text",
"status": "pending",
"createdAt": "2025-07-24T00:25:31.327Z",
"expiresAt": "2025-07-24T00:25:31.327Z",
"sessionExpiresAt": "2025-07-24T00:25:31.327Z"
}
}
Last updated