Transactions

The Affelios integrated transaction engine enables high throughput efficient synchronization of transaction data between external systems and the Affelios Platform.

Pipeline

The Affelios transaction engine ingests transactions asynchronously and reactively in batches via a low latency queue and worker system, and commission is attributed to transactions as they successfully enter the transaction store. The pipeline has five distinct stages.

Submission

Transactions first enter the HTTP API either as a single item or as a batch (the latter recommended for performance and throughput), with the payload required to pass basic validation to ensure the data appears correctly defined, before a synchronous HTTP response is returned to confirm the batch has been committed to the durable transaction stream for processing.

Processing

Transaction workers dequeue batches of transactions and determine based on each transaction, and the program settings, whether the transaction requires approval or not. This enables the handling of high bursts of transactions on peak, either during peak trading (real-time), or during periodical exports (jobs).

Approval

Transactions which require manual approval are inserted into the pending transactions collection and must be approved before progressing further into the pipeline.

Commission

Once transactions are automatically or manually approved they are processed and assigned relevant commission in flight. This means all balances are always in lockstep with the state of the transaction collection and all affiliates and program managers are always immediately aware of balance updates.

Failures

Transactions which fail to be processed are, depending on the failure reason, retried zero or more times, before entering the transaction failure collection, where they can be retried manually at a later date or discarded.

Creating a single transaction

Asynchronously enqueues a request to create a new transaction item.

POST/api/v1/transaction

Header parameters

Body

application/jsontext/jsonapplication/*+json

The new transaction item body.

externalIdnullable string

typenullable string

affiliateIdnullable string

clickIdnullable string

externalCustomerIdnullable string

externalBrandIdnullable string

externalProductIdnullable string

transactionDatestring (date-time)

countrynullable string

country_codenullable string

depositAmountnumber (double)

grossRevenuenumber (double)

wageredAmountnumber (double)

adjustmentAmountnumber (double)

categorynullable string

labelnullable string

notenullable string

Response

202

Accepted

Request

JavaScriptCurl

const response = await fetch('/api/v1/transaction', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Good to know: For high throughput workloads and efficient synchronization it is highly recommended that transactions are entered into the system in batches rather than as single transactions. However, the above method is provided for simple low throughput integrations, or systems which are unable to extract transactions in batches.

Creating a transaction batch

Asynchronously enqueues a request to create a batch of new transaction items.

POST/api/v1/transaction/bulk

Header parameters

Body

application/jsontext/jsonapplication/*+json

The new transaction item body batch.

externalIdnullable string

typenullable string

affiliateIdnullable string

clickIdnullable string

externalCustomerIdnullable string

externalBrandIdnullable string

externalProductIdnullable string

transactionDatestring (date-time)

countrynullable string

country_codenullable string

depositAmountnumber (double)

grossRevenuenumber (double)

wageredAmountnumber (double)

adjustmentAmountnumber (double)

categorynullable string

labelnullable string

notenullable string

Response

202

Accepted

Request

JavaScriptCurl

const response = await fetch('/api/v1/transaction/bulk', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();