Spend Control Create V1

post

https://processor-api.uat1.pcaasa.com/?call=spend-control-create-v1

Create a spend control Listed below are the options for spend control types and their corresponding required inputs

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

app

string

Defaults to customer-spendcontrol

customer-spendcontrol

object

string

Defaults to spend-control

spend-control

action

string

Defaults to create

create

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

Identifier for tracking this API call

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

spendControlTypeCode

string

enum

Type code of spend control being created
TRANTOTALFROMTIME (Each time this control is created, the calculated amount will be reset to 0)

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

objectType

string

enum

Object type that a spend control is being created for

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

Allowed:

objectUuid

string

Unique identifier of specific object that a spend control is being created for
If objectReferenceNumber has not been provided, objectUuid must be provided

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

objectReferenceNumber

string

if objectUuid is not provided, objectReferenceNumber must be provided

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

replaceExistingControl

int32

Defaults to 0

Valid values
1
0
Default is set to 0

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

startDate

date

Special characters allowed:
hyphen (-)
colon (:)
period (.)

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

endDate

date

Special characters allowed:
hyphen (-)
colon (:)
period (.)

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

gmtOffsetHours

int32

Defaults to 0

Default is set to 0

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

minAmount

float

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

maxAmount

float

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

maxCount

int32

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

mccCodeList

string

Vaild special character: space (' ')

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

namePrefixList

string

Invaild special character: comma (,)

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

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