Skip to main content
POST
Create a Deployment Varsheet

Authorizations

Authorization
string
header
required

Enter token in following format: Bearer

Body

application/json
entityId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
entityType
enum<string>
required
Available options:
lead,
client,
user,
processor,
document,
ticket,
transactions,
batch,
statement
midId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
vNumber
string
required
terminalIdNumber
string | null
agent
string | null
storeNumber
string | null
merchantNumber
string | null
currencyCode
string | null
timeZoneCode
string | null
timeZoneDifferential
string | null
discoverNumber
string | null
amexOptBlue
boolean | null
pinDebit
boolean | null
ebtFoodStamps
boolean | null
ebtCash
boolean | null
merchantLocationNumber
string | null
merchantABANumber
string | null
merchantSettlementAgent
string | null
reimbursementAttribute
string | null
sharingGroup
string | null
industry
string | null
fcsNumber
string | null

Response

The created deployment varsheet.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
entityId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
entityType
enum<string>
required
Available options:
lead,
client,
user,
processor,
document,
ticket,
transactions,
batch,
statement
midId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
vNumber
string
required
terminalIdNumber
string | null
required
agent
string | null
required
chain
string | null
required
storeNumber
string | null
required
merchantNumber
string | null
required
currencyCode
string | null
required
timeZoneCode
string | null
required
timeZoneDifferential
string | null
required
discoverNumber
string | null
required
amexOptBlue
boolean | null
required
pinDebit
boolean | null
required
ebtFoodStamps
boolean | null
required
ebtCash
boolean | null
required
merchantLocationNumber
string | null
required
merchantABANumber
string | null
required
merchantSettlementAgent
string | null
required
reimbursementAttribute
string | null
required
sharingGroup
string | null
required
industry
string | null
required
fcsNumber
string | null
required
createdAt
string
required
createdBy
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
updatedAt
string
required
updatedBy
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$