Transaction Status

This endpoint allows you to retrieve the status and details of transactions that have been submitted for analysis.

URL: https://app.rillis.io/api/v1/verification/get

Method: GET

Request

Authentication Parameters

Parameter	Type	Required	Description
client_id	String	Yes	Your unique client identifier (as a query parameter).
client_secret	String	Yes	Your secret key for API authentication (as a query parameter).

Query Parameters

Parameter	Type	Required	Description
client_transaction_id	String	No	The unique identifier for the transaction assigned by your system. If provided, only the transaction with this ID will be returned.
transaction_id	String	No	The unique identifier for the transaction in the Rillis system. If provided, only the transaction with this ID will be returned.
page	Number	No	Page number for pagination. Default is 1.
limit	Number	No	Number of transactions to return per page. Default is 10, maximum is 100.
status	String	No	Filter transactions by status. Possible values: "PENDING", "IN_PROGRESS", "COMPLETED", "REJECTED", "MANUAL_REVIEW".
start_date	Number	No	Unix timestamp (milliseconds) to filter transactions created after this date.
end_date	Number	No	Unix timestamp (milliseconds) to filter transactions created before this date.

Note: You must provide either client_transaction_id or transaction_id to retrieve a specific transaction. If neither is provided, the endpoint will return a paginated list of all transactions.

Example Request (Single Transaction)

GET https://app.rillis.io/api/v1/verification/get?client_id=your_client_id&client_secret=your_client_secret&client_transaction_id=transaction_12345

Example Request (Multiple Transactions)

GET https://app.rillis.io/api/v1/verification/get?client_id=your_client_id&client_secret=your_client_secret&page=1&limit=20&status=COMPLETED&start_date=1684270800000&end_date=1684357200000

Response

Single Transaction Response

When querying for a specific transaction (using client_transaction_id or transaction_id), a successful request will return a JSON response with the following properties:

Parameter	Type	Description
success	Boolean	Indicates whether the request was successful.
transaction	Object	An object containing the transaction details.
transaction.transaction_id	String	The unique identifier for the transaction in the Rillis system.
transaction.client_transaction_id	String	The unique identifier for the transaction assigned by your system.
transaction.transaction_type	String	Transaction type: "fiat" or "crypto".
transaction.sending_dollar_amount	Number	Amount in US dollars.
transaction.sending_amount	Number	Amount sent by the sender.
transaction.sending_currency	String	Currency sent by the sender.
transaction.receiving_amount	Number	Amount received by the beneficiary.
transaction.receiving_currency	String	Currency received by the beneficiary.
transaction.crypto_network	String or null	Type of cryptocurrency network (for crypto transactions).
transaction.crypto_asset	String or null	Type of asset (for crypto transactions).
transaction.sending_wallet	String or null	Sender's wallet address (for crypto transactions).
transaction.receiving_wallet	String or null	Beneficiary's wallet address (for crypto transactions).
transaction.status	String	Current status of the transaction.
transaction.reasons_rejection_analysis	String or null	Rejection reason specified by the analysis (if rejected).
transaction.reasons_rejection_operator	String or null	Rejection reason specified by the operator (if rejected).
transaction.rejected_at	Number or null	Timestamp when the transaction was rejected (if rejected).
transaction.analyzed_at	Number or null	Timestamp when the transaction was analyzed.
transaction.created_at	Number	Timestamp when the transaction was created.

Example Single Transaction Response

{
  "success": true,
  "transaction": {
    "transaction_id": "rillis_tx_12345",
    "client_transaction_id": "transaction_12345",
    "transaction_type": "fiat",
    "sending_dollar_amount": 100,
    "sending_amount": 100,
    "sending_currency": "USD",
    "receiving_amount": 92,
    "receiving_currency": "EUR",
    "crypto_network": null,
    "crypto_asset": null,
    "sending_wallet": null,
    "receiving_wallet": null,
    "status": "COMPLETED",
    "reasons_rejection_analysis": null,
    "reasons_rejection_operator": null,
    "rejected_at": null,
    "analyzed_at": 1684356854091,
    "created_at": 1684356824091
  }
}

Multiple Transactions Response

When querying for multiple transactions, a successful request will return a JSON response with the following properties:

Parameter	Type	Description
success	Boolean	Indicates whether the request was successful.
transactions	Array	An array of transaction objects, each containing the same properties as in the single transaction response.
total	Number	Total number of transactions matching the query criteria.
page	Number	Current page number.
limit	Number	Number of transactions per page.
total_pages	Number	Total number of pages.

Example Multiple Transactions Response

{
  "success": true,
  "transactions": [
    {
      "transaction_id": "rillis_tx_12345",
      "client_transaction_id": "transaction_12345",
      "transaction_type": "fiat",
      "sending_dollar_amount": 100,
      "sending_amount": 100,
      "sending_currency": "USD",
      "receiving_amount": 92,
      "receiving_currency": "EUR",
      "crypto_network": null,
      "crypto_asset": null,
      "sending_wallet": null,
      "receiving_wallet": null,
      "status": "COMPLETED",
      "reasons_rejection_analysis": null,
      "reasons_rejection_operator": null,
      "rejected_at": null,
      "analyzed_at": 1684356854091,
      "created_at": 1684356824091
    },
    {
      "transaction_id": "rillis_tx_67890",
      "client_transaction_id": "transaction_67890",
      "transaction_type": "crypto",
      "sending_dollar_amount": 1000,
      "sending_amount": 0.05,
      "sending_currency": "BTC",
      "receiving_amount": 1000,
      "receiving_currency": "USD",
      "crypto_network": "Bitcoin",
      "crypto_asset": "BTC",
      "sending_wallet": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "receiving_wallet": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy",
      "status": "COMPLETED",
      "reasons_rejection_analysis": null,
      "reasons_rejection_operator": null,
      "rejected_at": null,
      "analyzed_at": 1684356954091,
      "created_at": 1684356924091
    }
  ],
  "total": 2,
  "page": 1,
  "limit": 20,
  "total_pages": 1
}

Error Responses

In case of an error, the API will return an appropriate HTTP status code along with a JSON response containing error details:

Status Code	Description
400	Bad Request - The request was invalid or cannot be processed.
401	Unauthorized - Authentication credentials are missing or invalid.
403	Forbidden - The client does not have permission to access the requested resource.
404	Not Found - The requested transaction was not found.
429	Too Many Requests - The client has sent too many requests in a given amount of time.
500	Internal Server Error - An error occurred on the server.

Example Error Response

{
  "success": false,
  "error": "Transaction not found",
  "error_code": "RESOURCE_NOT_FOUND",
  "details": "No transaction found with the provided client_transaction_id"
}