Skip to main content
Projects are the root entity for payment operations. They define the network, currency, wallet, accepted amount range, and secret key used by signed transaction requests.

​
Create a Project

Use POST /api/projects to create a new project. Required fields:
  • project_name
  • currency_symbol
  • network_id
  • wallet_address
  • min_amount
  • max_amount
Optional fields:
  • description
  • merchant_url
  • finalization_time
On success, the API returns the project object plus a one-time secret_key.

​
Update Core Identity

Use PATCH /api/projects/{project_uid} to change:
  • project_name
  • network_id
  • currency_symbol
This endpoint is useful when the project identity changes and you need to move to a different supported network or currency.

​
Update Operational Settings

Use PUT /api/projects/{project_uid}/settings or PATCH /api/projects/{project_uid}/settings to manage:
  • project_name
  • merchant_url
  • network_id
  • currency_symbol
  • min_amount
  • max_amount
  • finalization_time
Use PUT when you want to send the full settings payload and PATCH when you only want to change selected fields.

​
Query Operational Data

​
Project Stats

GET /api/projects/{project_uid}/stats returns aggregate transaction metrics for a project. Supported period values:
  • 1h
  • 24h
  • 7d
  • 1m
  • 1y
  • all
You can also send explicit from and to query parameters in epoch seconds.

​
Projects by Wallet

GET /api/projects/wallet/{address} lists projects owned by a wallet. Supported period values for this endpoint:
  • 1h, 1hour
  • 24h, 24hours
  • 7d, 7days
  • 1m, 1month
  • 1y, 1year
  • all, all_time
The default wallet period is 1m.

​
Delete a Project

Use DELETE /api/projects/{project_uid} when the project should no longer be used.
Deleting a project affects future transaction creation and may impact existing operational workflows. Make sure your application no longer depends on the project before removing it.

​
Field Notes

  • project_uid is the public identifier used across the transaction APIs.
  • finalization_time is an expiration window in seconds.
  • Amount fields accept decimal inputs as strings, integers, or numbers according to the OpenAPI schema.
Continue with Authentication and Signed Requests once a project is ready for live traffic.