mirror of https://github.com/hanzo-fi/payments.git synced 2026-10-30 20:31:20 +00:00

Files

T

CrimsonandGitHub 61cae8af0a chore: Move all CE plugins to own go modules (#780 )

* Move all public connectors to ce/plugins

* Update tooling to account for new go modules under ce

* Ensure we test all CE plugins in CI

* Move Dummypay to ce/plugins for simplicity's sake in the generation scripts

* Use versioned pkg/domain in plugins

* Ensure that renovate updates all CE plugins in a single PR when pkg/domain tags are pushed to github

* Ensure Justfile commands work over all CE plugins

* Copy ce plugin go.mods in dev.Dockerfile

* Only add a go.mod for new plugins if they are ce

* Ensure generated generic client structs are named correctly for submodule

* Add coverprofile for each ce plugin

* Add set -e for Justfile for loops over plugins

* Infer go version from flake.nix in connector template tool

2026-07-01 14:53:02 +00:00

2.6 KiB

Raw Permalink Blame History

Transaction

A payment transaction returned from the PSP.

Properties

Name	Type	Description	Required
Id	string	Unique transaction identifier from the PSP	✅
RelatedTransactionID	Pointer to string	Parent transaction ID for adjustments (refunds, chargebacks). When set, this transaction becomes an adjustment of the parent.
CreatedAt	time.Time	Transaction creation timestamp	✅
UpdatedAt	time.Time	Last update timestamp (used for pagination)	✅
Currency	string	Asset in UMN format (e.g., "USD/2", "BTC/8", "EUR/2")	✅
Type	TransactionType	Transaction type: PAYIN, PAYOUT, TRANSFER, OTHER	✅
Status	TransactionStatus	Transaction status	✅
Amount	string	Amount in minor units (integer string, e.g., "10000" for $100.00)	✅
Scheme	Pointer to string	Payment scheme (visa, mastercard, etc.)
SourceAccountID	Pointer to string	Source account identifier
DestinationAccountID	Pointer to string	Destination account identifier
Metadata	Pointer to map[string]string	Additional key-value metadata

Example: Standard Transaction

{
  "id": "tx_abc123",
  "createdAt": "2026-01-14T10:00:00Z",
  "updatedAt": "2026-01-14T10:00:00Z",
  "currency": "USD/2",
  "type": "PAYIN",
  "status": "SUCCEEDED",
  "amount": "10000",
  "destinationAccountID": "acc_001",
  "metadata": {
    "orderId": "order-123"
  }
}

Example: Refund (Payment Adjustment)

When returning a refund, set relatedTransactionID to link it to the original payment:

{
  "id": "refund_xyz789",
  "relatedTransactionID": "tx_abc123",
  "createdAt": "2026-01-14T12:00:00Z",
  "updatedAt": "2026-01-14T12:00:00Z",
  "currency": "USD/2",
  "type": "OTHER",
  "status": "REFUNDED",
  "amount": "10000",
  "sourceAccountID": "acc_001",
  "metadata": {
    "reason": "customer_request"
  }
}

Example: Chargeback

{
  "id": "cb_dispute_001",
  "relatedTransactionID": "tx_abc123",
  "createdAt": "2026-01-14T14:00:00Z",
  "updatedAt": "2026-01-14T14:00:00Z",
  "currency": "USD/2",
  "type": "OTHER",
  "status": "DISPUTE",
  "amount": "10000"
}

Pagination Notes

Transactions should be returned sorted by updatedAt ascending. Formance uses updatedAtFrom to fetch only transactions updated after the last sync.

[Back to Model list] [Back to API list] [Back to README]

2.6 KiB Raw Permalink Blame History