Spend Control Update V1

post

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

Update a spend control and preserve a history of previously used spend controls. Any optional field for which a new value has not been provided will retain the current value in the updated spend control. Listed below are the options for spend control types and their corresponding required inputs

Body Params

app

string

Defaults to customer-spendcontrol

customer-spendcontrol

object

string

Defaults to spend-control

spend-control

action

string

Defaults to update

update

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

spendControlUuid

string

Unique identifier for the spend control being updated
Conditionally required
When objectReferenceNumber has not been provided, spendControlUuid must be provided

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

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

objectReferenceNumber

string

ReferenceNumber for the specific object a spend control corresponds to
Conditionally required
If spendControlUuid and objectUuid have not been provided, objectReferenceNumber must be provided

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

objectType

string

enum

Identifier for a specific spend control
Conditionally required
Allowed and required only when objectUuid and/or objectReferenceNumber is passed

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

Allowed:

spendControlTypeCode

string

enum

Conditionally required
Allowed and required only when objectUuid and/or objectReferenceNumber is passed in and deleteAll is set to 0

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

Response

200200