Skip to content
Fyendal's Collection API Documentation

Create Transaction

Creates a new transaction within the specified collection.

Request

Section titled “Request”

A request can be submitted to this endpoint using the details below:

Method

Section titled “Method”
POST

URL

Section titled “URL”
https://api.fyendalscollection.com/collection/{collectionId}/transaction
  • collectionId - The ID of the collection to create the transaction in.

Request Model

Section titled “Request Model”
CreateTransactionRequestModel.ts
interface CreateTransactionRequestModel {
  readonly variantId: string;
  readonly occurredDate: string;
  readonly action: string;
  readonly quantity: number;
  readonly unitAmount: Money;
}

Example

Section titled “Example”
POST /collection/3a14b163-15ee-41e2-a802-1494f2cc0d3f/transaction HTTP/1.1
Host: api.fyendalscollection.com
Authorization: Bearer eyJ...
Content-Type: application/json


{
  "variantId": "2ca236a1-a30b-4246-8258-fbecac1003ee",
  "occurredDate": "2025-08-31",
  "action": "Purchase",
  "quantity": 1,
  "unitAmount": {
    "currency": "USD",
    "value": 149.99
  }
}

Response

Section titled “Response”

A successful response from this endpoint gives a 200 OK and the following response model:

Response Model

Section titled “Response Model”
TransactionResponseModel.ts
interface TransactionResponseModel {
  readonly transactionId: string;
  readonly variantId: string;
  readonly productId: string;
  readonly occurred: string;
  readonly action: string;
  readonly quantity: number;
  readonly unitAmount: Money;
  readonly variantName: string;
  readonly productName: string;
  readonly number: string | null;
  readonly imageUrl: string;
  readonly fcId: string;
}

Example

Section titled “Example”
HTTP/1.1 200 OK
Content-Type: application/json


{
  "transactionId": "bfdd3db0-afb6-4934-9f39-c3aa97f9a459",
  "variantId": "2ca236a1-a30b-4246-8258-fbecac1003ee",
  "productId": "549623c8-34df-4018-a39e-75b37664da77",
  "occurred": "2025-08-31T12:00:00Z",
  "action": "Purchase",
  "quantity": 1,
  "unitAmount": {
    "currency": "USD",
    "value": 149.99
  },
  "variantName": "1st Edition Cold Foil",
  "productName": "Arknight Shard",
  "number": "CRU000",
  "imageUrl": "https://example.com/image.jpg",
  "fcId": "CRU000-1ST-CF"
}

Problem Types

Section titled “Problem Types”

The following problem types can be encountered when using this endpoint:

NotFound

Section titled “NotFound”

If the specified collection or variant does not exist.