Los Angeles, CA
(650) 549-4357
INTEGRATED TERMINALS & POS SYSTEMS
Add a Point-of-Sale device such as a keypad terminal to your account and see all your transactions in one place.
{DEVICES}
For a sandbox account please send a request to support@paidyet.com
Pairing a Device
To add a point-of-sale terminal device to your PaidYET account:
1. Log into https://dashboard.paidyet.com
2. Scan the QR code on the front screen of the terminal.
OR
1. Go to the Tools link under Account.
2. Go to the Devices tab.
3. Click the “+ PAIR DEVICE button to add a new device.
4. Enter the pairing code that is on the display of the terminal and click “PAIR“
A unique Device ID will be generated for your device. This is the ID you will need to use via the API calls.
POS Device ENDPOINTS
To use a POS device terminal with the API you must first register it with your account. Follow the directions on the terminal to sync the POS device with your account. Once this is done you will receive a device key. This can be used to send transactions to the POS device from the API. PaidYET supports all android based PAX terminals.
Cancel Device Transaction – [base_url]/device/:devicekey/transaction/:transactionkey
| method | request content | payload content | description |
| PUT, PATCH | DeviceTransaction | DeviceTransaction | Cancel a transaction request on the POS device. |
Send Device Transaction – [base_url]/device/:devicekey/transaction
| method | request content | payload content | description |
| POST | DeviceTransaction | DeviceTransaction | Sends a transaction to the POS device (sale or auth). The payment will be performed on the device and return the results. |
Example sale transaction URL: https://api.paidyet.com/device/abcdefghij/transaction
{
amount: 1234.56
type: 'sale'
}Sample Response Data
{
"messages": {
"notice": [],
"success": [],
"warning": [],
"error": []
},
"payload": {
"type": "",
"pages": 1,
"page": 1,
"per_page": 50,
"count": 1,
"items": [
{
"id": 123456,
"key": "pr_abcdef123456",
"amount": "1234.56",
"status": "requested",
"transaction": null,
"device": {
"key": "abcdefghij",
"name": "Pax Terminal abcdefghij"
}
}
]
}
}GET Device Transaction – [base_url]/device/:deviceId/transaction/:transactionkey
| method | request content | payload content | description |
| GET | NA | DeviceTransaction | Gets a transaction previously sent to the POS device. |
Example cancel transaction
{
type: 'cancel'
}Transaction ENDPOINTS
