Get Payment Session - Authsignal

GET

terminal

payment-session

{challengeId}

Get payment session

curl --request GET \
  --url https://api.authsignal.com/v1/terminal/payment-session/{challengeId} \
  --header 'x-authsignal-terminal: <api-key>'

{
  "challengeId": "ef6b3212-6121-4a9e-92ef-09d819e36e93",
  "status": "PENDING",
  "reference": "xxx-xxx-xxx"
}

Authorizations

x-authsignal-terminal

string

header

required

Use your terminal ID obtained from the on-boarded device. This unique identifier is required to authenticate requests to the payment session APIs from your point of sale terminal.

Path Parameters

challengeId

string

required

The ID of the payment session.

Response

challengeId

string

The ID of the payment session.

status

enum<string>

Available options:

PENDING,

COMPLETED,

EXPIRED,

FAILED

reference

string

A reference identifier originating from the point of sale system.

Create Payment SessionInitialization of a payment session will trigger a payment authorization user experience on the paired Authsignal payment terminal application.

⌘I

Get payment session

curl --request GET \
  --url https://api.authsignal.com/v1/terminal/payment-session/{challengeId} \
  --header 'x-authsignal-terminal: <api-key>'

{
  "challengeId": "ef6b3212-6121-4a9e-92ef-09d819e36e93",
  "status": "PENDING",
  "reference": "xxx-xxx-xxx"
}