Transaction Search V1

post

https://processor-api.uat1.pcaasa.com/?call=transaction-search-v1

Body Params

app

string

Defaults to customer-transaction

customer-transaction

object

string

Defaults to transaction

transaction

action

string

Defaults to search

version

int32

Defaults to 1

sessionUuid

string

The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

externalTranUuid

string

An identifier for tracking this API call

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

includeDeclines

boolean

Defaults to false

Default is set to 0

Data type: boolean
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

includePending

boolean

Defaults to false

Default is set to 0

Data type: boolean
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

transactionUuid

string

Identifier for this transaction (Can be used to search in the log file)

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

activityDateStart

date

activityDateStart Date range start

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

activityDateEnd

date

Date range end

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

authDateStart

date

Date range start

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

authDateEnd

date

Date range end

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

postDateStart

date

Date range start

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

postDateEnd

date

Date range end

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

reversalDateStart

date

Transaction reversal date range start

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

reversalDateEnd

date

Transaction reversal date range end

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

declineDateStart

date

Date range start

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

declineDateEnd

date

Date range end

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 10
Max: 10

lastTransactionDateStart

date

Date range start

Data type: date
Required: no
Letters: no
Numbers: yes
Special: no
Min: 10
Max: 10

lastTransactionDateEnd

date

Date range end

Data type: date
Required: no
Letters: no
Numbers: yes
Special: no
Min: 10
Max: 10

amountMin

float

Minimum transaction amount being searched

Data type: money
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 4
Max: 25

amountMax

float

Maximum transaction amount being searched

Data type: money
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 4
Max: 25

paymentInstrumentUuid

string

Identifier for this payment instrument

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

paymentInstrumentReferenceNumber

string

Reference number for payment instrument being searched

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 12
Max: 50

accountUuid

string

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

accountReferenceNumber

string

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 6
Max: 50

accountSegmentUuid

string

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

accountSegmentReferenceNumber

string

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 6
Max: 50

transactionCode

string

Transaction codes are always 8 alphanumeric characters (e.g., CIBKLXXX).

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 8
Max: 8

transactionDescription

string

Combination of merchant name, city, state, country

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 1
Max: 50

merchantName

string

Merchant may choose the information to include in this field (e.g., phone number, store number, name))

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 23

companyName

string

DBA name if present or legal name

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 100

companyReferenceNumber

string

company reference number provided or assigned at company creation

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 6
Max: 50

companyUuid

string

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

limit

int32

Defaults to 500

Number of rows returned
Default is set to 500
Max value is 1000

Data type: number
Required: yes
Letters: no
Numbers: yes
Special: yes
Min: 1
Max: 1000

offset

int32

Defaults to 0

Record to start with on returning results

Default is set to 0

Data type: number
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 0
Max: 999,999

debug

boolean

Defaults to false

0 = debug off
1 = debug on
Default is set to 0

Data type: boolean
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

Response

200200