Skip to content
FRAGMENT
API Reference
Transactions

Create

transactions.create(TransactionCreateParams**kwargs) -> TransactionCreateResponse
POST/transactions

Creates a transaction.

ParametersExpand Collapse
account: Account

External account for the transaction. Identify it by id, external_id, or both.

id: Optional[str]

FRAGMENT generated unique ID.

minLength1
external_id: Optional[str]

User-provided unique ID.

minLength1
allocations: Iterable[Allocation]

Allocations for the transaction. An empty array indicates unreconciled funds.

amount: str

Allocation amount, as a non-negative string in the smallest currency unit, such as cents for USD.

invoice_id: str

Invoice to allocate against.

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

Type of allocation.

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

Identifies a user by id or external_id.

Accepts one of the following:
class AllocationUserID: …
id: str

FRAGMENT generated unique ID.

class AllocationUserExternalID: …
external_id: str

User-provided unique ID.

amount: str

Transaction amount, as a string in the smallest currency unit, such as cents for USD.

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

ISO 4217 or crypto currency code.

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

User-provided unique ID.

posted: Union[str, datetime]

Timestamp when the transaction was posted. Uses ISO 8601 format.

formatdate-time
tags: Optional[Iterable[Tag]]

Tags for the transaction.

key: str

Tag key. Must not contain #, /, or :. Max 50 characters.

value: str

Tag value. Must not contain #, /, or :. Max 200 characters.

ReturnsExpand Collapse
class TransactionCreateResponse: …
data: Transaction

Transaction object.

id: str

FRAGMENT generated unique ID.

account: Account

External account for the transaction.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

allocations: List[Allocation]

Allocations applied to the transaction.

amount: str

Allocated amount, as a non-negative string in the smallest currency unit, such as cents for USD.

invoice_id: str

Invoice the allocation is applied against.

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

Type of allocation.

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

User associated with the allocation.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

amount: str

Transaction amount, as a string in the smallest currency unit, such as cents for USD.

created: datetime

Timestamp when the transaction was created. Uses ISO 8601 format.

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

ISO 4217 or crypto currency code.

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

User-provided unique ID.

posted: datetime

Timestamp when the transaction was posted. Uses ISO 8601 format.

formatdate-time
tags: List[Tag]

Tags for the transaction.

key: str

Tag key.

value: str

Tag value.

unallocated_amount: str

Amount not yet allocated, as a string.

version: int

Current version of the transaction.

modified: Optional[datetime]

Timestamp when the transaction was last modified. Uses ISO 8601 format.

formatdate-time

Create

from datetime import datetime
from fragment import Fragment

client = Fragment()
transaction = client.transactions.create(
    account={},
    allocations=[{
        "amount": "1000",
        "invoice_id": "inv_abc123",
        "type": "invoice_payin",
        "user": {
            "id": "user_abc123"
        },
    }],
    amount="-1000",
    currency="USD",
    external_id="bank_txn_123",
    posted=datetime.fromisoformat("2024-01-13T00:00:00"),
)
print(transaction.data)
{
  "data": {
    "id": "txn_dHhuX2ZyYWdfMDAx",
    "account": {
      "id": "ext_account_YWJjMTIz",
      "external_id": "acct_external_123"
    },
    "allocations": [
      {
        "amount": "1000",
        "invoice_id": "inv_abc123",
        "type": "invoice_payin",
        "user": {
          "id": "user_abc123",
          "external_id": "user_ext_001"
        }
      }
    ],
    "amount": "-1000",
    "created": "2024-01-13T00:00:00Z",
    "currency": "USD",
    "external_id": "bank_txn_123",
    "posted": "2024-01-13T00:00:00Z",
    "tags": [
      {
        "key": "department",
        "value": "engineering"
      }
    ],
    "unallocated_amount": "-1000",
    "version": 1,
    "modified": "2024-01-13T00:00:00Z"
  }
}
Returns Examples
{
  "data": {
    "id": "txn_dHhuX2ZyYWdfMDAx",
    "account": {
      "id": "ext_account_YWJjMTIz",
      "external_id": "acct_external_123"
    },
    "allocations": [
      {
        "amount": "1000",
        "invoice_id": "inv_abc123",
        "type": "invoice_payin",
        "user": {
          "id": "user_abc123",
          "external_id": "user_ext_001"
        }
      }
    ],
    "amount": "-1000",
    "created": "2024-01-13T00:00:00Z",
    "currency": "USD",
    "external_id": "bank_txn_123",
    "posted": "2024-01-13T00:00:00Z",
    "tags": [
      {
        "key": "department",
        "value": "engineering"
      }
    ],
    "unallocated_amount": "-1000",
    "version": 1,
    "modified": "2024-01-13T00:00:00Z"
  }
}