Skip to content
FRAGMENT
API Reference
Transactions

Create

POST/transactions

Creates a transaction.

Body ParametersJSONExpand Collapse
account: object { id, external_id }

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

id: optional string

FRAGMENT generated unique ID.

minLength1
external_id: optional string

User-provided unique ID.

minLength1
allocations: array of object { amount, invoice_id, type, user }

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

amount: string

Allocation amount, as a positive string in the smallest unit of the currency (for example, cents for USD).

invoice_id: string

Invoice to allocate against.

type: "invoice_payin" or "invoice_payout"

Type of allocation.

Accepts one of the following:
"invoice_payin"
"invoice_payout"
user: object { id } or object { external_id }

Identifies a user by id or external_id.

Accepts one of the following:
ID = object { id }
id: string

FRAGMENT generated unique ID.

ExternalID = object { external_id }
external_id: string

User-provided unique ID.

amount: string

Transaction amount, as a string in the smallest unit of the currency (for example, cents for USD). Can be positive or negative.

currency: "ADA" or "BTC" or "DAI" or 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: string

User-provided unique ID.

posted: string

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

formatdate-time
tags: optional array of object { key, value }

Tags for the transaction.

key: string

Tag key. Must be a valid safe string (no special characters like #, /, :). Max 50 characters.

value: string

Tag value. Must be a valid safe string (no special characters like #, /, :). Max 200 characters.

ReturnsExpand Collapse
data: Transaction { id, account, allocations, 9 more }

Transaction object.

id: string

FRAGMENT generated unique ID.

account: object { id, external_id }

External account for the transaction.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

allocations: array of object { amount, invoice_id, type, user }

Allocations applied to the transaction.

amount: string

Allocated amount, as a positive string in the smallest unit of the currency (for example, cents for USD).

invoice_id: string

Invoice the allocation is applied against.

type: "invoice_payin" or "invoice_payout"

Type of allocation.

Accepts one of the following:
"invoice_payin"
"invoice_payout"
user: object { id, external_id }

User reference.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

amount: string

Transaction amount, as a string in the smallest unit of the currency (for example, cents for USD). Can be positive or negative.

created: string

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

formatdate-time
currency: "ADA" or "BTC" or "DAI" or 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: string

User-provided unique ID.

posted: string

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

formatdate-time
tags: array of object { key, value }

Tags for the transaction.

key: string

Tag key.

value: string

Tag value.

unallocated_amount: string

Amount not yet allocated, as a string.

version: number

Current version of the transaction.

modified: optional string

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

formatdate-time

Create

curl https://api.us-west-2.fragment.dev/transactions \
    -H 'Content-Type: application/json' \
    -d '{
          "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": "2024-01-13T00:00:00Z"
        }'
{
  "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": "region",
        "value": "us-east"
      }
    ],
    "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": "region",
        "value": "us-east"
      }
    ],
    "unallocated_amount": "-1000",
    "version": 1,
    "modified": "2024-01-13T00:00:00Z"
  }
}