Payment Instrument Create V1

Add additional payment instrument(s) to an existing account user

Body Params
string
Defaults to customer-paymentinstrument

customer-paymentinstrument

string
Defaults to payment-instrument

payment-instrument

string
Defaults to action

create

int32
Defaults to null

1

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

string

Identifier for tracking this API call

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

string



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

string



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

string

Name embossed on card
Special characters allowed for emboss name:
-(hyphen)
' ' (space)
. (dot)

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

string
enum



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

Allowed:
boolean



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

boolean
Defaults to false



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

string

Value defining the desired custom logo for plastic(s) being ordered

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

string

Value defining the desired custom design for plastic(s) being ordered
Special characters allowed: dot (.), hyphen (-), underscore (_)

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

json

Must be a JSON object w/ simple properties

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

boolean
Defaults to false

Default is set to 0

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

string

If productUuid has not been provided, productReferenceNumber must be provided

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

string

If accountUserUuid and cardReferenceNumber have not been provided, accountUserReferenceNumber must be provided

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

string

If accountUserUuid and accountUserReferenceNumber have not been provided, cardReferenceNumber must be provided

This cardReferenceNumber must be associated with the account the new payment instrument will be associated with

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

Response

Language
Response
Choose an example:
application/json