logo

PosTransactions

Create POS Transaction.

If WaitForAcceptanceByTerminal is true - HTTP response will wait till terminal accept or decline transaction or time out If WaitForAcceptanceByTerminal is false - HTTP response will be returned immediately Default value - false

SecurityBearer or Bearer or Bearer or Bearer
Request
Request Body schema: application/json
posDeviceId
string or null

External POS Device ID | Mandatory | MaxLength=36

referenceId
string or null

External Reference Device ID | Mandatory | MaxLength=36

transactionTypeId
integer <int32> (PosService.Contracts.TransactionType)

List of allowed transaction types to process

Possible values:

  • 1 - Authorization:
  • 2 - Sale:
  • 3 - Capture:
  • 4 - Void:
  • 5 - Refund:
  • 6 - CardAuthentication:
  • 7 - RefundWORef:
  • 8 - TipAdjustment:
  • 10 - Settle:
Enum: 1 2 3 4 5 6 7 8 10
targetTransactionId
string or null <uuid>

Transaction Id for Void, Capture, Refund | Conditional

amount
number or null <double>

Transaction amount for transaction types requires Amount | Conditional

useCardPrice
boolean or null

Parameter is mandatory when merchant has ZeroCostProcessingOption == Dual Pricing. Parameter must be null when merchant has other ZeroCostProcessingOption. For Dual Pricing option ose card price if parameter == true, use cash price if parameter == false.

currencyId
integer or null <int32>

Transaction currency for transaction types requires Amount | Conditional

paymentProcessorId
string or null <uuid>

Predefined PaymentProcessorID | Optional

terminalId
string <uuid>

ID of terminal should handle POS Transaction | Mandatory

waitForAcceptanceByTerminal
boolean

Parameter provide should an instruction for the API to wait or not wait for POS transaction acceptance by the terminal If true - HTTP response will wait till terminal accept or decline transaction or time out If false - HTTP response will be returned immediately Default value - false

readingMethodId
integer <int32> (PosService.Contracts.Enums.PosTransactionReadingMethod)

Possible values:

  • 1 - Reading:
  • 2 - KeyedId:
Enum: 1 2
Responses
200

Success

400

Bad Request

post/pos-api/v1/pos-transactions
Request samples
application/json
{
  • "posDeviceId": "000000001",
  • "referenceId": "10001",
  • "transactionTypeId": 2,
  • "targetTransactionId": null,
  • "amount": 10,
  • "useCardPrice": null,
  • "currencyId": 1,
  • "paymentProcessorId": "00000000-0000-0000-0000-000000000000",
  • "terminalId": "00000000-0000-0000-0000-000000000000",
  • "waitForAcceptanceByTerminal": false,
  • "readingMethodId": null
}
Response samples
application/json
{
  • "posTransactionId": "00000000-0000-0000-0000-000000000000",
  • "statusId": 1,
  • "status": "TerminalConnecting"
}

Get POS Transactions List of current merchant.

SecurityBearer or Bearer or Bearer or Bearer
Request
query Parameters
page
integer <int32>
pageSize
integer <int32>
asc
boolean
orderBy
string
terminalId
string <uuid>

TerminalId to filter by

Responses
200

Success

400

Bad Request

404

Not Found

get/pos-api/v1/pos-transactions
Request samples 
Response samples 
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "asc": true,
  • "orderBy": "string",
  • "terminalId": "57e69e1b-2c00-4a26-b5e3-44617c6cc659"
}
Get POS Transaction by ID.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
id
required
string <uuid> 
ID of POS transaction


 
query Parameters
waitForTransactionProcessing
boolean
Wait for transition to one of completed statuses or timeout happening. 
If true - HTTP response will wait till transaction completion/failing/cancelling or timeout. 
If false - HTTP response will be returned immediately. 
Default value - false


 
Responses 
200
Success


400
Bad Request


404
Not Found


get/pos-api/v1/pos-transactions/{id}
Request samples 
Response samples 
application/json
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "createdOn": "2024-10-28T23:44:26.023254+00:00",
  • "modifiedOn": "2024-10-29T23:44:26.0232554Z",
  • "merchantId": "00000000-0000-0000-0000-000000000000",
  • "terminalId": "00000000-0000-0000-0000-000000000000",
  • "paymentProcessorId": "00000000-0000-0000-0000-000000000000",
  • "posDeviceId": "000000001",
  • "referenceId": "10001",
  • "posTransactionStatusId": 6,
  • "posTransactionStatus": "Completed",
  • "transactionId": "00000000-0000-0000-0000-000000000000",
  • "amount": 10,
  • "currencyId": 1,
  • "targetTransactionId": null,
  • "transactionTypeId": 2,
  • "transactionType": "Sale",
  • "isCompleted": true,
  • "transaction": {
    }
}
Cancel POS Transaction by ID.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
id
required
string <uuid> 
ID of POS transaction


 
Responses 
200
Success


post/pos-api/v1/pos-transactions/{id}/cancel
Request samples 
Response samples 
application/json
{
  • "posTransactionId": "00000000-0000-0000-0000-000000000000",
  • "statusId": 1,
  • "status": "TerminalConnecting"
}
➔ Next to Categories