Account Search V1

post

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

Body Params

app

string

Defaults to customer-account

customer-account

object

string

Defaults to account

account

action

string

Defaults to search

version

int32

Defaults to 1

sessionUuid

string

required

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: no
Min: 36
Max: 36

externalTranUuid

string

An identifier for tracking this API call

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

finTechUuid

string

FinTech Uuid

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

finTechName

string

FinTech Name

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

brandUuid

string

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

brandName

string

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

companyUuid

string

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

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

companyName

string

DBA name if present or legal name

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

productUuid

string

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

productName

string

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

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

accountStatus

string

enum

Valid Values:
- Open
- Closed
- Blocked

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

Allowed:

accountState

string

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

AccountStateReason

string

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

accountUserUuid

string

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

accountUserStatus

string

enum

Valid Values:
- Open
- Closed
- Blocked
- Deleted

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

Allowed:

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

paymentInstrumentUuid

string

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

paymentInstrumentStatus

string

enum

Valid Values:
- Open
- Blocked
- Closed

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

Allowed:

paymentInstrumentState

string

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

paymentInstrumentStateReason

string

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

last4Card

string

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

cardId

string

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

plasticDetailUuid

string

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

plasticDetailStatus

string

enum

Valid Values:
- Activated
- Not Activated
- Replaced
- Unprovisioned
- Destroyed
- Closed

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

Allowed:

referenceNumber

string

12-digit numeric value which identifies the card

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

embossName

string

Name embossed on plastic detail

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

personUuid

string

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

emailUuid

string

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

string

Email Address

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

phoneUuid

string

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

phone

string

Phone Number

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

name

string

Person's first, middle, and last name

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

last4SSN

string

Last 4 digits of social security number

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

addressUuid

string

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

addressLine1

string

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

addressLine2

string

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

city

string

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

state

string

For U.S. Addresses this should be the 2 character state code

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

postalCode

string

Special character allowed:
- (hypen)

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

accountCustomerNumber

string

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

userId

string

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

location

string

Location tracking (e.g. branch number)

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

accountUserMemberNumber

string

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

accountUserCustomerNumber

string

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

checkingAccountNumber

string

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

cardToken

string

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

shipmentReferenceNumber

string

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

shipmentStatus

string

enum

Statuses are specified in order of process:
- Pending
- Canceled
- Processing
- Confirmed Received

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

Allowed:

contains

string

Full text search

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

limit

int32

required

Defaults to 50

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

string

Defaults to 0

Record to start with on returning results
Default is set to 0

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

debug

string

Defaults to 0

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

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

name1

string

name2

string

Response

200200