B2B API Specification

Get a request by ID

get /v3/pax/request/{request_id}

Get the raw request that was sent to the hardware device itself.

Useful for repeatedly calling (polling) to verify data transmission through PayTrace servers to device delivery.

When the result is no longer a 404 not found, it is indicative of successful hardware delivery.

Please try to call no more than once every 3 seconds.

When webhook is fully supported, the polling usage will be redundant.

Parameters

request_id required

Type

string

Loading...

Authorization

Type

string

Loading...

tok

Type

string

Loading...

Example Response

200 Successful Response

422 Validation Error

Get responses by request ID

get /v3/pax/response/by-req-id/{request_id}

Get the raw response that was sent from the hardware device itself.

Useful for repeatedly calling (polling) to verify user activity completion on the hardware device itself.

When the result is no longer an empty array, it is indicative of successful hardware activity resolution (payment processed, aborted, timed out etc.).

Please try to call no more than once every 3 seconds.

When webhook is fully supported, the polling usage will be redundant.

Parameters

request_id required

Type

string

Loading...

Authorization

Type

string

Loading...

tok

Type

string

Loading...

Example Response

200 Successful Response

422 Validation Error

Get list of terminals by merchant id

get /v3/pax/terminal/by-merchant-id/{merchant_id}

Returns a list of all terminals registered for a given merchant account.

Terminal registration occurs via the hardware device itself, upon user sign-in.

Parameters

merchant_id required

Type

integer

Loading...

ignore_filter

Type

boolean

Loading...

Authorization

Type

string

Loading...

tok

Type

string

Loading...

Example Response

200 Successful Response

422 Validation Error

Get a terminal by ID

get /v3/pax/terminal/{terminal_id}

Fetches details specific to a single given terminal_id.

The terminal_id can be acquired by calling the appropriate list endpoint.

Terminal registration occurs via the hardware device itself, upon user sign-in.

Parameters

terminal_id required

Type

string

Loading...

Authorization

Type

string

Loading...

tok

Type

string

Loading...

Example Response

200 Successful Response

422 Validation Error

Delete a terminal

delete /v3/pax/terminal/{terminal_id}

Flag a terminal as deleted. Allows for the hardware to re-create the terminal record upon next sign in.

Terminal registration occurs via the hardware device itself, upon user sign-in.

Parameters

terminal_id required

Type

string

Loading...

Authorization

Type

string

Loading...

tok

Type

string

Loading...

Example Response

200 Successful Response

422 Validation Error

Update an existing terminal

patch /v3/pax/terminal/{terminal_id}

Update assigned values of the terminal (nickname etc.).

Terminal registration occurs via the hardware device itself, upon user sign-in.

Parameters

terminal_id required

Type

string

Loading...

Authorization

Type

string

Loading...

tok

Type

string

Loading...

Request Schema

serial_number

Type

string

Minimum Length

1

Loading...

label

Type

string

Minimum Length

0

Loading...

location

Type

string

Minimum Length

0

Loading...

model

Type

string

Minimum Length

0

Loading...

processor_terminal_id

Type

string

Minimum Length

0

Loading...

is_deactivated

Type

boolean

Loading...

android_id

Type

string

Loading...

disallow_local_payment

Type

boolean

Default

false

Loading...

authorized_users

Type

array

Loading...

Example Request

{
  "serial_number": "string",
  "label": "string",
  "location": "string",
  "model": "string",
  "processor_terminal_id": "string",
  "is_deactivated": "boolean",
  "android_id": "string",
  "disallow_local_payment": false,
  "authorized_users": "array"
}

Example Response

200 Successful Response

422 Validation Error

Sale By Terminal ID

post /v3/card/sale/terminal/{terminal_id}

A Terminal Sale will allow you to process a transaction with an existing Terminal ID (Token) from your Semi Integrated Terminal provided by PayTrace.

The response will include the pending transaction id.

Parameters

terminal_id required

Type

string

Loading...

X-Integrator-Id

Type

string

Maximum Length

12

Loading...

X-Permalinks

