Documentation

Funding Transactions

Reference for the funding_transactions resource. Requests follow the conventions in Requests and Responses; fields you receive and may write are filtered by your user's permissions, so responses can contain a subset of the fields below.

Operations

Operation Request
List GET /{profile}/user/v4/funding_transactions
Fetch GET /{profile}/user/v4/funding_transactions/{id}
Create POST /{profile}/user/v4/funding_transactions
Update PATCH /{profile}/user/v4/funding_transactions/{id}
Delete DELETE /{profile}/user/v4/funding_transactions/{id}

Required on create: link funding under data.relationships — a create that omits it is rejected with 422 naming the relationship.

How it works

funding_transactions are the individual money movements (payments, adjustments) recorded against a funding — each has a type, date, and amount. Gated by Customer Funding at the funding's customer's location.

Full CRUD: create, read, edit (PATCH), delete. The parent funding is linked on create through the funding relationship.

Recording a transaction

curl -X POST "https://portal.securitytrax.com/acme/user/v4/funding_transactions" \
  -H "Authorization: Bearer stx_acme_..." \
  -H "Content-Type: application/json" \
  -d '{"data":{"attributes":{"funding_transaction_type_id":1,"transaction_date":"2026-08-01","amount":"600.00","reference":"ACH-4821"},"relationships":{"funding":{"data":{"type":"fundings","id":42}}}}}'
Field Required Notes
funding (relationship) Yes The funding this transaction belongs to.
funding_transaction_type_id Yes The transaction type.
transaction_date Yes The date the transaction occurred.
amount Yes Numeric, up to ±99,999.99.
note, reference No Free text / external reference.

Editing / deleting

PATCH /funding_transactions/{id} edits a transaction; DELETE /funding_transactions/{id} soft-deletes it.

Reading transactions

GET /funding_transactions?funding_id={fundingId} lists a funding's transactions (filters: funding_id, funding_transaction_type_id; sort: id, funding_id, amount, transaction_date, created_at; ?count_only=true for the total). They're also reachable inline via GET /fundings/{id}?include=transactions.

Fields

Fields are grouped by the permission that gates them. A group you may not view is absent from responses; a group you may not write is rejected with 422 when sent in a write.

Funding Transaction

View: Customer Funding at the record's location. Create: Customer Funding at the record's location. Update: Customer Funding at the record's location.

Field Type Writable Validation
funding_id integer (nullable) Create, update min 0
funding_transaction_type_id integer (nullable) Create, update Required on create; min 1
transaction_date string (nullable) Create, update Required on create
amount string (nullable) Create, update Required on create; max length 99999; min length -99999
note string (nullable) Create, update
reference string (nullable) Create, update max length 255
created_at string (nullable) Read-only
created_by integer (nullable) Read-only
updated_at string (nullable) Read-only
updated_by integer (nullable) Read-only

Pagination

The list endpoint uses client-controlled offset pagination: ?page= (1-based) and ?per_page= (default 25, max 100). The response mirrors meta.pagination (page, per_page, total, last_page) and sends an RFC5988 Link header; follow rel="next" to walk pages. See Pagination.

Filters

The list endpoint accepts these query-param filters: funding_id, funding_transaction_type_id. An unsupported filter parameter returns 422. See Filtering collections for matching semantics.

Sorting

GET .../funding_transactions?sort= orders the list by: id, funding_id, amount, transaction_date, created_at. Prefix a field with - for descending; comma-separate for tie-breakers. An unsupported field returns 422. See Sorting collections.

Related

Ask about the docs
Ask about the docs
Answers from the SecurityTrax documentation

Ask about a feature, setting, or workflow.

Answers come from the documentation. Double-check anything important. AI features are subject to the AI Terms.