List payment orders

​

List payment orders sent by your account. fromUserId filters by the system user id returned by the user endpoints, not the user label. Filterable by status, fromUserId, and creation window; paginated. Use subaccountId to list one subaccount instead, or includeSubaccounts=true to span your account and its subaccounts.

Query Parameters
  • subaccountId
    Type: string Format: uuid

    Scope this read to one of your subaccounts instead of the authenticated account. Must be a direct child of the authenticated account.

  • includeSubaccounts
    Type: string enum

    Set to true to include your subaccounts' records alongside your own. true cannot be combined with subaccountId; false can, and means the same as omitting it.

    values
    • true
    • false
  • fromUserId
    Type: string

    System user id returned by the user endpoints.

  • status
    Type: array string[] enum
    required
    values
    • AWAITING_FUNDS
    • CANCELED
    • FUNDED
    • LOCKED
    • REMEDIATING_OVERFUNDED
  • createdAfter
  • createdBefore
  • epochId
    deprecated

    Removed. Requests that include this parameter are rejected with a 400.

  • limit
    Type: integer
    min:  
    1
    max:  
    1000

    Integer numbers.

  • offset
    Type: integer
    min:  
    0
    max:  
    9007199254740991

    Integer numbers.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/api/v1/payment-orders
curl 'https://api.bettermoney.com/api/v1/payment-orders?status=AWAITING_FUNDS'

{
  "paymentOrders": [
    {
      "id": "string",
      "rulesetId": "123e4567-e89b-12d3-a456-426614174000",
      "mode": "standard",
      "senderAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "fromUserId": null,
      "status": "AWAITING_FUNDS",
      "version": -9007199254740991,
      "asset": "string",
      "toChain": "string",
      "toAddress": "string",
      "amountUsd": 1,
      "memo": null,
      "idempotencyKey": "string",
      "payoutDestinationId": "123e4567-e89b-12d3-a456-426614174000",
      "instantFeeBps": 0,
      "quoteId": "string",
      "quoteFeeBps": 0,
      "estimatedSettlementAt": "2026-09-08T20:57:50.017Z",
      "createdAt": "2026-09-08T20:57:50.017Z",
      "expiresAt": "2026-09-08T20:57:50.017Z",
      "receivedTotal": 0,
      "inboundTransfers": [
        {
          "sender": "string",
          "amountUsd": 0,
          "chain": "string",
          "asset": "string",
          "transactionHash": "string",
          "observedAt": "2026-09-08T20:57:50.017Z",
          "status": "PENDING_VERIFICATION",
          "version": -9007199254740991,
          "refundReference": "string",
          "refundTransactionHash": "string"
        }
      ],
      "canceledAt": "2026-09-08T20:57:50.017Z",
      "cancelReason": "string",
      "cancelRequestedAt": "2026-09-08T20:57:50.017Z",
      "refundReason": "string",
      "refundedAt": "2026-09-08T20:57:50.017Z",
      "refundTransactionHash": "string",
      "distributionReference": "string",
      "settlementReference": "string",
      "distributionTransactionHash": "string",
      "distributionExecutedAt": "2026-09-08T20:57:50.017Z",
      "settledAt": "2026-09-08T20:57:50.017Z",
      "direction": "SENT"
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1,
  "hasMore": true
}

Default Response