Sign in

v1

latestOpenAPI 3.1.12026-07-141331164.8 KB
Get Data

Get Status

Use this endpoint to poll for status updates during the Capture process. This endpoint is an alternative to the postback status results sent to the status_url provided in the /start request body.

post/api/v1/get-status

Headers

signaturestring required

Encrypted Request Body

Encrypted Request Body

customer-idstring required

Your provided customer ID.

Your provided customer ID.

Request body

public_dataobject required

May not contain personally identifiable information (PII).

Example request

{
  "public_data": {},
  "private_data": {
    "transaction_id": "3fb21ac1-eb92-4705-8fcb-40eed01cb369"
  }
}

Response

Successfully retrieved status.

Example response

{
  "public_data": {
    "version": "3.1.0",
    "endpoint": "get-status"
  },
  "private_data": {
    "transaction_id": "3fb21ac1-eb92-4705-8fcb-40eed01cb369"
  }
}