Payment Instrument Secure Data Token Create V1

post

https://processor-api.uat1.pcaasa.com/?call=payment-instrument-secure-data-token-create-v1

Request a secure data retrieval token for virtual card information

Body Params

app

string

Defaults to customer-paymentinstrument

customer-paymentinstrument

object

string

Defaults to payment-instrument-secure-data-token

payment-instrument-secure-data-token

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: no
Numbers: yes
Special: yes*
Min: 36
Max: 36

externalTranUuid

string

Identifier for tracking this API call

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

referenceNumber

string

The reference number of the card info to be retrieved

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

cardholderCode

string

An optional alphanumeric code that, if provided, must be entered by the cardholder upon use of the token in the retrieval API

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

cardholderIpAddress

string

An optional IP address that, if provided, must be in use by the cardholder upon use of the token in the retrieval API

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

requireCardholderPostalCode

boolean

Defaults to false

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

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

Language

Response

Choose an example:

application/json

200200