Skip to main content
GET
List transactions

Authorizations

Authorization
string
header
default:aro_sk_your_key_here
required

AroPay API key, sent as Authorization: Bearer aro_sk_…. Created in the dashboard under Settings → API keys. Takes precedence over a session cookie when both are present.

Query Parameters

page
integer
default:1
Required range: x >= 1
pageSize
integer
default:20
Required range: 1 <= x <= 100
type
enum<string>

Filter by transaction type.

Available options:
FUND,
MINT,
TRANSFER,
PRIVATE_TRANSFER,
REDEEM,
LETTER_ESCROW,
LETTER_CLAIM,
LETTER_REFUND
status
enum<string>

Filter by status. Lifecycle of a money-movement transaction, executed by the background worker after the POST returns:

  • QUEUED: accepted and recorded; nothing submitted yet (txHash: null).
  • PENDING: primary transaction broadcast (txHash set); awaiting the receipt.
  • CONFIRMED: receipt success. Terminal for every type except REDEEM.
  • SETTLING: redeem burn confirmed; operator payout in progress.
  • SETTLED: redeem payout confirmed (settlementTxHash set). Terminal.
  • FAILED: pre-flight rejection or on-chain revert; nothing moved on-chain. Terminal. error and errorCode are set.

Poll until the status is in the terminal set (CONFIRMED, SETTLED, FAILED) and treat unknown values as in flight.

Available options:
QUEUED,
PENDING,
CONFIRMED,
SETTLING,
SETTLED,
FAILED
walletId
string

Filter to one wallet.

Response

A page of transactions.

ok
any
required
data
object
required