Get Transaction Status and Metadata

The Get Transaction Status and Metadata API retrieves the transaction status and metadata of a transaction with its ID (transaction_id).

Syntax

GET /api/transaction/(uuid: transaction_id)

Examples

Example request

  1. GET /api/transaction/dcaad720-d1e9-47ba-a76b-a6370ef0373b HTTP/1.1

  2. Host: onespan.com

  3. Accept: application/json, text/javascript

Example response

  1. HTTP/1.1 200 OK

  2. Vary: Accept
  3. Content-Type: application/json
  4. {
  5.   "id":"dcaad720-d1e9-47ba-a76b-a6370ef0373b",

  6.   "status":"new",
  7.   "created":"2017-04-23T18:25:43.511Z",
  8.   "tenant_id":"5e52d7b8-8b18-41a4-9187-d4ce75af681",
  9.   "workflow_id":"80b601c9-f102-4761-9eaa-90ba8fcb58b6",
  10.   "urlSetKey":"default",
  11.   "brand_id":"a089f718-f12d-4b13-b82e-e1d8b324337d",
  12.   language":"english",
  13.   "tokens": [...],
  14.   "users": [...],
  15.   "documents": [...],
  16.   "events": [...]
  17. }

Headers

The following headers are included in the request and response, respectively:

Request headers

  • Accept: The response content type depends on the Accept header
  • Authorization: The OAuth/JWT token to authenticate

Response headers

Status codes

Status codes lists the status codes.

Status codes
Status code Name Description
200 OK

No error.

400 Bad Request The transaction data are invalid.
401 Unauthorized Invalid token.
403 Forbidden The token does not grant transaction creation rights.
500 Internal Server Error Server or application error.