Skip to main content
POST
Search

Authorizations

Authorization
string
header
required

Your Paysight API key. You can find it in your Paysight account at https://app.paysight.io/settings/account

Headers

ClientId
string
required

Your Paysight Tenant/Client Id. This is the id of the parent company listed in https://app.paysight.io/management/companies. Alternatively, this will be provided by Paysight

UserEmail
string
required

The email address of the party or group making the request

Body

application/json

Payload

parentCompanyId
integer
required

Your Paysight tenant id. This will be provided by Paysight.

Example:

1

userEmail
string<email>
required

An email associated with the party/agent making the request

Example:

"care@yourdomain.com"

email
string<email>

The email address of the customer. This is required if no other search parameters (name or card number) is provided

Example:

"joe@bloggs.com"

cardNumber
string

This can be the full 16 digit card number or the card number with the middle 6 digits redacted, as per example.

Example:

"535456******1742"

name
string

Customer name. This can be entered along with cardNumber. If entered alone then it must be at least 10 characters

Example:

"Joe Bloggs"

orderId
integer

The unique Paysight orderId

Example:

1095654254

Response

200 - application/json

Valid Request. More detailed info will be in the JSON body

success
boolean

This indicates if this request was processed successfully, no validation issues etc.

Example:

true

message
string

Debug information

Example:

""

transactions
object[]

Array of transactions