Sign in

v1

latestOpenAPI 3.1.12026-07-141331164.8 KB
End a Transaction

End Transaction

Signifies the data capture session is complete. Call /get-results within 10 minutes. After 10 minutes, /get-results returns 400 Bad Request for the transaction.

post/api/v1/end

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). A public_data object is required even if it is empty, for example, public_data: {}.

Example request

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

Response

Successfully ended the capture session.

Example response

{
  "public_data": {
    "version": "3.1.1",
    "endpoint": "end"
  },
  "private_data": {
    "transaction_id": "1ae2c7f8-9fad-45cd-83dd-71bbe608421a"
  }
}