Queue Transaction

A POST to the /transactions/queue endpoint allows your application to create a Transaction by adding to the process queue.

What happens when a transaction is queued?

The main difference between this endpoint and Add Transaction
is queuing a transaction adds the transaction request to a batch processing queue.
The response time for this request is much faster than an Add Transaction, as the job is submitted instantly.
The payload required for this endpoint is identical to the Add Transaction endpoint.

In addition to the above, this endpoint includes the same functionality as Create or Update a Transaction, where an existing transaction is first searched by external_id and then id which will update the transaction if found. If no existing transaction is found, the transaction is created instead.

🚧

Queued transactions may not be created instantly

The processing time of transactions submitted to the queue is subject to the other jobs within the queue. The response will contain no data relating to the transaction. A transaction.created or transaction.updated event will be triggered as each transaction is processed. Developers can use this to retrieve data relating to the submitted transaction.

When to use Queue Transaction

Queueing is primarily used for batch importing transactions.
The Queue endpoint allows developers to submit high volumes of transactions for processing on a batch queue. This is usually done by the developer by looping through transactions on the external system, and sending them to the Queue Transaction endpoint.

When not to use Queue Transaction

If response data is required after submitting the request to this endpoint. Queue Transaction will return a 200 response 'OK' with every successful submission. This will not contain any information about the submitted transaction. If response data is required for population on a website or internal system, use the Add Transaction endpoint instead

If transactions need to be created immediately, this endpoint is not suitable. All transactions submitted via this endpoint are subject to the other jobs on the queue. Because of this, Omneo cannot guarantee the time of creation.

Language
Credentials
Header
URL