fulfillments

List My Fulfillments

get/me/fulfillments

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/me/fulfillments
  • Auth: API key in header Authorization

Query parameters

directionstring

sent|received|all

statusstring

pending|confirmed|... or outstanding (= pending+claimed+submitted) or closed (= cancelled+declined+expired, the Declined tab)

counterparty_idstring

scope to fulfillments with one counterparty (the other party, per the caller's role)

sortstring

recent (newest first, default) | oldest

limitinteger

page size

offsetinteger

page offset

created_afterstring

RFC3339 timestamp; only fulfillments created at/after this instant (e.g. 48h window)

created_beforestring

RFC3339 timestamp; inclusive upper bound — pair with created_after for a bounded window

kind'p2p' | 'deposit' | 'billpay' | 'direct' | 'reward' | 'terminal'

narrow to one product line: p2p (no machine tag — a real person-to-person transfer) | deposit | billpay | direct | reward | terminal (a POS sale)

reference_prefixstring

match reference LIKE '<prefix>%'; narrows the caller's own rows, never widens them. A service that stamps its own reference uses this to recover a create whose response was lost.

self_payments'include' | 'exclude' | 'only'

pay-yourself fulfillments (sender == receiver: bill-pay funding, quick pays, self-sends): include keeps them (default), exclude hides them, only returns just them

Response

OK

limitinteger
offsetinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.