Brand Create V2

app

string

Defaults to customer-brand

customer-brand

object

string

Defaults to brand

brand

action

string

Defaults to create

create

version

int32

Defaults to 2

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

finTechUuid

string

FinTech uuid

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

referenceNumber

string

If a referenceNumber is not provided, one will be generated

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

name

string

Brand Name

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

website

string

Valid URL

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

contactName

string

Main contact for Brand

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

jobTitle

string

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

string

Email Address

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

pciCompliant

boolean

Defaults to false

0 = false
1 = true
Default is set to 0

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

checkingAccountLength

int32

This should be a value between the number 5 and the number 12 and not a 12 or 5 digit number

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

checkingAccountPrefix

string

All digits including leading zeros
99999

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

decisionSetUuid

string

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

displayName

string

The name that will be used in customer transaction descriptions such as purchases and fees

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

city

string

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

state

string

enum

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

Allowed:

country

string

Current valid values:
United States of America
USA

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

200200