API : Queues

What are Queues

Queues are a holding spot for transactions which need some sort of additional verification. If a transaction it passed to queue, that transaction is frozen until a user manually approves or rejects it or an API call is made doing the same thing.

How Queues Works

When a transaction is queued that transaction gets frozen until the queue is instructed to do something with that transaction.  At the moment the transaction hits the queue a response is sent to the original requester mapping the best response to the chosen gateway (See OpenPath Gateway Emulation Documentation) unless OpenPath Responses is enabled on the Site, in which case it will return a queued response.

Also, if you have a webhook setup for the queue, then the queued transaction will also be posted to the webhook URL you provided.
Once a transaction is queued, a client can either login to their OpenPath Client Application and go to the Pending report to manually review the transactions and choice to either continue the transaction for payment or reject the payment.  Transaction can also be accepted or rejected through the action of this endpoint.

Actions

accept={true/false} If accept value is true, then the transaction will immediately finish its processing on to the next path; if set to false, then the transaction will be rejected.  In either case the transaction will be removed from the queue.

Endpoints

GET https://api-app.openpath.io/v1/queue
Returns all the queues within an organization.

Queues Request
GET /v1/queue HTTP/1.1
Host: api-app.openpath.io
Authorization: bearer {SECURITY TOKEN}
Content-Type: application/json
Cache-Control: no-cache
​
Queue Result
 "result": [
   {
     "queue_id": 100,
     "name": "My Fraud Queue",
     "active": true,
     "description": null,
     "tags": null,
     "webhook": "http://www.newco.com/webhook",
     "next_path_type": "Gateway",
     "next_path_id": 20,
     "organizationId": 41
   },
   {
     "queue_id": 101,
     "name": "My Risk Queue",
     "active": true,
     "description": null,
     "tags": null,
     "webhook": "http://www.newco.com/webhook",
     "next_path_type": "Gateway",
     "next_path_id": 30,
     "organizationId": 41
   },
​ ]

<<  Authenticate