Create Payment Session

POST

terminal

payment-session

Create a payment session

curl --request POST \
  --url https://api.authsignal.com/v1/terminal/payment-session \
  --header 'Content-Type: application/json' \
  --header 'x-authsignal-terminal: <api-key>' \
  --data '
{
  "amount": 123,
  "reference": "<string>",
  "currency": "<string>"
}
'

{
  "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.

Body

application/json

amount

number

The amount intended to be authorized at the terminal.

reference

string

A reference identifier originating from the point of sale system.

currency

string

The currency intended to be authorized at the terminal.

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.

Get Payment SessionPoll for a payment session result using the `challengeId` obtained from creating a payment session.

⌘I

Create a payment session

curl --request POST \
  --url https://api.authsignal.com/v1/terminal/payment-session \
  --header 'Content-Type: application/json' \
  --header 'x-authsignal-terminal: <api-key>' \
  --data '
{
  "amount": 123,
  "reference": "<string>",
  "currency": "<string>"
}
'

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