POST /transactions — fragment-payments-api

Transactions

Creates a transaction.

post/transactions

Request body

external_idstring required

User-provided unique ID.

postedstring date-time required

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

currency'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' required

ISO 4217 or crypto currency code.

amountstring required

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

Example request

{
  "external_id": "bank_txn_123",
  "account": {
    "id": "ext_account_YWJjMTIz",
    "external_id": "acct_external_123"
  },
  "posted": "2024-01-13T00:00:00Z",
  "currency": "USD",
  "amount": "-1000",
  "allocations": [],
  "tags": [
    {
      "key": "department",
      "value": "engineering"
    }
  ]
}

Response

Success

Example response

{
  "data": {
    "id": "txn_dHhuX2ZyYWdfMDAx",
    "external_id": "bank_txn_123",
    "account": {
      "id": "ext_account_YWJjMTIz",
      "external_id": "acct_external_123"
    },
    "posted": "2024-01-13T00:00:00Z",
    "currency": "USD",
    "amount": "-1000",
    "allocations": [
      {
        "invoice_id": "inv_abc123",
        "amount": "1000",
        "type": "invoice_payin",
        "user": {
          "id": "user_abc123",
          "external_id": "user_ext_001"
        }
      }
    ],
    "tags": [
      {
        "key": "department",
        "value": "engineering"
      }
    ],
    "unallocated_amount": "-1000",
    "created": "2024-01-13T00:00:00Z",
    "modified": "2024-01-13T00:00:00Z",
    "version": 1
  }
}

Changes

Changed in 7 of the 38 revisions of this API.9418

Apr 14, 20268472a9bd15ea12See the full diff
- ▲
  removed subschema #1 subschema #2 from the allocations/items/user request property anyOf list
  request-property-any-of-removed
- ○
  added subschema #1 subschema #2 to the allocations/items/user request property anyOf list
  request-property-any-of-added
- ○
  the response property data/allocations/items/user/external_id became required for the status 201
  response-property-became-required
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 18, 2026249df29a7dfe2See the full diff
- ○
  added the new optional request property tags
  new-optional-request-property
- ○
  added the required property data/tags to the response with the 201 status
  response-required-property-added
Mar 12, 2026930de445f98d21See the full diff
- ▲
  the account/external_id request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the account/id request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ○
  added the optional property data/allocations/items/user/external_id to the response with the 201 status
  response-optional-property-added
Mar 6, 20266768d46dbde823See the full diff
- ▲
  removed subschema #1 subschema #2 from the allocations/items/user request property anyOf list
  request-property-any-of-removed
- ▲
  the data/allocations/items/user response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ○
  added subschema #1 subschema #2 to the allocations/items/user request property anyOf list
  request-property-any-of-added
- ○
  removed subschema #1 subschema #2 from the data/allocations/items/user response property anyOf list for the response status 201
  response-property-any-of-removed
- ○
  added the required property data/allocations/items/user/id to the response with the 201 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 20, 20267bc74a7056871See the full diff
- ○
  added the required property data/version to the response with the 201 status
  response-required-property-added
Feb 20, 2026cf707627ad82448See the full diff
- ▲
  added the new required request property allocations/items/amount
  new-required-request-property
- ▲
  added the new required request property allocations/items/invoice_id
  new-required-request-property
- ▲
  added the new required request property allocations/items/type
  new-required-request-property
- ▲
  added the new required request property allocations/items/user
  new-required-request-property
- ●
  added the new CADC enum value to the data/currency response property for the response status 201
  response-property-enum-value-added
- ●
  added the new CADT enum value to the data/currency response property for the response status 201
  response-property-enum-value-added
- ●
  added the new EURC enum value to the data/currency response property for the response status 201
  response-property-enum-value-added
- ●
  added the new USDG enum value to the data/currency response property for the response status 201
  response-property-enum-value-added
- ○
  added the new CADC enum value to the request property currency
  request-property-enum-value-added
- ○
  added the new CADT enum value to the request property currency
  request-property-enum-value-added
- ○
  added the new EURC enum value to the request property currency
  request-property-enum-value-added
- ○
  added the new USDG enum value to the request property currency
  request-property-enum-value-added
- ○
  added the required property data/allocations/items/amount to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/allocations/items/invoice_id to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/allocations/items/type to the response with the 201 status
  response-required-property-added
- ○
  added the required property data/allocations/items/user to the response with the 201 status
  response-required-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 16, 202679cd0cd887861See the full diff
- ○
  endpoint added
  endpoint-added

Full history