POS Devices
Add a Point-of-Sale device such as a keypad terminal to your account and see all your transactions in one place.
#Integration</>{POS}
For a sandbox account please send a request to support@paidyet.com
Overview
To add a point-of-sale terminal device to your PaidYET account:
- Go to the Integration link under Settings.
- Go to the Devices tab.
- Click the + button to add a new device.
- Give the terminal a unique name. Note: this will show up in the transaction reports
- You will need to pair the device in under 2 minutes or the pairing code will expire and you will need to start over.
Note: To pair the device, simply turn on the device and it should prompt you to enter a pairing code. Enter the code generated by PaidYET.
A unique Device ID will be generated for your device. This is the ID you will need to use via the API calls.
Sample to send a device payment request (cURL)
$ch = curl_init();
$url = "https://api.paidyet.com/v2/devicepaymentrequest";
$postdata = ['amount'=>[AMOUNT],'deviceid'=>[DEVICE ID], 'transaction_type' =>'[authonly|sale]'];
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POSTFIELDS,$postdata);
curl_setopt($ch, CURLOPT_HTTPHEADER,array("Authorization: Bearer ".$token ));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
try{
$output = curl_exec($ch);
}
catch(Exception $e) {
throw $e;
}
curl_close($ch);Response Data
| type | the type of transaction that is being sent. Right now the only response is "request" |
| key | this is the unique request key that will be used to track the status of this device payment request. |
| expiration | Timestamp of when the payment request will expire. Requests expire 5 minutes after the initial request is made. |
| transaction_type | The type of transaction you are running. Currently we support authonly or sale. Defaults to sale. |
Sample to check the status of the device transaction request
$ch = curl_init();
$url = "https://api.paidyet.com/v2/devicepaymentrequest/[REQUEST KEY]";
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER,array("Authorization: Bearer ".$token ));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
try{
$output = curl_exec($ch);
}
catch(Exception $e) {
throw $e;
}
curl_close($ch);
Response Data
| type | the type of transaction that is being sent. Right now the only response is "request" |
| key | this is the unique request key that will be used to track the status of this device payment request. |
| status | Status of the request. Possible values: sending to device sent to device waiting for card dip changing interfaces customer see phone and tap again processing payment completing payment capturing signature signature capture error transaction complete canceled transaction canceled transaction failed timeout error |
| transaction | if a card was attempted to be processed a transaction object will be presented. |