latestOpenAPI 3.0.02026-08-0832102256.6 KB

6097bc689e41

Prompt Job

Get prompt jobs.

Called by the Independent Software Vendor. Lists the prompt job in the database for provided id.

get/prompt_jobs/{id}

Path parameters

idinteger required

The id of the prompt job in question.

Headers

Authorizationstring api_id:api_token required

Needs to include Basic word before Base64 encoded api_id:api_token. The api_id is the identifier of the organization created on TAP; size range - up to 36 characters. The api_token is the unique token previously generated by TAP and provided securely to the organization; size range - 32. Example: Basic ODA5BVgrNdZkZmbiFlJlTThkYTA2eG00MzA5dHh1bWZnZgfdZDE=

Acceptstring required

Example:application/vnd.paymentfusion.v3.0.0+json

Specifies the requested API version. If this field is not specified or has an invalid format, the API will return an error. If the specified version does not exist, a 404 page will be displayed. Accepted values - application/vnd.paymentfusion.v3.0.0+json

Response

Success

idinteger

Unique identifier of the prompt job (returned when the prompt job was created).

typestring

The type of the prompt job. Allowed values - "yes/no", "ok/cancel", "signature"

resultstring

Contains either the action that the user took ("yes", "no", "ok", "cancel") or the signature file encoded in base64.

statusstring

Status of the returned prompt job. Allowed values - "in progress", "finalized", 'error', "timed out", 'canceled'

remote_idstring

Used for keeping track of a 3rd party identifier alongside the prompt job. Size range - 0..100

vstring

The API version that was used to handle the request.

Example response

{
  "type": "string",
  "result": "string",
  "status": "string",
  "remote_id": "string",
  "v": "string"
}