API Reference

Payment Instrument Status Update V1

post
https://processor-api.uat1.pcaasa.com/?call=payment-instrument-status-update-v1
Body Params
string
Defaults to customer-paymentinstrument

customer-paymentinstrument

string
Defaults to payment-instrument-status

payment-instrument-status

string
Defaults to update

update

int32
Defaults to 1

1

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

string

Identifier for tracking this API call

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

string

If cardReferenceNumber has not been provided, paymentInstrumentUuid must be provided

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

string

If paymentInstrumentUuid has not been provied, cardReferenceNumber must be provided

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

string
enum

Valid values:
- Open
- Blocked
- Closed
Cannot update from 'closed' status

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

Allowed:
string

Must utilize the proper combination of status, state, and state reason.

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

string

Must utilize the proper combination of status, state, and state reason.

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

boolean
Defaults to false

Default is set to 0

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

Response

Updated 11 months ago

Language
Response 
 Choose an example:
application/json
Updated 11 months ago