Minimum API Version Required: 2018-06-01
Documentation for all previous versions: GET /terminals *Pre-2018-06-01*
This API endpoint uses pagination.
To ensure all query results are received make sure to read our Pagination article.
Returns a results array of terminals/accounts available to the API credentials used.
A terminalId points to the specific merchant account terminal that the transaction will be processed on. For example: main location, second location, sales department, etc. Terminal Id's can also be found manually. Click Here for instructions to find the Terminal Id(s) for your account.
| Field | Format | Description |
|---|---|---|
| terminalId | number | Identifies a specific account/batch. |
| nickName | string | The editable name of the account/batch, e.g. "Sales", "Downtown Location" |
| type | "CARD" or "ACH" | Notates whether the account processes card or ACH/check transactions. |
As of the 2018-06-01 release, the following fields are also returned by GET /terminals:
| Field | Format | Description |
|---|---|---|
| accountId | UUID (e.g. 88888888-4444-4444-4444-cccccccccccc) |
Unique identifier for the Account in PayJunction. This is the UUID sent in the headers of webhook callbacks as Pj-Account. See Article |
| companyDba | string | The doing-business-as name for the merchant. |
| companyLegal | string | The legal business name for the merchant. |
| merchantNumber | string | The acquirer merchant ID number used by issuing banks and card processing networks to identify the merchant account. Not related to the pj-merchant header sent in webhook payloads. |
As of the 2023-05-16 release, the following fields are also returned by GET /terminals.
Click here for more information regarding surcharge.
| Field | Format | Description |
|---|---|---|
| surcharge | Object | |
| surcharge.enabled | Boolean | True if surcharge is enabled |
| surcharge.percentage | Number (e.g. 3.000) | Percentage of the total amount used to calculate the surcharge. Present only if surcharge is enabled. |
| surcharge.taxable | Boolean | True if surcharge is taxable. See Taxable Surcharge. |
| surcharge.disclosure | Array of strings | Surcharge disclosure message. See Surcharge Disclosure Requirements. |
Example Request
curl -X GET -u "login:password" \ -H "Accept: application/json" \ -H "X-PJ-Application-Key: YOUR_PRODUCTION_APP_KEY" \ "https://api.payjunctionlabs.com/terminals/"
Example Response
{
"results": [
{
"terminalId": 1,
"accountId": "38b18588-fbe4-4108-8f78-9bdcfa69d599",
"companyLegal": "PayJunction Demo",
"companyDba": "PayJunction Demo",
"merchantNumber": "12345678",
"nickName": "Credit Card Batch",
"type": "CARD",
"enabled": true,
"surcharge" : {
"enabled" : false
}
}, {
"terminalId" : 2,
"accountId" : "681d0f12-4f4e-43fb-a2e4-b96f4bf50d4d",
"companyLegal" : "Payjunction - (demo)",
"companyDba" : "Payjunction - (demo) DBA",
"merchantNumber" : "12345678",
"nickName" : "Surcharge enabled",
"type" : "CARD",
"enabled" : true,
"surcharge" : {
"enabled" : true,
"percentage" : 3.00,
"taxable" : true,
"disclosure" : [ "A surcharge applies to credit card transactions. The current rate is 3%. No surcharge applies to debit card transactions." ]
}
}, {
"terminalId": 3,
"accountId": "f4700f11-7268-4508-a19d-b60465164fc9",
"companyLegal": "PayJunction Demo",
"companyDba": "PayJunction Demo",
"merchantNumber": "12345678",
"nickName": "Checks",
"type": "ACH",
"enabled": true
}
]
}