Follow

SMARTTERMINAL_REQUEST Webhook

WEBHOOK SUBSCRIPTIONS ARE LIMITED TO 5 PER PJMID
For more information on PayJunction account structures, see the PayJunction Account Structures guide.

Provides detailed status information for payment requests to the PayJunction Smart Terminal.

Transaction requests (/request-payment) will return the reference id as a requestPaymentId while all other requests such as signature capture (/request-signature) will return the reference id as a requestId. Regardless of the original request type, the SMARTTERMINAL_REQUEST webhook data object will always reference this id as the requestId.

Example Flow

Connecting

Connection with the specified Smart Terminal is still pending

{
  "created": "2018-02-20T20:30:01.756Z",
  "data": {
    "requestId": "a178db80-59e3-4e39-a6c7-bf8bab7ebb28",
    "status": "CONNECTING"
  },
  "id": "835a3fe6-a7e2-4872-9206-1ed28c4476e6",
  "type": "SMARTTERMINAL_REQUEST"
}

Busy Terminal

Requires interruptBusyTerminal=false to be sent in request body for API versions prior to 2018-06-19. For specific details, please see the Testing for Busy or Offline Smart Terminal guide.
{
  "created": "2018-02-22T17:58:03.744Z",
  "data": {
    "requestId": "ca6a9797-3247-4f1e-9dcb-e053f31f8bb3",
    "status": "BUSY"
  },
  "id": "d50219c3-12f5-4bfe-98bd-d7cca3ac4e14a9",
  "type": "SMARTTERMINAL_REQUEST"
}

Connected, Now in Progress

Smart Terminal is performing the requested action.

{
  "created": "2018-02-20T20:30:02.436Z",
  "data": {
    "requestId": "a178db80-59e3-4e39-a6c7-bf8bab44bb28",
    "status": "IN_PROGRESS"
  },
  "id": "c3a0e26f-87f7-46ef-9b0e-15ebbd7e3478",
  "type": "SMARTTERMINAL_REQUEST"
}

Connected, Now in Progress (Transaction with Signature)

The transaction is approved by the card issuing bank and PayJunction, but a signature is still pending

{
  "created": "2018-02-20T20:30:04.554Z",
  "data": {
    "requestId": "a178db80-59e3-4e39-a6c7-bf8bab7ebb28",
    "status": "IN_PROGRESS",
    "transactionId": 10082
  },
  "id": "ea72ffa7-64ae-45a2-9e36-73174b91189b",
  "type": "SMARTTERMINAL_REQUEST"
}

Connected, Now in Progress (Transaction with PIN)

There is no specific payload sent in this case. Instead a Complete status will be sent with the transactionId as shown below. 

Complete

Processing and required dialogues are complete.

Notice that the parameter name pointing to the resource identifier changes depending on what type of request was originally sent. Transaction requests will return a transactionId while signature capture requests return a signatureId.

Transaction Request

{
  "created": "2018-02-20T20:30:07.235Z",
  "data": {
    "requestId": "a178db80-59e3-4e39-a6c7-bf8bab7ebb28",
    "status": "COMPLETE",
    "transactionId": 10082
  },
  "id": "762611cc-1636-434e-b137-8b148cf249a7",
  "type": "SMARTTERMINAL_REQUEST"
}

Signature Capture Request

{
  "created": "2018-09-04T20:30:07.235Z",
  "data": {
    "requestId": "1c1a2db0-4bb5-4f60-96ce-1a66222e5276",
    "status": "COMPLETE",
    "signatureId": "bc84d60dedcd4896918a07a82e76ccb1"
  },
  "id": "762611cc-1636-434e-b137-8b148cf249a7",
  "type": "SMARTTERMINAL_REQUEST"
}