In-person payments
POS API integration Send sale and details requests to POS terminals
POS API integrations enable developers to interact with the POS system by sending requests and information through APIs. This allows them to initiate sales by transmitting order details or reviewing orders for voiding or refunds.
Endpoint Value TEST-URL https://test-api.kashier.io/v3/payment/pos/messages/:serialNoLIVE-URL https://api.kashier.io/v3/payment/pos/messages/:serialNoMethod POST
Parameter Type Description Required serialNo Path Parameter The serial number of the POS terminal. Older docs called this POSSerialNumber. True
Key Description Authorization The Authorization is a secret key used to identify the merchant. You can obtain it from Kashier's dashboard. Learn more about Authorization .
{ "event" : "sale" , "data" : { "message" : { "amount" : "1" , "currency" : "EGP" , "merchantOrderId" : "your orderId" , "transactionType" : "sale" , "printReceipt" : true , "metaData" : {}, "reconciliation" : { "webhookUrl" : "https://www.webhookApi.com" } } } } Parameter Description Required event The type of operation sale. Mandatory amount The amount to be paid through POS. Mandatory currency The currency the customer will pay with. Mandatory merchantOrderId The order ID for the payment in your system. Mandatory transactionType The transaction type of the operation sale. Mandatory printReceipt Use true to allow the POS to print the receipt. The default value is false. Optional metaData An object to send extra information related to the transaction as key: value. It must be sent even if empty. Mandatory reconciliation The endpoint URL where you want to receive Kashier's webhook. Optional
{ "event" : "details" , "data" : { "message" : { "transactionType" : "details" , "metaData" : {}, "details" : { "paymentMethod" : "card" , "merchantOrderId" : "your OrderId" , "transactionId" : "Kashier's transaction ID" , "valu" : { "type" : "" } } } } } Parameter Description Required event The type of operation details. Mandatory transactionType The transaction type of the operation details. Mandatory metaData An object to send extra information related to the transaction as key: value. It must be sent even if empty. Mandatory paymentMethod The payment method of the order you are inquiring about. Mandatory merchantOrderId The order ID for the order you are inquiring about. Mandatory transactionId Kashier's transaction ID for the payment you are inquiring about. You can find it in the webhook request sent by Kashier. Mandatory valu.type The type of ValU credentials your Kashier account uses to process payments through ValU. It is either PF or PSP. Mandatory only for ValU payments.
