Skip to content
FRAGMENT
API Reference

Transactions

Create
transactions.create(TransactionCreateParams**kwargs) -> TransactionCreateResponse
POST/transactions
List
transactions.list(TransactionListParams**kwargs) -> TransactionListResponse
GET/transactions
List History
transactions.list_history(strtransaction_ref) -> TransactionListHistoryResponse
GET/transactions/{transaction_ref}/history
Retrieve
transactions.retrieve(strtransaction_ref) -> TransactionRetrieveResponse
GET/transactions/{transaction_ref}
Search
transactions.search(TransactionSearchParams**kwargs) -> TransactionSearchResponse
POST/transactions/search
Search Allocations
transactions.search_allocations(TransactionSearchAllocationsParams**kwargs) -> TransactionSearchAllocationsResponse
POST/transactions/allocations/search
Update
transactions.update(strtransaction_ref, TransactionUpdateParams**kwargs) -> TransactionUpdateResponse
PATCH/transactions/{transaction_ref}
ModelsExpand Collapse
class Transaction: …

Transaction object.

id: str

User-facing encoded transaction ID.

account: Account

External account reference on transaction responses.

id: str

User-facing encoded account ID.

external_id: str

External account reference ID.

allocations: List[Allocation]
amount: str

Allocated amount in smallest currency unit as stringified bigint.

invoice_id: str

The invoice this allocation is applied against.

type: Literal["invoice_payin", "invoice_payout"]

The type of allocation.

Accepts one of the following:
"invoice_payin"
"invoice_payout"
user: AllocationUser

User reference in API responses: Fragment user id and external_id.

id: str

FRAGMENT generated ID of the user

external_id: str

External ID of the user

amount: str

Amount in smallest currency unit as stringified bigint (can be positive or negative).

created: datetime

Creation timestamp.

formatdate-time
currency: Literal["ADA", "BTC", "DAI", 176 more]

Currency code (ISO 4217 or crypto)

Accepts one of the following:
"ADA"
"BTC"
"DAI"
"ETH"
"SOL"
"USDC"
"USDT"
"USDG"
"EURC"
"CADC"
"CADT"
"XLM"
"UNI"
"BCH"
"LTC"
"AAVE"
"LINK"
"MATIC"
"PTS"
"AED"
"AFN"
"ALL"
"AMD"
"ANG"
"AOA"
"ARS"
"AUD"
"AWG"
"AZN"
"BAM"
"BBD"
"BDT"
"BGN"
"BHD"
"BIF"
"BMD"
"BND"
"BOB"
"BRL"
"BSD"
"BTN"
"BWP"
"BYR"
"BZD"
"CAD"
"CDF"
"CHF"
"CLP"
"CNY"
"COP"
"CRC"
"CUC"
"CUP"
"CVE"
"CZK"
"DJF"
"DKK"
"DOP"
"DZD"
"EGP"
"ERN"
"ETB"
"EUR"
"FJD"
"FKP"
"GBP"
"GEL"
"GGP"
"GHS"
"GIP"
"GMD"
"GNF"
"GTQ"
"GYD"
"HKD"
"HNL"
"HRK"
"HTG"
"HUF"
"IDR"
"ILS"
"IMP"
"INR"
"IQD"
"IRR"
"ISK"
"JMD"
"JOD"
"JPY"
"KES"
"KGS"
"KHR"
"KMF"
"KPW"
"KRW"
"KWD"
"KYD"
"KZT"
"LAK"
"LBP"
"LKR"
"LRD"
"LSL"
"LYD"
"MAD"
"MDL"
"MGA"
"MKD"
"MMK"
"MNT"
"MOP"
"MUR"
"MVR"
"MWK"
"MXN"
"MYR"
"MZN"
"NAD"
"NGN"
"NIO"
"NOK"
"NPR"
"NZD"
"OMR"
"PAB"
"PEN"
"PGK"
"PHP"
"PKR"
"PLN"
"PYG"
"QAR"
"RON"
"RSD"
"RUB"
"RWF"
"SAR"
"SBD"
"SCR"
"SDG"
"SEK"
"SGD"
"SHP"
"SLL"
"SOS"
"SPL"
"SRD"
"SVC"
"SYP"
"STN"
"SZL"
"THB"
"TJS"
"TMT"
"TND"
"TOP"
"TRY"
"TTD"
"TVD"
"TWD"
"TZS"
"UAH"
"UGX"
"USD"
"UYU"
"UZS"
"VEF"
"VND"
"VUV"
"WST"
"XAF"
"XCD"
"XOF"
"XPF"
"YER"
"ZAR"
"ZMW"
"LOGICAL"
"CUSTOM"
external_id: str

External idempotency key provided by the user.

posted: datetime

Posted timestamp in ISO 8601 format.

formatdate-time
tags: List[Tag]

Metadata tags associated with this transaction.

key: str

Tag key

value: str

Tag value

unallocated_amount: str

Read-only amount not yet allocated.

version: int

Current version of the transaction, used for optimistic concurrency control.

modified: Optional[datetime]

Last modified timestamp.

formatdate-time