Type

string

Maximum Length

4

Loading...

Request Schema

amount required

Type

number

Range

0 to 100000000000000000

Example

80.55

Loading...

billing_name

Type

string

Example

Steve Smith

Loading...

billing_address

Type

object

Loading...

billing_email

Type

string

Example

email@domain.com

Loading...

billing_phone

Type

string

Maximum Length

20

Loading...

description

Type

string

Example

business services

Loading...

invoice_number

Type

string

Example

17

Loading...

merchant_id required

Type

integer

Example

246810

Loading...

custom_dba

Type

string

Example

Doing Business As Test Company

Loading...

customer_id

Type

integer

Example

2132345

Loading...

shipping_address

Type

object

Loading...

shipping_name

Type

string

Example

Steve Smith

Loading...

tax_amount

Type

string

Example

2.16

Loading...

discretionary_data

Type

array

Loading...

Example Request

{
  "amount": 80.55,
  "billing_name": "Steve Smith",
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "description": "business services",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "customer_id": 2132345,
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  }
}

Example Response

200 Successful Response

422 Validation Error

Refund By Terminal ID

post /v3/card/refund/terminal/{terminal_id}

A Terminal Refund will allow you to process a transaction with an existing Terminal ID (Token) from your Semi Integrated Terminal provided by PayTrace.

The response will include the pending transaction id.

Parameters

terminal_id required

Type

string

Loading...

X-Integrator-Id

Type

string

Maximum Length

12

Loading...

X-Permalinks

Type

string

Maximum Length

4

Loading...

Request Schema

amount required

Type

number

Range

0 to 100000000000000000

Example

80.55

Loading...

billing_name

Type

string

Example

Steve Smith

Loading...

billing_address

Type

object

Loading...

billing_email

Type

string

Example

email@domain.com

Loading...

billing_phone

Type

string

Maximum Length

20

Loading...

description

Type

string

Example

business services

Loading...

invoice_number

Type

string

Example

17

Loading...

merchant_id required

Type

integer

Example

246810

Loading...

custom_dba

Type

string

Example

Doing Business As Test Company

Loading...

customer_id

Type

integer

Example

2132345

Loading...

shipping_address

Type

object

Loading...

shipping_name

Type

string

Example

Steve Smith

Loading...

tax_amount

Type

string

Example

2.16

Loading...

discretionary_data

Type

array

Loading...

Example Request

{
  "amount": 80.55,
  "billing_name": "Steve Smith",
  "billing_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "billing_email": "email@domain.com",
  "billing_phone": "string",
  "description": "business services",
  "invoice_number": "17",
  "merchant_id": 246810,
  "custom_dba": "Doing Business As Test Company",
  "customer_id": 2132345,
  "shipping_address": {
    "street": "1 Main St.",
    "street2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "country": "US",
    "postal_code": "85284",
    "county": "Oakland"
  },
  "shipping_name": "Steve Smith",
  "tax_amount": "2.16",
  "discretionary_data": {
    "disc_id": "integer",
    "value": "string"
  }
}

Example Response

200 Successful Response

422 Validation Error

Void By Terminal ID

post /v3/card/void/terminal/{terminal_id}/{transaction_id}

A Terminal Void will allow you to process a transaction with an existing Terminal ID (Token) from your Semi Integrated Terminal provided by PayTrace.

The response will include the pending transaction id.

Parameters

terminal_id required

Type

string

Loading...

transaction_id required

Type

string

Loading...

X-Integrator-Id

Type

string

Maximum Length

12

Loading...

X-Permalinks

Type

string

Maximum Length

4

Loading...

Request Schema

merchant_id required

Type

integer

Example

246810

Loading...

Example Request

{
  "merchant_id": 246810
}

Example Response

200 Successful Response

422 Validation Error

PAXEMV

Get a request by ID

Get responses by request ID

Get list of terminals by merchant id

Get a terminal by ID

Delete a terminal

Update an existing terminal

Sale By Terminal ID

Refund By Terminal ID

Void By Terminal ID

Contact Us