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.

A partial transaction is a transaction with the TransactionSkeletonType format specified in the library Lumos. You need to attach the necessary fields that you want your transaction to have so that it can be processed by the API.

Each transaction request has 7 days to be signed or rejected before it expires.

Create a new transaction request with a signInToken and a transaction object

POST/api/transaction-request

Header parameters

Body

application/json

signInToken*string

The signIn token that was used to create the transaction request

transaction*object

The transaction request content

Response

201403404

Body

application/json

id*number

transactionToken*string

status*enum

pendingsignedexpireddeclined

transaction*TransactionDto (object)

createdAt*string (date-time)

expiresAt*string (date-time)

signInRequest*SimpleSignInRequestDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/transaction-request', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "signInToken": "text"
    }),
});
const data = await response.json();

Response

{
  "id": 0,
  "transactionToken": "text",
  "status": "pending",
  "transaction": {
    "id": 0,
    "transactionHash": "text"
  },
  "createdAt": "2024-04-29T13:29:09.763Z",
  "expiresAt": "2024-04-29T13:29:09.763Z",
  "signInRequest": {
    "id": 0,
    "signInToken": "text",
    "status": "pending",
    "createdAt": "2024-04-29T13:29:09.763Z",
    "expiresAt": "2024-04-29T13:29:09.763Z",
    "sessionExpiresAt": "2024-04-29T13:29:09.763Z"
  }
}

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

GET/api/transaction-request/{transactionToken}

Path parameters

transactionToken*string

Transaction request identifier

Header parameters

Response

200

Body

application/json

id*number

transactionToken*string

status*enum

pendingsignedexpireddeclined

transaction*TransactionDto (object)

createdAt*string (date-time)

expiresAt*string (date-time)

signInRequest*SimpleSignInRequestDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/transaction-request/{transactionToken}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 0,
  "transactionToken": "text",
  "status": "pending",
  "transaction": {
    "id": 0,
    "transactionHash": "text"
  },
  "createdAt": "2024-04-29T13:29:09.763Z",
  "expiresAt": "2024-04-29T13:29:09.763Z",
  "signInRequest": {
    "id": 0,
    "signInToken": "text",
    "status": "pending",
    "createdAt": "2024-04-29T13:29:09.763Z",
    "expiresAt": "2024-04-29T13:29:09.763Z",
    "sessionExpiresAt": "2024-04-29T13:29:09.763Z"
  }
}