{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/payrix/main/json-schema/payrix-alert-actions-post-request-schema.json",
"title": "alertActionsPostRequest",
"x-generated": "2026-09-21",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/payrix-alert-actions-api-openapi.yml#/components/schemas/alertActionsPostRequest",
"required": [
"alert",
"type",
"options",
"value"
],
"type": "object",
"properties": {
"alert": {
"allOf": [
{
"$ref": "#/$defs/alertActionsPostRequestModelAlert"
},
{
"description": "The identifier of the Alert resource that defines this alertAction."
}
]
},
"headerName": {
"type": "string",
"description": "The request header name for authentication to the endpoint."
},
"headerValue": {
"type": "string",
"description": "The request header value for authentication to the endpoint."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/alertActionType"
},
{
"description": "The medium to use to deliver this Alert.\n\n\nValid Values
\n\n- `email` - **Deliver the Alert to an email address.**\n- `web` - **Deliver the Alert through a web site notification.**\n- `app` - **Deliver the Alert through a mobile application notification.**\n- `sms` - **Deliver the Alert through an SMS message to a mobile device.**\n\n "
}
]
},
"options": {
"type": "string",
"description": "When the 'type' field of this resource is set to 'web', this field determines the format that the Alert data should be sent in."
},
"value": {
"type": "string",
"description": "A value used to deliver the alert. Thie field should be set to an email address if the type is email, an endpoint if the type is web, etc."
},
"retries": {
"type": [
"integer",
"null"
],
"description": "The number of times an alert should be resent in case of a failure. This fields can only be set for web type alertActions.",
"contentEncoding": "int32"
},
"maxAttemptsTempDisabled": {
"allOf": [
{
"$ref": "#/$defs/alertActionsMaxAttemptsTempDisabled"
},
{
"description": "Whether it was temporarily disabled for reaching the maximum number of failed attempts.\n\n\nValid Values
\n\n- `0` - **Not Temporarily Disabled**\n- `1` - **Temporarily Disabled**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
},
"$defs": {
"CurrencyConversion": {
"title": "CurrencyConversion",
"enum": [
"customerAccepted",
"customerRejected",
"notEligible"
],
"type": "string"
},
"MembersGender": {
"title": "MembersGender",
"enum": [
"male",
"female"
],
"type": "string"
},
"MembersTimezone": {
"title": "MembersTimezone",
"enum": [
"est",
"cst",
"pst",
"mst",
"akst",
"hst",
"sst",
"chst",
"ast",
"pwt",
"mht",
"chut",
"nst"
],
"type": "string"
},
"MerchantsNew": {
"title": "MerchantsNew",
"enum": [
0,
1
],
"type": "integer"
},
"accountMethod": {
"title": "accountMethod",
"enum": [
8,
9,
10,
11
],
"type": "integer"
},
"accountPrimary": {
"title": "accountPrimary",
"enum": [
0,
1
],
"type": "integer"
},
"accountStatus": {
"title": "accountStatus",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
"accountType": {
"title": "accountType",
"enum": [
"all",
"credit",
"debit"
],
"type": "string"
},
"accountUpdaterEligible": {
"title": "accountUpdaterEligible",
"enum": [
1,
0
],
"type": "integer"
},
"accountsAccount": {
"title": "accountsAccount",
"type": "object",
"properties": {
"method": {
"allOf": [
{
"$ref": "#/$defs/accountMethod"
},
{
"description": "The type of the Account.\n\n\nValid Values
\n\n- `8` - **Checking**\n- `9` - **Savings**\n- `10` - **Corporate Checking**\n- `11` - **Corporate Savings**\n\n "
}
]
},
"number": {
"type": "string",
"description": "The number of the bank account."
},
"routing": {
"type": "string",
"description": "The routing number of the bank account. This field is stored as a text string and must be between 5 and 20 characters long."
}
},
"description": "An object representing details of the Account, including the type of Account (method), Account number, and routing code."
},
"accountsPostRequest": {
"title": "accountsPostRequest",
"required": [
"entity",
"account",
"currency"
],
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The identifier of the Entity associated with this Account."
},
"account": {
"allOf": [
{
"$ref": "#/$defs/accountsAccount"
},
{
"description": "An object representing details of the Account, including the type of Account (method), Account number, and routing code."
}
]
},
"name": {
"type": "string",
"description": "A client-supplied name for this bank account. \nThis field is stored as a string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A client-supplied description for this bank account. \nThis field is stored as a string and must be between 0 and 100 characters long."
},
"primary": {
"allOf": [
{
"$ref": "#/$defs/accountPrimary"
},
{
"description": "Indicates whether the Account is the primary Account for the associated Entity. \nOnly one Account associated with each Entity can be the primary Account.\n\n\nValid Values
\n\n- `0` - **Not primary**\n- `1` - **Primary**\n\n "
}
]
},
"type": {
"allOf": [
{
"$ref": "#/$defs/accountType"
},
{
"description": "The type of financial account: debit, credit, or both.\n\n\nValid Values
\n\n- `all` - **Debit/checking and credit**\n- `credit` - **Credit only**\n- `debit` - **Debit/checking only**\n\n "
}
]
},
"status": {
"allOf": [
{
"$ref": "#/$defs/accountStatus"
},
{
"description": "The status of the Account.\n\n\nValid Values
\n\n- `0` - **Not Ready.**\n- `1` - **Ready.**\n- `2` - **Challenged.**\n- `3` - **Verified.**\n- `4` - **Manual.**\n\n "
}
]
},
"expiration": {
"type": "string",
"description": "The expiration date of the related debit account. The date is specified as a four-digit string in MMYY format, for example, `0118` for January 2018."
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency of this Account. The default is `USD`. See Currency codes for all valid values."
}
]
},
"publicToken": {
"type": "string",
"description": "The token received from the Plaid account connection process."
},
"mask": {
"type": "string",
"description": "The account number mask, showing the last four digits of the account number."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"payouts": {
"type": "array",
"items": {
"$ref": "#/$defs/payoutPostRequest"
},
"description": ""
}
},
"description": "A request body for creating new bank account information for one or more entities."
},
"aggregationDefault": {
"title": "aggregationDefault",
"enum": [
0,
1
],
"type": "integer"
},
"aggregationSchedule": {
"title": "aggregationSchedule",
"enum": [
"hours",
"days",
"weeks",
"months",
"years"
],
"type": "string"
},
"aggregationStatus": {
"title": "aggregationStatus",
"enum": [
"notReady",
"ready",
"processing",
"processed"
],
"type": "string"
},
"aggregationType": {
"title": "aggregationType",
"enum": [
"entityEntryEventMerchant",
"merchantTxnApprovedAll",
"merchantTxnCapturedAll",
"merchantTxnFailedAll"
],
"type": "string"
},
"aggregationsLevel": {
"title": "aggregationsLevel",
"enum": [
"admin",
"division",
"merchant",
"partition"
],
"type": "string"
},
"aggregationsPostRequest": {
"title": "aggregationsPostRequest",
"required": [
"login",
"resource",
"totals",
"schedule",
"start"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login that owns this Aggregation."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this Aggregation applies to."
},
"forlogin": {
"type": "string",
"description": "The identifier of the Login that this Aggregation applies to."
},
"org": {
"type": "string",
"description": "The identifier of the Org that this Aggregation applies to."
},
"team": {
"type": "string",
"description": "The identifier of the Team that this Aggregation applies to."
},
"division": {
"type": "string",
"description": "The identifier of the Division that this Aggregation applies to."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition that this Aggregation applies to."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/aggregationType"
},
{
"description": "The type of aggregation. This will automatically set the search and total values.\n\n\nValid Values
\n\n- `entityEntryEventMerchant` - **A merchant entry.**\n- `merchantTxnApprovedAll` - **All merchant transactions approved.**\n- `merchantTxnCapturedAll` - **All merchant transactions captured.**\n- `merchantTxnFailedAll` - **All merchant transactions failed.**\n\n "
}
]
},
"level": {
"allOf": [
{
"$ref": "#/$defs/aggregationsLevel"
},
{
"description": "The level of user that this aggregation will run for.\n\n\nValid Values
\n\n- `admin` - **Admin User.**\n- `division` - **Division-level User.**\n- `merchant` - **Merchant-level User.**\n- `partition` - **Partition-level User.**\n\n "
}
]
},
"name": {
"type": "string",
"description": "The name of this Aggregation. This field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Aggregation. This field is stored as a text string and must be between 0 and 100 characters long."
},
"resource": {
"allOf": [
{
"$ref": "#/$defs/resource"
},
{
"description": "Valid Values
\n\n- `1` - **apiKeys**\n\n- `2` - **contacts**\n\n- `3` - **customers**\n\n- `4` - **alertTriggers**\n\n- `5` - **iplists**\n\n- `6` - **items**\n\n- `7` - **alerts**\n\n- `8` - **logins**\n\n- `9` - **merchants**\n\n- `10` - **orgs**\n\n- `12` - **permissions**\n\n- `13` - **decisions**\n\n- `14` - **parameters**\n\n- `15` - **sessions**\n\n- `16` - **alertActions**\n\n- `17` - **tokens**\n\n- `18` - **txns**\n\n- `19` - **teamLogins**\n\n- `20` - **credentials**\n\n- `21` - **members**\n\n- `22` - **accounts**\n\n- `23` - **plans**\n\n- `24` - **subscriptions**\n\n- `25` - **subscriptionTokens**\n\n- `26` - **disbursements**\n\n- `27` - **entries**\n\n- `28` - **fees**\n\n- `29` - **funds**\n\n- `30` - **orgEntities**\n\n- `31` - **payouts**\n\n- `32` - **feeRules**\n\n- `33` - **entityRefs**\n\n- `34` - **chargebacks**\n\n- `35` - **decisionRules**\n\n- `36` - **entities**\n\n- `37` - **facilitators**\n\n- `38` - **partitions**\n\n- `39` - **merchantResults**\n\n- `40` - **mccs**\n\n- `41` - **mappings**\n\n- `42` - **refunds**\n\n- `43` - **batches**\n\n- `44` - **txnResults**\n\n- `45` - **confirmCodes**\n\n- `46` - **accountVerifications**\n\n- `47` - **disbursementResults**\n\n- `48` - **reserveEntries**\n\n- `49` - **chargebackMessages**\n\n- `50` - **hosts**\n\n- `53` - **txnRefs**\n\n- `54` - **verifications**\n\n- `55` - **verificationResults**\n\n- `56` - **chargebackMessageResults**\n\n- `57` - **assessments**\n\n- `58` - **entryOrigins**\n\n- `59` - **adjustments**\n\n- `60` - **txnDatas**\n\n- `61` - **revenueBoosts**\n\n- `62` - **orgFlows**\n\n- `63` - **orgFlowActions**\n\n- `64` - **accountVerificationResults**\n\n- `65` - **disbursementRefs**\n\n- `66` - **reserves**\n\n- `67` - **entityReserves**\n\n- `68` - **txnReports**\n\n- `69` - **payoutFlows**\n\n- `70` - **vendors**\n\n- `71` - **fundOrigins**\n\n- `72` - **entityRoutes**\n\n- `73` - **pendingEntries**\n\n- `74` - **terminals**\n\n- `75` - **terminalRefs**\n\n- `76` - **holds**\n\n- `77` - **holdNotes**\n\n- `78` - **files**\n\n- `79` - **messageThreads**\n\n- `80` - **messages**\n\n- `81` - **bins**\n\n- `82` - **feeModifiers**\n\n- `83` - **versions**\n\n- `84` - **chargebackDocuments**\n\n- `85` - **divisions**\n\n- `86` - **entityReturns**\n\n- `87` - **chargebackStatuses**\n\n- `88` - **profitShares**\n\n- `89` - **profitShareResults**\n\n- `90` - **aggregations**\n\n- `91` - **aggregationResultGroups**\n\n- `92` - **aggregationResults**\n\n- `93` - **auditLogs**\n\n- `94` - **invoiceParameters**\n\n- `95` - **invoices**\n\n- `96` - **secrets**\n\n- `97` - **watchlists**\n\n- `98` - **watchlistItems**\n\n- `99` - **txnMetadatas**\n\n- `100` - **invoiceResults**\n\n- `101` - **invoiceItems**\n\n- `102` - **invoiceLineItems**\n\n- `103` - **profitShareRules**\n\n- `104` - **configurations**\n\n- `105` - **currencyRates**\n\n- `106` - **terminalTxns**\n\n- `107` - **terminalTxnDatas**\n\n- `108` - **terminalTxnRefs**\n\n- `109` - **terminalTxnResults**\n\n- `110` - **configurationStages**\n\n- `111` - **disbursementEntries**\n\n- `112` - **decisionActions**\n\n- `113` - **notes**\n\n- `114` - **noteDocuments**\n\n- `115` - **paymentUpdates**\n\n- `117` - **paymentUpdateGroups**\n\n- `118` - **authTokens**\n\n- `119` - **reportResults**\n\n- `120` - **reports**\n\n- `121` - **reportItems**\n\n- `122` - **entityDebts**\n\n- `123` - **billings**\n\n- `124` - **billingModifiers**\n\n- `125` - **statements**\n\n- `126` - **statementEntries**\n\n- `127` - **billingEvents**\n\n- `128` - **fundingParameters**\n\n- `129` - **requestTokens**\n\n- `130` - **accountRefs**\n\n- `131` - **settlements**\n\n- `132` - **entityDatas**\n\n- `133` - **terminalTxnMetadatas**\n\n- `134` - **batchRefs**\n\n- `135` - **verificationRefs**\n\n- `136` - **externalFees**\n\n- `137` - **saferPayments**\n\n- `138` - **mfaRecoveryCodes**\n\n- `139` - **debtorEntities**\n\n- `140` - **omniTokens**\n\n- `141` - **changeRequests**\n\n- `142` - **txnSession**\n\n- `143` - **revShareSchedules**\n\n- `144` - **revShareStatements**\n\n- `145` - **loginsHelpers**\n\n- `146` - **entityCustomFields**\n\n- `147' - **DisbursementEntriesLog**\n\n- `148` - **merchantPlatformStatuses**\n\n- `149` - **DisbursementEntitiesLog**\n\n- `150` - **orgsVASSaferPayments**\n\n- `151` - **orgsVASOmniTokens**\n\n- `152` - **orgsVASRevenueBoosts**\n\n- `153` - **tokenResults**\n\n- `154` - **PlaidConsumerAccounts**\n\n- `155` - **appleDomains**\n\n- `156` - **PlaidConsumerPayments**\n\n- `157` - **saferPaymentsCompliance**\n\n- `158` - **orgFlowRules**\n\n- `159` - **TaxFormRequests**\n\n- `160` - **HostThemes**\n\n- `161` - **IntegrationResults**\n\n- `162` - **VasEfeOffers**\n\n- `163` - **VasEfeOfferUpdates**\n\n- `165` - **EmbeddedFinance**\n\n- `166` - **OrgsVASEfeProducts**\n\n- `167` - **EntityTerms**\n\n- `168` - **PinlessDebitConversions**\n\n- `169` - **OrgsVASPinlessDebitConversions**\n\n- `170` - **FraudSightEnablements**\n\n- `171` - **FraudSightResults**\n\n- `172` - **OrgsVASFraudSightEnablements**\n\nValid Values
\n\n- `notReady` - **Aggregation is not ready.**\n- `ready` - **Aggregation is ready.**\n- `processing` - **Aggregation is processing.**\n- `processed` - **Aggregation has been processed.**\n\n "
}
]
},
"schedule": {
"allOf": [
{
"$ref": "#/$defs/aggregationSchedule"
},
{
"description": "The schedule that determines when the aggregation function will be processed.\n\n\nValid Values
\n\n- `hours` - **Hourly schedule.**\n- `days` - **Daily schedule.**\n- `weeks` - **Weekly schedule.**\n- `months` - **Monthly schedule.**\n- `years` - **Annual schedule.**\n\n "
}
]
},
"scheduleFactor": {
"type": "integer",
"description": "A multiplier that you can use to adjust the schedule set in the 'schedule' field, such as daily, weekly, monthly, or annually. In This field is specified as an integer and its value determines how the interval is multiplied.",
"contentEncoding": "int32",
"default": 1
},
"start": {
"type": "integer",
"description": "The date on which the aggregation processing should start. The date is specified as a twelve digit string in YYYYMMDDHHII format, for example, '201601201528' for January 20, 2016 at 15:28 (3:28 pm). The value of this field must represent a date in the future, or the present date. When the schedule is set to HOURLY (1) the minute part of the time must be divisible by 10 (15:10, 15:20, 15:30, etc...).",
"contentEncoding": "int64"
},
"default": {
"allOf": [
{
"$ref": "#/$defs/aggregationDefault"
},
{
"description": "Indicates whether this aggregation was automatically created.\n\n\nValid Values
\n\n- `0` - **Manually created.**\n- `1` - **Automatically created.**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"alertActionType": {
"title": "alertActionType",
"enum": [
"email",
"web",
"app",
"sms"
],
"type": "string"
},
"alertActionsMaxAttemptsTempDisabled": {
"title": "alertActionsMaxAttemptsTempDisabled",
"enum": [
0,
1
],
"type": "integer"
},
"alertActionsPostRequest": {
"title": "alertActionsPostRequest",
"required": [
"alert",
"type",
"options",
"value"
],
"type": "object",
"properties": {
"alert": {
"allOf": [
{
"$ref": "#/$defs/alertActionsPostRequestModelAlert"
},
{
"description": "The identifier of the Alert resource that defines this alertAction."
}
]
},
"headerName": {
"type": "string",
"description": "The request header name for authentication to the endpoint."
},
"headerValue": {
"type": "string",
"description": "The request header value for authentication to the endpoint."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/alertActionType"
},
{
"description": "The medium to use to deliver this Alert.\n\n\nValid Values
\n\n- `email` - **Deliver the Alert to an email address.**\n- `web` - **Deliver the Alert through a web site notification.**\n- `app` - **Deliver the Alert through a mobile application notification.**\n- `sms` - **Deliver the Alert through an SMS message to a mobile device.**\n\n "
}
]
},
"options": {
"type": "string",
"description": "When the 'type' field of this resource is set to 'web', this field determines the format that the Alert data should be sent in."
},
"value": {
"type": "string",
"description": "A value used to deliver the alert. Thie field should be set to an email address if the type is email, an endpoint if the type is web, etc."
},
"retries": {
"type": [
"integer",
"null"
],
"description": "The number of times an alert should be resent in case of a failure. This fields can only be set for web type alertActions.",
"contentEncoding": "int32"
},
"maxAttemptsTempDisabled": {
"allOf": [
{
"$ref": "#/$defs/alertActionsMaxAttemptsTempDisabled"
},
{
"description": "Whether it was temporarily disabled for reaching the maximum number of failed attempts.\n\n\nValid Values
\n\n- `0` - **Not Temporarily Disabled**\n- `1` - **Temporarily Disabled**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"alertActionsPostRequestModelAlert": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/alertsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Alert resource that defines this alertAction."
},
"alertTriggerEvent": {
"title": "alertTriggerEvent",
"enum": [
"create",
"update",
"delete",
"ownership",
"batch",
"account",
"account.created",
"account.updated",
"payout",
"fee",
"changerequest.declined",
"changerequest.created",
"changerequest.approved",
"changerequest.manualReview",
"chargeback",
"chargeback.opened",
"chargeback.closed",
"chargeback.created",
"chargeback.lost",
"chargeback.won",
"chargebackdocument.uploaded",
"debit.disbursement.recovery",
"disbursement.requested",
"disbursement.processing",
"disbursement.processed",
"disbursement.failed",
"disbursement.denied",
"disbursement.report",
"disbursement.returned",
"disbursementEntries.processed",
"invoice.created",
"invoice.cancelled",
"invoice.emailed",
"invoice.expired",
"invoice.paid",
"invoice.refunded",
"invoice.viewed",
"invoiceResult.failure",
"merchant.created",
"merchant.boarding",
"merchant.boarded",
"merchant.closed",
"merchant.conditionally.approved",
"merchant.fully.boarded",
"merchant.pending",
"merchant.reserved",
"merchant.incomplete",
"merchant.failed",
"merchant.held",
"message.created",
"paymentupdate.report",
"resource.created",
"resource.updated",
"subscription.created",
"subscription.approved",
"subscription.failed",
"terminalTxn.created",
"terminalTxn.approved",
"terminalTxn.failed",
"txn.created",
"txn.approved",
"txn.failed",
"txn.captured",
"txn.settled",
"txn.returned",
"txn.echeck.funded",
"txn.delayed.funding",
"upcoming.debit.disbursement"
],
"type": "string"
},
"alertTriggerResource": {
"title": "alertTriggerResource",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
53,
54,
55,
56,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
117,
118,
119,
120,
121,
122,
123,
124,
125,
127,
128,
129,
130,
131,
132,
133,
134,
135,
136,
137,
138,
139,
140,
141,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
156,
157,
158,
159,
160,
161,
162,
163,
165,
166,
167,
168,
169,
170,
171,
172
],
"type": "integer"
},
"alertTriggersPostRequest": {
"title": "alertTriggersPostRequest",
"required": [
"alert",
"event",
"resource"
],
"type": "object",
"properties": {
"alert": {
"allOf": [
{
"$ref": "#/$defs/alertTriggersPostRequestModelAlert"
},
{
"description": "The identifier of the Alert resource that you want to invoke with this trigger."
}
]
},
"event": {
"allOf": [
{
"$ref": "#/$defs/alertTriggerEvent"
},
{
"description": "The event type that triggers the associated Alert.\n\n\nValid Values
\n\n- `create` - **Triggers when the associated resource is created.**\n- `update` - **Triggers when the associated resource is updated.**\n- `delete` - **Triggers when the associated resource is deleted.**\n- `ownership` - **Triggers when the ownership of the associated resource changes.**\n- `batch` - **Triggers when Transactions are captured in a batch.**\n- `account` - **Triggers when the Account associated with a Merchant is updated.**\n- `account.created` - **Triggers when the Account is created.**\n- `account.updated` - **Triggers when the Account is updated.**\n- `payout` - **Triggers when a Payout occurs.**\n- `fee` - **Triggers when an Entity is charged a Fee.**\n- `changerequest.declined` - **Triggers when change request declined.**\n- `changerequest.created` - **Triggers when change request created.**\n- `changerequest.approved` - **Triggers when change request approved.**\n- `changerequest.manualReview` - **Triggers when change request reviewed manually.**\n- `chargeback` - **Triggers alert when Chargeback Reports are created.**\n- `chargeback.opened` - **Triggers alert when Chargeback opened.**\n- `chargeback.closed` - **Triggers alert when Chargeback closed.**\n- `chargeback.created` - **Triggers alert when a Chargeback is created.**\n- `chargeback.lost` - **Triggers alert when a Chargeback dispute was lost.**\n- `chargeback.won` - **Triggers alert when a Chargeback dispute was won.**\n- `chargebackdocument.uploaded` - **Triggers alert when Chargeback document uploaded.**\n- `debit.disbursement.recovery` - **Triggers when the entity recovers from a negative balance and now has a positive balance again and the debtorEntity record is deleted.**\n- `disbursement.requested` - **Triggers alert when a Disbursement is requested.**\n- `disbursement.processing` - **Triggers alert when a Disbursement is processing.**\n- `disbursement.processed` - **Triggers alert when a Disbursement has been processed.**\n- `disbursement.failed` - **Triggers alert when a Disbursement has failed.**\n- `disbursement.denied` - **Triggers alert when a Disbursement has been denied.**\n- `disbursement.report` - **Triggers alert when Disbursements are processed.**\n- `disbursement.returned` - **Triggers alert when Disbursement has returned.**\n- `disbursementEntries.processed` - **Triggers alert when Disbursement Entries have been processed.**\n- `invoice.created` - **Triggers alert when an invoice has been created.**\n- `invoice.cancelled` - **Triggers alert when an invoice has been cancelled.**\n- `invoice.emailed` - **Triggers alert when an invoice has been emailed.**\n- `invoice.expired` - **Triggers alert when an invoice has expired.**\n- `invoice.paid` - **Triggers alert when an invoice has been paid.**\n- `invoice.refunded` - **Triggers alert when an invoice has been refunded.**\n- `invoice.viewed` - **Triggers alert when an invoice has been viewed.**\n- `invoiceResult.failure` - **Triggers alert when an invoice result has failed.**\n- `merchant.created` - **Triggers alert when a Merchant has been created.**\n- `merchant.boarding` - **Triggers alert when a Merchant is boarding.**\n- `merchant.boarded` - **Triggers alert when a Merchant has been boarded.**\n- `merchant.closed` - **Triggers alert when a Merchant is closed.**\n- `merchant.conditionally.approved` - **Triggers alert when a Merchant is conditionally approved.**\n- `merchant.fully.boarded` - **Triggers alert when a Merchant is fully boarded after being conditionally approved.**\n- `merchant.pending` - **Triggers alert when a Merchant is pending.**\n- `merchant.reserved` - **Triggers alert when a Merchant is reserved after being conditionally approved.**\n- `merchant.incomplete` - **Triggers alert when a Merchant is incomplete.**\n- `merchant.failed` - **Triggers alert when Merchant boarding has failed.**\n- `merchant.held` - **Triggers alert when a Merchant boarding requires manual review.**\n- `message.created` - **Triggers alert when a Message was created.**\n- `paymentupdate.report` - **Triggers when a report for a paymentUpdate is generated.**\n- `resource.created` - **Triggers alert when a Resource was created.**\n- `resource.updated` - **Triggers alert when a Resource was updated.**\n- `subscription.created` - **Triggers alert when a Subscription was created.**\n- `subscription.approved` - **Triggers alert when a Subscription was approved.**\n- `subscription.failed` - **Triggers alert when a Subscription has failed.**\n- `terminalTxn.created` - **Triggers alert when Terminal Transaction has been created.**\n- `terminalTxn.approved` - **Triggers alert when Terminal Transaction has been approved.**\n- `terminalTxn.failed` - **Triggers alert when Terminal Transaction has failed.**\n- `txn.created` - **Triggers alert when a Transaction is created.**\n- `txn.approved` - **Triggers alert when a Transaction has been approved.**\n- `txn.failed` - **Triggers alert when a Transaction has failed.**\n- `txn.captured` - **Triggers alert when a Transaction has been captured.**\n- `txn.settled` - **Triggers alert when a Transaction has been settled.**\n- `txn.returned` - **Triggers alert when a Transaction has been returned.**\n- `txn.echeck.funded` - **Triggers alert when a Transaction has been eCheck funded.**\n- `txn.delayed.funding` - **Triggers alert when a Transaction delayed funding.**\n- `upcoming.debit.disbursement` - **Triggers alert for upcoming debit disbursement.**\n\n "
}
]
},
"resource": {
"allOf": [
{
"$ref": "#/$defs/alertTriggerResource"
},
{
"description": "Valid Values
\n\n- `1` - **apiKeys**\n\n- `2` - **contacts**\n\n- `3` - **customers**\n\n- `4` - **alertTriggers**\n\n- `5` - **iplists**\n\n- `6` - **items**\n\n- `7` - **alerts**\n\n- `8` - **logins**\n\n- `9` - **merchants**\n\n- `10` - **orgs**\n\n- `12` - **permissions**\n\n- `13` - **decisions**\n\n- `14` - **parameters**\n\n- `15` - **sessions**\n\n- `16` - **alertActions**\n\n- `17` - **tokens**\n\n- `18` - **txns**\n\n- `19` - **teamLogins**\n\n- `20` - **credentials**\n\n- `21` - **members**\n\n- `22` - **accounts**\n\n- `23` - **plans**\n\n- `24` - **subscriptions**\n\n- `25` - **subscriptionTokens**\n\n- `26` - **disbursements**\n\n- `28` - **fees**\n\n- `29` - **funds**\n\n- `30` - **orgEntities**\n\n- `31` - **payouts**\n\n- `32` - **feeRules**\n\n- `33` - **entityRefs**\n\n- `34` - **chargebacks**\n\n- `35` - **decisionRules**\n\n- `36` - **entities**\n\n- `37` - **facilitators**\n\n- `38` - **partitions**\n\n- `39` - **merchantResults**\n\n- `40` - **mccs**\n\n- `41` - **mappings**\n\n- `42` - **refunds**\n\n- `43` - **batches**\n\n- `44` - **txnResults**\n\n- `45` - **confirmCodes**\n\n- `46` - **accountVerifications**\n\n- `47` - **disbursementResults**\n\n- `48` - **reserveEntries**\n\n- `49` - **chargebackMessages**\n\n- `50` - **hosts**\n\n- `53` - **txnRefs**\n\n- `54` - **verifications**\n\n- `55` - **verificationResults**\n\n- `56` - **chargebackMessageResults**\n\n- `59` - **adjustments**\n\n- `60` - **txnDatas**\n\n- `61` - **revenueBoosts**\n\n- `62` - **orgFlows**\n\n- `63` - **orgFlowActions**\n\n- `64` - **accountVerificationResults**\n\n- `65` - **disbursementRefs**\n\n- `66` - **reserves**\n\n- `67` - **entityReserves**\n\n- `68` - **txnReports**\n\n- `69` - **payoutFlows**\n\n- `70` - **vendors**\n\n- `71` - **fundOrigins**\n\n- `72` - **entityRoutes**\n\n- `74` - **terminals**\n\n- `75` - **terminalRefs**\n\n- `76` - **holds**\n\n- `77` - **holdNotes**\n\n- `78` - **files**\n\n- `79` - **messageThreads**\n\n- `80` - **messages**\n\n- `81` - **bins**\n\n- `82` - **feeModifiers**\n\n- `83` - **versions**\n\n- `84` - **chargebackDocuments**\n\n- `85` - **divisions**\n\n- `86` - **entityReturns**\n\n- `87` - **chargebackStatuses**\n\n- `88` - **profitShares**\n\n- `89` - **profitShareResults**\n\n- `90` - **aggregations**\n\n- `91` - **aggregationResultGroups**\n\n- `92` - **aggregationResults**\n\n- `93` - **auditLogs**\n\n- `94` - **invoiceParameters**\n\n- `95` - **invoices**\n\n- `96` - **secrets**\n\n- `97` - **watchlists**\n\n- `98` - **watchlistItems**\n\n- `99` - **txnMetadatas**\n\n- `100` - **invoiceResults**\n\n- `101` - **invoiceItems**\n\n- `102` - **invoiceLineItems**\n\n- `103` - **profitShareRules**\n\n- `104` - **configurations**\n\n- `105` - **currencyRates**\n\n- `106` - **terminalTxns**\n\n- `107` - **terminalTxnDatas**\n\n- `108` - **terminalTxnRefs**\n\n- `109` - **terminalTxnResults**\n\n- `110` - **configurationStages**\n\n- `111` - **disbursementEntries**\n\n- `112` - **decisionActions**\n\n- `113` - **notes**\n\n- `114` - **noteDocuments**\n\n- `115` - **paymentUpdates**\n\n- `117` - **paymentUpdateGroups**\n\n- `118` - **authTokens**\n\n- `119` - **reportResults**\n\n- `120` - **reports**\n\n- `121` - **reportItems**\n\n- `122` - **entityDebts**\n\n- `123` - **billings**\n\n- `124` - **billingModifiers**\n\n- `125` - **statements**\n\n- `127` - **billingEvents**\n\n- `128` - **fundingParameters**\n\n- `129` - **requestTokens**\n\n- `130` - **accountRefs**\n\n- `131` - **settlements**\n\n- `132` - **entityDatas**\n\n- `133` - **terminalTxnMetadatas**\n\n- `134` - **batchRefs**\n\n- `135` - **verificationRefs**\n\n- `136` - **externalFees**\n\n- `137` - **saferPayments**\n\n- `138` - **mfaRecoveryCodes**\n\n- `139` - **debtorEntities**\n\n- `140` - **omniTokens**\n\n- `141` - **changeRequests**\n\n- `142` - **txnSession**\n\n- `143` - **revShareSchedules**\n\n- `144` - **revShareStatements**\n\n- `145` - **loginsHelpers**\n\n- `146` - **entityCustomFields**\n\n- `147' - **DisbursementEntriesLog**\n\n- `148` - **merchantPlatformStatuses**\n\n- `149` - **DisbursementEntitiesLog**\n\n- `150` - **orgsVASSaferPayments**\n\n- `151` - **orgsVASOmniTokens**\n\n- `152` - **orgsVASRevenueBoosts**\n\n- `153` - **tokenResults**\n\n- `154` - **PlaidConsumerAccounts**\n\n- `155` - **appleDomains**\n\n- `156` - **PlaidConsumerPayments**\n\n- `157` - **saferPaymentsCompliance**\n\n- `158` - **orgFlowRules**\n\n- `159` - **TaxFormRequests**\n\n- `160` - **HostThemes**\n\n- `161` - **IntegrationResults**\n\n- `162` - **VasEfeOffers**\n\n- `163` - **VasEfeOfferUpdates**\n\n- `165` - **EmbeddedFinance**\n\n- `166` - **OrgsVASEfeProducts**\n\n- `167` - **EntityTerms**\n\n- `168` - **PinlessDebitConversions**\n\n- `169` - **OrgsVASPinlessDebitConversions**\n\n- `170` - **FraudSightEnablements**\n\n- `171` - **FraudSightResults**\n\n- `172` - **OrgsVASFraudSightEnablements**\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"alertTriggersPostRequestModelAlert": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/alertsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Alert resource that you want to invoke with this trigger."
},
"alertsPostRequest": {
"title": "alertsPostRequest",
"required": [
"login"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"forlogin": {
"type": "string",
"description": "The identifier of the Login that this Alert relates to. \nThe Alert is triggered based on the activity of this Login."
},
"team": {
"allOf": [
{
"$ref": "#/$defs/alertsPostRequestModelTeam"
},
{
"description": "The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team."
}
]
},
"division": {
"type": "string",
"description": "The division for which this Alerts applies."
},
"partition": {
"type": "string",
"description": "The partition for which this Alerts applies."
},
"name": {
"type": "string",
"description": "The name of this Alert. \nThis field is stored as a text string and must be between 1 and 100 characters long."
},
"description": {
"type": "string",
"description": "Description of Alerts."
},
"alertActions": {
"type": "array",
"items": {
"$ref": "#/$defs/alertActionsPostRequest"
},
"description": ""
},
"alertTriggers": {
"type": "array",
"items": {
"$ref": "#/$defs/alertTriggersPostRequest"
},
"description": ""
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"alertsPostRequestModelTeam": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/teamsPostRequest"
},
{}
]
}
],
"description": "The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team."
},
"batchStatus": {
"title": "batchStatus",
"enum": [
"open",
"closed"
],
"type": "string"
},
"batchesPostRequest": {
"title": "batchesPostRequest",
"required": [
"merchant",
"platform"
],
"type": "object",
"properties": {
"merchant": {
"type": "string",
"description": "The identifier of the Merchant that is associated with this Batch."
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/platformModel"
},
{
"description": "The platform used to process this resource.\n\n\nValid Values
\n\n- `APPLE` - **The Apple Payment Processor.**\n- `ELAVON` - **The Elavon processor.**\n- `FIRSTDATA` - **The FirstData processor.**\n- `GOOGLE` - **The Google Payment Processor.**\n- `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n- `VCORE` - **The WorldPay (aka Vantiv) Core processor.**\n- `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**\n- `WELLSACH` - **The Wells Fargo ACH processor.**\n- `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**\n- `WFSINGLE` - **The WFSINGLE processor.**\n- `WORLDPAY` - **The WORLDPAY processor.**\n\n "
}
]
},
"status": {
"allOf": [
{
"$ref": "#/$defs/batchStatus"
},
{
"description": "The current status of this Batch.\n\n\nValid Values
\n\n- `open` - **This Batch can accept more Transactions.**\n- `closed` - **This Batch is closed to new Transactions and is ready to be sent to the processor.**\n\n "
}
]
},
"ref": {
"type": "string",
"description": "The reference code of the batch. \nThis field is automatically generated and stored as a text string and must be between 0 and 50 characters long."
},
"clientRef": {
"type": "string",
"description": "The merchant's reference code of the batch. \nThis field is stored as a text string and must be between 0 and 50 characters long."
},
"processingId": {
"type": "string",
"description": "Internal ID set for processing."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"billingCollection": {
"title": "billingCollection",
"const": "entity",
"type": "string"
},
"billingEvent": {
"title": "billingEvent",
"enum": [
"fees",
"chargebacks",
"returns",
"profitShares",
"revShares"
],
"type": "string"
},
"billingEventsDeductFromBalance": {
"title": "billingEventsDeductFromBalance",
"enum": [
0,
1
],
"type": "integer"
},
"billingEventsPostRequest": {
"title": "billingEventsPostRequest",
"required": [
"billing",
"event"
],
"type": "object",
"properties": {
"billing": {
"type": "string",
"description": "The billing to which this billingEvent applies."
},
"event": {
"allOf": [
{
"$ref": "#/$defs/billingEvent"
},
{
"description": "The type of event that triggers billing.\n\n\nValid Values
\n\n- `fees` - **Fee.** Fee events trigger the billing configuration.\n- `chargebacks` - **Chargebacks.** Chargeback events trigger the billing configuration.\n- `returns` - **Returns.** Return events trigger the billing configuration.\n- `profitShares` - **Profit Shares.** Profit Sharing events trigger the billing configuration.\n- `revShares` - **RevShares.** Rev Sharing events trigger the billing configuration.\n\n "
}
]
},
"eventSchedule": {
"type": "string",
"description": "The record ID of a specific schedule for the event chosen for which the billing configuration applies, all other records of the same event are excluded."
},
"deductFromBalance": {
"allOf": [
{
"$ref": "#/$defs/billingEventsDeductFromBalance"
},
{
"description": "Whether to deduct the billing amount from the entity's account balance.\n\n\nValid Values
\n\n- `0` - **Do not deduct from balance.**\n- `1` - **Deduct from balance.**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"billingModifiersPostRequest": {
"title": "billingModifiersPostRequest",
"required": [
"billing",
"fromentity"
],
"type": "object",
"properties": {
"billing": {
"type": "string",
"description": "The identifier of the Billing that this Billing Modifier applies to."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this Billing Modifier applies to."
},
"org": {
"type": "string",
"description": "The identifier of the Org that this Billing Modifier applies to."
},
"division": {
"type": "string",
"description": "The identifier of the Division that this Billing Modifier applies to."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition that this Billing Modifier applies to."
},
"fromentity": {
"type": "string",
"description": "The identifier of the Entity that is responsible for paying this Bill on behalf of the Entity specified in the 'entity' field."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"billingSchedule": {
"title": "billingSchedule",
"enum": [
"days",
"weeks",
"months",
"years"
],
"type": "string"
},
"billingsCollectionFactor": {
"title": "billingsCollectionFactor",
"enum": [
"days",
"weeks",
"months",
"years"
],
"type": "string"
},
"billingsCollectionIncludeCurrent": {
"title": "billingsCollectionIncludeCurrent",
"enum": [
0,
1
],
"type": "integer"
},
"billingsPostRequest": {
"title": "billingsPostRequest",
"required": [
"login",
"entity",
"schedule",
"start",
"collectionFactor",
"currency"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"entity": {
"type": "string",
"description": "The alphanumeric identifier of the Entity associated with this Account."
},
"forentity": {
"type": "string",
"description": "The alphanumeric identifier of the Entity associated with this Account."
},
"org": {
"type": "string",
"description": "The identifier of the Org associated with this invoiceParameter."
},
"division": {
"type": "string",
"description": "ID of the division associated with this vendor"
},
"partition": {
"type": "string",
"description": "The identifier of the Partition associated with this invoiceParameter."
},
"description": {
"type": "string",
"description": "The billing details."
},
"schedule": {
"allOf": [
{
"$ref": "#/$defs/billingSchedule"
},
{
"description": "The schedule that determines when this Billing is triggered to start collecting data.\n\n\nValid Values
\n\n- `days` - **Daily schedule.**\n- `weeks` - **Weekly schedule.**\n- `months` - **Monthly schedule.**\n- `years` - **Annual schedule.**\n\n "
}
]
},
"scheduleFactor": {
"type": "integer",
"description": "A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. \nThis field is specified as an integer and its value determines how the interval is multiplied.",
"contentEncoding": "int32",
"default": 1
},
"start": {
"type": "integer",
"description": "The date on which this Billing period should start.",
"contentEncoding": "int32"
},
"finish": {
"type": "integer",
"description": "The date on which this Billing period should end.",
"contentEncoding": "int32"
},
"collection": {
"allOf": [
{
"$ref": "#/$defs/billingCollection"
},
{
"description": "Determines who will be billed.\n\n\nValid Values
\n\n- `entity` - **The entity will be billed.**\n\n "
}
]
},
"collectionFactor": {
"allOf": [
{
"$ref": "#/$defs/billingsCollectionFactor"
},
{
"description": "A multiplier that you can use to adjust the set of data to be used in the collection calculation.\n\n\nValid Values
\n\n- `days` - **Days.** Multiplier based on days.\n- `weeks` - **Weeks.** Multiplier based on weeks.\n- `months` - **Months.** Multiplier based on months.\n- `years` - **Years.** Multiplier based on years.\n\n "
}
]
},
"collectionOffset": {
"type": "integer",
"description": "The number of days, weeks, months or years to go back when selecting data for collection calculation.",
"contentEncoding": "int32",
"default": 1
},
"collectionIncludeCurrent": {
"allOf": [
{
"$ref": "#/$defs/billingsCollectionIncludeCurrent"
},
{
"description": "Whether to include the current period in the collection calculation.\n\n\nValid Values
\n\n- `0` - **Exclude Current Period.** Do not include the current period in the calculation.\n- `1` - **Include Current Period.** Include the current period in the calculation.\n\n "
}
]
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency of the amount in this billing. See Currency codes for all valid values."
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"billingEvents": {
"type": "array",
"items": {
"$ref": "#/$defs/billingEventsPostRequest"
},
"description": ""
},
"billingModifiers": {
"type": "array",
"items": {
"$ref": "#/$defs/billingModifiersPostRequest"
},
"description": ""
}
}
},
"changeManagementEnabled": {
"title": "changeManagementEnabled",
"enum": [
0,
1
],
"type": "integer"
},
"contactsPostRequest": {
"title": "contactsPostRequest",
"required": [
"entity",
"first",
"last",
"email"
],
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The identifier of the Entity that this Contact relates to."
},
"first": {
"type": "string",
"description": "The first name associated with this Contact."
},
"middle": {
"type": "string",
"description": "The middle name associated with this Contact."
},
"last": {
"type": "string",
"description": "The last name associated with this Contact."
},
"description": {
"type": "string",
"description": "A description of this Contact."
},
"email": {
"type": "string",
"description": "The email address of this Contact."
},
"address1": {
"type": "string",
"description": "The first line of the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"address2": {
"type": "string",
"description": "The second line of the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"city": {
"type": "string",
"description": "The name of the city in the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"state": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"zip": {
"type": "string",
"description": "The ZIP code in the address associated with this Contact. \nThis field is stored as a text string and must be between 1 and 20 characters long."
},
"country": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country associated with this Contact. \nValid values for this field is the 3-letter ISO code for the country."
}
]
},
"phone": {
"type": "string",
"description": "The phone number associated with this Contact. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"fax": {
"type": "string",
"description": "The fax number associated with this Contact. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
}
}
},
"country": {
"title": "country",
"enum": [
"ABW",
"AFG",
"AGO",
"AIA",
"ALA",
"ALB",
"AND",
"ARE",
"ARG",
"ARM",
"ASM",
"ATA",
"ATF",
"ATG",
"AUS",
"AUT",
"AZE",
"BDI",
"BEL",
"BEN",
"BES",
"BFA",
"BGD",
"BGR",
"BHR",
"BHS",
"BIH",
"BLM",
"BLR",
"BLZ",
"BMU",
"BOL",
"BRA",
"BRB",
"BRN",
"BTN",
"BVT",
"BWA",
"CAF",
"CAN",
"CCK",
"CHE",
"CHL",
"CHN",
"CIV",
"CMR",
"COD",
"COG",
"COK",
"COL",
"COM",
"CPV",
"CRI",
"CUB",
"CUW",
"CXR",
"CYM",
"CYP",
"CZE",
"DEU",
"DJI",
"DMA",
"DNK",
"DOM",
"DZA",
"ECU",
"EGY",
"ERI",
"ESH",
"ESP",
"EST",
"ETH",
"FIN",
"FJI",
"FLK",
"FRA",
"FRO",
"FSM",
"GAB",
"GBR",
"GEO",
"GGY",
"GHA",
"GIB",
"GIN",
"GLP",
"GMB",
"GNB",
"GNQ",
"GRC",
"GRD",
"GRL",
"GTM",
"GUF",
"GUM",
"GUY",
"HKG",
"HMD",
"HND",
"HRV",
"HTI",
"HUN",
"IDN",
"IMN",
"IND",
"IOT",
"IRL",
"IRN",
"IRQ",
"ISL",
"ISR",
"ITA",
"JAM",
"JEY",
"JOR",
"JPN",
"KAZ",
"KEN",
"KGZ",
"KHM",
"KIR",
"KNA",
"KOR",
"KWT",
"LAO",
"LBN",
"LBR",
"LBY",
"LCA",
"LIE",
"LKA",
"LSO",
"LTU",
"LUX",
"LVA",
"MAC",
"MAF",
"MAR",
"MCO",
"MDA",
"MDG",
"MDV",
"MEX",
"MHL",
"MKD",
"MLI",
"MLT",
"MMR",
"MNE",
"MNG",
"MNP",
"MOZ",
"MRT",
"MSR",
"MTQ",
"MUS",
"MWI",
"MYS",
"MYT",
"NAM",
"NCL",
"NER",
"NFK",
"NGA",
"NIC",
"NIU",
"NLD",
"NOR",
"NPL",
"NRU",
"NZL",
"OMN",
"PAK",
"PAN",
"PCN",
"PER",
"PHL",
"PLW",
"PNG",
"POL",
"PRI",
"PRK",
"PRT",
"PRY",
"PSE",
"PYF",
"QAT",
"REU",
"ROU",
"RUS",
"RWA",
"SAU",
"SDN",
"SEN",
"SGP",
"SGS",
"SHN",
"SJM",
"SLB",
"SLE",
"SLV",
"SMR",
"SOM",
"SPM",
"SRB",
"SSD",
"STP",
"SUR",
"SVK",
"SVN",
"SWE",
"SWZ",
"SXM",
"SYC",
"SYR",
"TCA",
"TCD",
"TGO",
"THA",
"TJK",
"TKL",
"TKM",
"TLS",
"TON",
"TTO",
"TUN",
"TUR",
"TUV",
"TWN",
"TZA",
"UGA",
"UKR",
"UMI",
"URY",
"USA",
"UZB",
"VAT",
"VCT",
"VEN",
"VGB",
"VIR",
"VNM",
"VUT",
"WLF",
"WSM",
"XXK",
"YEM",
"ZAF",
"ZMB",
"ZWE"
],
"type": "string"
},
"credentialIntegration": {
"title": "credentialIntegration",
"enum": [
"APPLE",
"ELAVON",
"FEDACH",
"FIRSTDATA",
"NEUTRINO",
"OFAC",
"PAYRIX",
"PLAID",
"SIFT",
"SOCURE",
"SOUNDPAYMENTS",
"TDBANK",
"VANTIV",
"VCORE",
"WEBSHIELD",
"WELLSACH",
"WELLSFARGO",
"WFSINGLE"
],
"type": "string"
},
"credentialType": {
"title": "credentialType",
"enum": [
"transaction",
"batch",
"boarding",
"paymentUpdates",
"payout",
"payoutCredit",
"payoutDebit",
"chargeback",
"txnReport",
"account",
"entityDecision",
"txnCheck",
"payoutReport",
"feeReport",
"chargebackReport",
"binReport",
"watchlist",
"encryption",
"changeRequest"
],
"type": "string"
},
"credentialsPostRequest": {
"title": "credentialsPostRequest",
"required": [
"entity",
"username",
"integration",
"type"
],
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The identifier of the Entity that this Credential resource belongs to."
},
"name": {
"type": "string",
"description": "The name of this Credential resource. \nThis field is stored as a text string and must be between 1 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Credential resource. \nThis field is stored as a text string and must be between 1 and 100 characters long."
},
"username": {
"type": "string",
"description": "The username to use when authenticating to the integration associated with this Credential resource. \nThis field is stored as a text string and must be between 1 and 50 characters long."
},
"password": {
"type": "string",
"description": "The password to use when authenticating to the integration associated with this Credential resource. \nThis field is stored as a text string and must be between 1 and 50 characters long."
},
"connectUsername": {
"type": "string",
"description": "The username to use when connecting to the integration associated with this Credential resource. \nThis field is stored as a text string and must be between 1 and 50 characters long. \nThis field is only necessary when it is required by the integration."
},
"connectPassword": {
"type": "string",
"description": "The password to use when connecting to the integration associated with this Credential resource. \nThis field is stored as a text string and must be between 1 and 50 characters long. \nThis field is only necessary when it is required by the integration."
},
"integration": {
"allOf": [
{
"$ref": "#/$defs/credentialIntegration"
},
{
"description": "The payment platform integration using credential logins. \n\n\nValid Values
\n\n- `APPLE` - **Apple API**\n\n- `ELAVON` - **Elavon API**\n\n- `FEDACH` - **FedACH Account Integration**\n\n- `FIRSTDATA` - **FirstData / Clover Integration**\n\n- `NEUTRINO` - **Neutrino eCommerce Integration**\n\n- `OFAC` - **Office of Foreign Assets Control Sanctions**\n\n- `PAYRIX` - **Payrix API**\n\n- `PLAID` - **Plaid Account Integration**\n\n- `SIFT` - **Sift Fraud Management**\n\n- `SOCURE` - **Socure ID Verification**\n\n- `SOUNDPAYMENTS` - **Sound Payments POS**\n\n- `TDBANK` - **TD Bank Platform**\n\n- `VANTIV` - **WorldPay / Vantiv eComm Platform**\n\n- `VCORE` - **WorldPay / Vantiv Core Platform**\n\n- `WEBSHIELD` - **Web Shield Merchant Monitoring**\n\n- `WELLSACH` - **Wells Fargo Merchant Services ACH Processor.**\n\n- `WELLSFARGO` - **Wells Fargo Merchant Services Payment Processor**\n\n- `WFSINGLE` - **Wells Fargo Single Payment Processors**\n\n "
}
]
},
"type": {
"allOf": [
{
"$ref": "#/$defs/credentialType"
},
{
"description": "The type of Transaction.\n\n\nValid Values
\n\n- `1` - **Credit Card Only:** Sale Transaction. Processes a sale and charges the customer.\n- `2` - **Credit Card Only:** Auth Transaction. Authorizes and holds the requested total on the credit card.\n- `3` - **Credit Card Only:** Capture Transaction. Finalizes a prior Auth Transaction and charges the customer.\n- `4` - **Credit Card Only:** Reverse Authorization. Reverses a prior Auth or Sale Transaction and releases the credit hold.\n- `5` - **Credit Card Only:** Refund Transaction. Refunds a prior Capture or Sale Transaction (total may be specified for a partial refund).\n- `7` - **Echeck Only:** Echeck Sale Transaction. Sale Transaction for ECheck payment.\n- `8` - **ECheck Only:** ECheck Refund Transaction. Refund Transaction for prior ECheck Sale Transaction.\n- `11` - **Echeck Only:** Echeck Redeposit Transaction. Attempt to redeposit a prior failed eCheck Sale Transaction.\n- `12` - **Echeck Only:** Echeck Account Verification Transaction. Attempt to verify eCheck payment details.\n\n "
}
]
},
"secret": {
"type": "string",
"description": "The secret resource identifier to use when connecting using this Credential. \nThis field is only necessary when a private key is required by the integration."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"currency": {
"title": "currency",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XUA",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"type": "string"
},
"customersPostRequest": {
"title": "customersPostRequest",
"required": [
"login"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The ID of the Login that owns this resource."
},
"merchant": {
"type": [
"string",
"null"
],
"description": "The ID of the Merchant associated with this Customer."
},
"entity": {
"type": [
"string",
"null"
],
"description": "The ID of the Entity that owns this resource."
},
"first": {
"type": "string",
"description": "The first name associated with this Customer."
},
"middle": {
"type": "string",
"description": "The middle name associated with this Customer."
},
"last": {
"type": "string",
"description": "The last name associated with this Customer."
},
"company": {
"type": "string",
"description": "The name of the company associated with this Customer."
},
"email": {
"type": "string",
"description": "The email address of this Customer."
},
"shippingFirst": {
"type": "string",
"description": "The first name associated with this Customer's shipping information."
},
"shippingMiddle": {
"type": "string",
"description": "The middle name associated with this Customer's shipping information."
},
"shippingLast": {
"type": "string",
"description": "The last name associated with this Customer's shipping information."
},
"shippingCompany": {
"type": "string",
"description": "The name of the company associated with this Customer's shipping information."
},
"shippingAddress1": {
"type": "string",
"description": "The first line of the address associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"shippingAddress2": {
"type": "string",
"description": "The second line of the address associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"shippingCity": {
"type": "string",
"description": "The name of the city associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"shippingState": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"shippingZip": {
"type": "string",
"description": "The ZIP code associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 1 and 20 characters long."
},
"shippingCountry": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country associated with this Customer's shipping information. \nValid values for this field is the 3-letter ISO code for the country."
}
]
},
"shippingPhone": {
"type": "string",
"description": "The phone number associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"shippingFax": {
"type": "string",
"description": "The fax number associated with this Customer's shipping information. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"custom": {
"type": "string",
"description": "Custom, free-form field for client-supplied text, must be between 0 and 1,000 characters long."
},
"address1": {
"type": "string",
"description": "The first line of the address associated with this Customer. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"address2": {
"type": "string",
"description": "The second line of the address associated with this Customer. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"city": {
"type": "string",
"description": "The name of the city in the address associated with this Customer. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"state": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"zip": {
"type": "string",
"description": "The ZIP code in the address associated with this Customer. \nThis field is stored as a text string and must be between 1 and 20 characters long."
},
"country": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country associated with this Customer. \nValid values for this field is the 3-letter ISO code for the country."
}
]
},
"phone": {
"type": "string",
"description": "The phone number associated with this Transaction. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"fax": {
"type": "string",
"description": "The fax number associated with this Customer. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"invoices": {
"type": "array",
"items": {
"$ref": "#/$defs/invoicesPostRequest"
},
"description": ""
},
"tokens": {
"type": "array",
"items": {
"$ref": "#/$defs/tokenPostRequest"
},
"description": ""
}
}
},
"divisionsPostRequest": {
"title": "divisionsPostRequest",
"required": [
"login",
"name"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"name": {
"type": "string",
"description": "The name of the division, which may be used for some white-label purposes."
},
"email": {
"type": "string",
"description": "The white-labeled outgoing email for all automated emails generated throughout this division."
},
"saferPaymentNonComplianceFeeManaged": {
"allOf": [
{
"$ref": "#/$defs/saferPaymentNonComplianceFeeManagedModel"
},
{
"description": "Whether SaferPayment Non-compliance fee management is enabled\n\nValid Values
\n\n- `0` - **Disabled.**\n- `1` - **Enabled.**\n\n "
}
]
},
"changeManagementEnabled": {
"allOf": [
{
"$ref": "#/$defs/changeManagementEnabled"
},
{
"description": "Whether change management is enabled.\n\n\nValid Values
\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n "
}
]
},
"minPasswordLength": {
"type": [
"integer",
"null"
],
"description": "Limit for password validations length.",
"contentEncoding": "int32"
},
"minPasswordComplexity": {
"allOf": [
{
"$ref": "#/$defs/minPasswordComplexity"
},
{
"description": "The minimum level of complexity that all passwords used in this Partition must have.\nThere are four complexity 'factors' that can be evaluated. These are the presence\nof the following character types in the password: lowercase characters, uppercase\ncharacters, integers, and special characters. For instance, the password '123a'\nwould get a complexity rating of '2', since it contains integers and lowercase characters.\n\n\nValid Values
\n\n- `1` - **Needs to include one type.**\n- `2` - **Needs to include two types.**\n- `3` - **Needs to include three types.**\n- `4` - **Needs to include four types.**\n\n "
}
]
},
"hosts": {
"type": "array",
"items": {
"$ref": "#/$defs/hostsPostRequest"
},
"description": ""
}
}
},
"embeddedFinancePostRequest": {
"title": "embeddedFinancePostRequest",
"type": "object",
"properties": {
"enablementDate": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The Date and time when an entity was enabled for embeddedFinance.\\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am."
},
"product": {
"allOf": [
{
"$ref": "#/$defs/embeddedFinanceProduct"
},
{
"description": "The Product type to which embeddedFinance belongs to."
}
]
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/embededFinancePlatform"
},
{
"description": "The Platform to which embeddedFinance should be applied."
}
]
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this embeddedFinance is associated to."
},
"org": {
"type": "string",
"description": "The identifier of the Org (group) that embeddedFinance is associated to."
},
"division": {
"type": "string",
"description": "The identifier of the Division that embeddedFinance is associated to."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition that embeddedFinance is associated to."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"productContract": {
"type": "string",
"description": "Contains configuration of the product."
},
"accumulatedLoanTotal": {
"type": "string",
"description": "The total approved loan amount for the partner’s merchants"
}
}
},
"embeddedFinanceProduct": {
"title": "embeddedFinanceProduct",
"const": "merchantWorkingCapital",
"type": "string"
},
"embededFinancePlatform": {
"title": "embededFinancePlatform",
"enum": [
"PARAFIN",
"ATELIO"
],
"type": "string"
},
"entitiesEinType": {
"title": "entitiesEinType",
"enum": [
"ssn",
"tin",
"other"
],
"type": "string"
},
"entitiesPostRequest": {
"title": "entitiesPostRequest",
"required": [
"clientIp",
"type",
"name",
"address1",
"city",
"state",
"zip",
"country",
"timezone",
"phone",
"email",
"ein",
"globalBusinessId"
],
"type": "object",
"properties": {
"clientIp": {
"type": [
"string",
"null"
],
"description": "The client IP address from which the Entity was created. Valid values are any IPv4 or IPv6 address."
},
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/entityType"
},
{
"description": "The type of Entity.\n\n\nValid Values
\n\n- `0` - **Sole Proprietorship**\n- `1` - **Corporation**\n- `2` - **Limited Liability Company**\n- `3` - **Partnership**\n- `4` - **Association**\n- `5` - **Non-Profit Organization**\n- `6` - **Government Organization**\n- `7` - **C Corporation**\n- `8` - **S Corporation**\n\n "
}
]
},
"name": {
"type": "string",
"description": "The name of this Entity. \nThis field is stored as a string and must be between 1 and 100 characters long."
},
"displayName": {
"type": "string",
"description": "The display name of this Entity. \nThis field is stored as a string and must be between 1 and 1,000 characters long."
},
"address1": {
"type": "string",
"description": "The first line of the address associated with this Entity. \nThis field is stored as a string and must be between 1 and 500 characters long."
},
"address2": {
"type": "string",
"description": "The second line of the address associated with this Entity. \nThis field is stored as a string and must be between 1 and 500 characters long."
},
"city": {
"type": "string",
"description": "The name of the city in the address associated with this Entity. \nThis field is stored as a string and must be between 1 and 500 characters long."
},
"state": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"zip": {
"type": "string",
"description": "The ZIP code in the address associated with this Entity. \nThis field is stored as a text string and must be between 1 and 20 characters long."
},
"country": {
"allOf": [
{
"$ref": "#/$defs/entityCountry"
},
{
"description": "The country in the address associated with the Entity, currently accepting values including `USA` and `CAN`."
}
]
},
"timezone": {
"allOf": [
{
"$ref": "#/$defs/entitiesTimezone"
},
{
"description": "The time zone for the address associated with the terminal's location. \n\n\nValid Values
\n\n - `est` - **Eastern Standard Time**\n\n - `pst` - **Pacific Standard Time**\n\n - `cst` - **Central Standard Time**\n\n - `mst` - **Mountain Daylight Time**\n\n - `akst` - **Alaska Standard Time**\n\n - `hst` - **Hawaii Standard Time**\n\n - `sst` - **Samoa Standard Time**\n\n - `chst` - **Chamorro Standard Time**\n\n - `ast` - **Atlantic Standard Time**\n\n - `pwt` - **Palau Time**\n\n - `mht` - **Marshall Islands Time**\n\n - `chut` - **Chuuk Time**\n\n - `nst` - **Newfoundland Standard Time**\n\n "
}
]
},
"phone": {
"type": "string",
"description": "The phone number associated with this Entity. \nThis field is stored as a text string and must be between 5 and 15 characters long."
},
"customerPhone": {
"type": "string",
"description": "The customer service phone number associated with this Entity. For Merchants, this number will be displayed on the customer's credit card statement. \nThis field is stored as a text string and must be between 5 and 15 characters long."
},
"fax": {
"type": "string",
"description": "The fax number associated with this Entity. \nThis field is stored as a text string and must be between 5 and 15 characters long."
},
"email": {
"type": "string",
"description": "The email address associated with this Entity. \nThis field is stored as a text string and must be between 1 and 100 characters long."
},
"website": {
"type": "string",
"description": "The web site URL associated with this Entity. \nThis field is stored as a text string and must be between 0 and 500 characters long."
},
"appleDomain": {
"type": "string",
"description": "The web sites URL associated with this Entity. \nThis field is stored as a text string; must be between 0 and 1,000 characters long and separated by comma."
},
"einType": {
"allOf": [
{
"$ref": "#/$defs/entitiesEinType"
},
{
"description": "Indicates if the TIN being used is an EIN, SSN, or other/unknown number.\n\n\nValid Values
\n\n- `ssn` - **Social Security Number.**\n- `tin` - **Employer Identification Number.**\n- `other` - **Other/Unknown TIN.**\n\n "
}
]
},
"irsFilingName": {
"type": "string",
"description": "The IRS Legal Filing Name. This must match what has been provided to the IRS when filing taxes."
},
"ein": {
"type": [
"string",
"null"
],
"description": "The IRS Employer Identification Number (EIN) for the Entity. \nThis field is stored as an integer and must be 9 characters long."
},
"locations": {
"type": "integer",
"description": "The number of locations at which this Entity does business. \nThis field is stored as an integer and must be between 1 and 1,000,000 characters long.",
"contentEncoding": "int32",
"default": 1
},
"public": {
"allOf": [
{
"$ref": "#/$defs/entitiesPublic"
},
{
"description": "Indicates whether this is a publicly held entity.\n\n\nValid Values
\n\n- `0` - **Private entity**\n- `1` - **Public entity**\n\n "
}
]
},
"tcVersion": {
"type": [
"string",
"null"
],
"description": "An indicator showing the version of the terms and conditions that this Entity has accepted. The API indicates the version as a string. \nThis field is stored as a text string and must be between 0 and 20 characters long."
},
"tcAcceptDate": {
"type": [
"string",
"null"
],
"description": "Date and time on which this Entity accepted the Terms and Conditions, if different than `tcDate`. \nThe date is specified as a 12-digit string in YYYYMMDDHHII format, for example, `201601201528` for January 20, 2016, at 15:28 (3:28 PM)."
},
"tcAcceptIp": {
"type": [
"string",
"null"
],
"description": "IP address from which this Entity accepted the Terms and Conditions, if different than `tcIp`."
},
"custom": {
"type": "string",
"description": "Custom, free-form field for client-supplied text; must be between 0 and 1,000 characters long."
},
"payoutSecondaryDescriptor": {
"type": "string",
"description": "The secondary billing descriptor to appear on the bank statements for funds transfer for the entity."
},
"industry": {
"type": "string",
"description": "This field is stored as a text string and must be between 0 and 1,000 characters long."
},
"globalBusinessType": {
"allOf": [
{
"$ref": "#/$defs/globalBusinessType"
},
{
"description": "The business registration type for the entity\n\n\nValid Values for country USA
\n\n- `ssn` - **Social Security Number.**\n- `tin` - **Employer Identification Number.**\n- `other` - **Other/Unknown TIN.**\n \n\nValid Values for country Canada
\n\n- `CD` - **Federal**\n- `AB` - **Alberta**\n- `BC` - **British Columbia**\n- `MB` - **Manitoba**\n- `NB` - **New Brunswick**\n- `NL` - **Newfoundland and Labrador**\n- `NT` - **Northwest Territories**\n- `NS` - **Nova Scotia**\n- `NU` - **Nunavut**\n- `ON` - **Ontario**\n- `PE` - **Prince Edward Island**\n- `QC` - **Quebec**\n- `SK` - **Saskatchewan**\n- `YT` - **Yukon**\n\n "
}
]
},
"globalBusinessId": {
"type": [
"string",
"null"
],
"description": "The business registration number for the entity. \nThis field is stored as an alphanumeric and must be between 9 to 10 characters long"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/$defs/accountsPostRequest"
},
"description": ""
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"billings": {
"type": "array",
"items": {
"$ref": "#/$defs/billingsPostRequest"
},
"description": ""
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/$defs/contactsPostRequest"
},
"description": ""
},
"credentials": {
"type": "array",
"items": {
"$ref": "#/$defs/credentialsPostRequest"
},
"description": ""
},
"embeddedFinance": {
"type": "array",
"items": {
"$ref": "#/$defs/embeddedFinancePostRequest"
},
"description": ""
},
"entityCustomFields": {
"type": "array",
"items": {
"$ref": "#/$defs/entityCustomFieldsPostRequest"
},
"description": ""
},
"entityData": {
"type": "array",
"items": {
"$ref": "#/$defs/entityDataPostRequest"
},
"description": ""
},
"entityRefs": {
"type": "array",
"items": {
"$ref": "#/$defs/entityRefsPostRequest"
},
"description": ""
},
"entityRoutes": {
"type": "array",
"items": {
"$ref": "#/$defs/entityRoutesPostRequest"
},
"description": ""
},
"entityTerms": {
"type": "array",
"items": {
"$ref": "#/$defs/entityTermsPostRequest"
},
"description": ""
},
"orgEntities": {
"type": "array",
"items": {
"$ref": "#/$defs/orgEntitiesPostRequest"
},
"description": ""
},
"omniTokens": {
"type": "array",
"items": {
"$ref": "#/$defs/omniTokensPostRequest"
},
"description": ""
},
"forentityProfitShares": {
"type": "array",
"items": {
"$ref": "#/$defs/profitSharesPostRequest"
},
"description": ""
},
"holds": {
"type": "array",
"items": {
"$ref": "#/$defs/holdsPostRequest"
},
"description": ""
},
"merchant": {
"allOf": [
{
"$ref": "#/$defs/merchantsPostRequest"
},
{}
]
},
"notes": {
"type": "array",
"items": {
"$ref": "#/$defs/notesPostRequest"
},
"description": ""
},
"payouts": {
"type": "array",
"items": {
"$ref": "#/$defs/payoutPostRequest"
},
"description": ""
},
"pinlessDebitConversions": {
"type": "array",
"items": {
"$ref": "#/$defs/pinlessDebitConversionsPostRequest"
},
"description": ""
},
"profitShares": {
"type": "array",
"items": {
"$ref": "#/$defs/profitSharesPostRequest"
},
"description": ""
},
"reserves": {
"type": "array",
"items": {
"$ref": "#/$defs/reservesPostRequest"
},
"description": ""
},
"revenueBoosts": {
"type": "array",
"items": {
"$ref": "#/$defs/revenueBoostsPostRequest"
},
"description": ""
},
"vendor": {
"allOf": [
{
"$ref": "#/$defs/vendorsPostRequest"
},
{}
]
},
"fees": {
"type": "array",
"items": {
"$ref": "#/$defs/feesPostRequest"
},
"description": ""
},
"forentityFees": {
"type": "array",
"items": {
"$ref": "#/$defs/feesPostRequest"
},
"description": ""
},
"saferPayments": {
"type": "array",
"items": {
"$ref": "#/$defs/saferPaymentsPostRequest"
},
"description": ""
}
}
},
"entitiesPublic": {
"title": "entitiesPublic",
"enum": [
0,
1
],
"type": "integer"
},
"entitiesTimezone": {
"title": "entitiesTimezone",
"enum": [
"est",
"cst",
"pst",
"mst",
"akst",
"hst",
"sst",
"chst",
"ast",
"pwt",
"mht",
"chut",
"nst"
],
"type": "string"
},
"entityCountry": {
"title": "entityCountry",
"enum": [
"USA",
"CAN"
],
"type": "string"
},
"entityCustomFieldsPostRequest": {
"title": "entityCustomFieldsPostRequest",
"type": "object",
"properties": {
"entity": {
"allOf": [
{
"$ref": "#/$defs/entityCustomFieldsPostRequestModelEntity"
},
{
"description": "Entity for which we are creating custom field."
}
]
},
"key": {
"type": "string",
"description": "Name of custom field."
},
"value": {
"type": "string",
"description": "Value of custom field."
}
}
},
"entityCustomFieldsPostRequestModelEntity": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/entitiesPostRequest"
},
{}
]
}
],
"description": "Entity for which we are creating custom field."
},
"entityDataPostRequest": {
"title": "entityDataPostRequest",
"required": [
"entity",
"tcAcceptSignature"
],
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The Entity associated with this EntityData."
},
"tcAcceptSignature": {
"type": "string",
"description": "The Base64 encoded image of the signature captured at the time of creating the Entity."
}
}
},
"entityDefault": {
"title": "entityDefault",
"enum": [
0,
1
],
"type": "integer"
},
"entityPlatform": {
"title": "entityPlatform",
"enum": [
"APPLE",
"ELAVON",
"FIRSTDATA",
"GOOGLE",
"VANTIV",
"VCORE",
"WELLSACH",
"WELLSFARGO",
"WFSINGLE",
"WORLDPAY",
"TDBANKCA"
],
"type": "string"
},
"entityRefStage": {
"title": "entityRefStage",
"enum": [
"amexCharge",
"batch",
"batchSuffix",
"boarding",
"chain",
"chargeback",
"companyDebit",
"companyCredit",
"create",
"disbursement",
"entity",
"batchFile",
"payoutFile",
"frontend",
"funding",
"member",
"merchant",
"mid",
"origId",
"store",
"software",
"terminal",
"displayName",
"domain",
"expressCreds"
],
"type": "string"
},
"entityRefStaging": {
"title": "entityRefStaging",
"enum": [
0,
1
],
"type": "integer"
},
"entityRefsPostRequest": {
"title": "entityRefsPostRequest",
"required": [
"entity",
"member",
"ref",
"stage",
"platform"
],
"type": "object",
"properties": {
"entity": {
"type": [
"string",
"null"
],
"description": "The identifier of the Entity that owns this entityRefs resource."
},
"member": {
"type": [
"string",
"null"
],
"description": "The identifier of the Member associated with this entityRefs resource. Default value is 'null'"
},
"entityRoute": {
"type": [
"string",
"null"
],
"description": "The original 'entity_route' that routed the merchant onto the platform which then returned this reference information, if applicable."
},
"ref": {
"type": "string",
"description": "The reference code itself. \nThis field is stored as a text string and must be between 0 and 50 characters long."
},
"stage": {
"allOf": [
{
"$ref": "#/$defs/entityRefStage"
},
{
"description": "An indicator showing what this terminalRef refers to.\n\n\nValid Values
\n\n- `amexCharge` - **Amex Charge.**\n- `batch` - **Batch.**\n- `batchSuffix` - **Batch Suffix.**\n- `boarding` - **Boarding.**\n- `chain` - **The store chain ID for this Merchant.**\n- `chargeback` - **Chargeback.**\n- `companyDebit` - **Company Debit.**\n- `companyCredit` - **Company Credit.**\n- `create` - **Terminal Creation.**\n- `disbursement` - **Disbursement.**\n- `entity` - **The Entity ID.**\n- `batchFile` - **Batch File.**\n- `payoutFile` - **Payout File.**\n- `frontend` - **Frontend.**\n- `funding` - **The Payout funding ID for this Merchant.**\n- `member` - **The member ID for this Member.**\n- `merchant` - **The Merchant ID.**\n- `mid` - **The transaction Merchant ID (MID).**\n- `origId` - **Original ID.**\n- `store` - **The store ID for this Merchant.**\n- `software` - **Software.**\n- `terminal` - **Terminal.**\n- `displayName` - **Display Name.**\n- `domain` - **Domain.**\n- `expressCreds` - **Express Credentials.**\n\n "
}
]
},
"staging": {
"allOf": [
{
"$ref": "#/$defs/entityRefStaging"
},
{
"description": "Allows a merchant to transact under the Staging environment while boarding is in progress, and allows for configuration with valid values such as **Disabled** or **Enabled**.\n\n\nValid Values
\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n "
}
]
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/entityPlatform"
},
{
"description": "The processor that issued this terminalTxnRef.\n\n\nValid Values
\n\n- `APPLE` - **APPLE**\n- `ELAVON` - **ELAVON**\n- `FIRSTDATA` - **FIRSTDATA**\n- `GOOGLE` - **GOOGLE**\n- `VANTIV` - **VANTIV**\n- `VCORE` - **VCORE**\n- `WELLSACH` - **WELLSACH**\n- `WELLSFARGO` - **WELLSFARGO**\n- `WFSINGLE` - **WFSINGLE**\n- `WORLDPAY` - **WORLDPAY**\n- `TDBANKCA` - **TDBANKCA**\n\n "
}
]
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency of the entityRef. See Currency codes for all valid values."
}
]
},
"fundingCurrency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency for which this entityRefs resource was funded on. See Currency codes for all valid values."
}
]
},
"default": {
"allOf": [
{
"$ref": "#/$defs/entityDefault"
},
{
"description": "Whether this entityRef is the default one. Default entityRefs will have priority when processing transactions with no MID or Platform set. Valid Values
- `0` - **Not default.** - `1` - **Default.** "
}
]
},
"fbo": {
"type": [
"string",
"null"
],
"description": "The FBO from which this entity refers to."
},
"options": {
"type": [
"string",
"null"
],
"description": "A string-JSON of options for this reference value."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"entityRoutesFundingCurrency": {
"title": "entityRoutesFundingCurrency",
"enum": [
"USD",
"CAD"
],
"type": "string"
},
"entityRoutesPostRequest": {
"title": "entityRoutesPostRequest",
"required": [
"platform",
"default"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this EntityRoute."
},
"division": {
"type": "string",
"description": "Division ID in which the entity route is associated."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this entityRoute applies to."
},
"org": {
"type": "string",
"description": "The identifier of the Org that this entityRoute applies to."
},
"partition": {
"type": "string",
"description": "ID of the partition in which this entity operates."
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/entityPlatform"
},
{
"description": "The processor that issued this terminalTxnRef.\n\n\nValid Values
\n\n- `APPLE` - **APPLE**\n- `ELAVON` - **ELAVON**\n- `FIRSTDATA` - **FIRSTDATA**\n- `GOOGLE` - **GOOGLE**\n- `VANTIV` - **VANTIV**\n- `VCORE` - **VCORE**\n- `WELLSACH` - **WELLSACH**\n- `WELLSFARGO` - **WELLSFARGO**\n- `WFSINGLE` - **WFSINGLE**\n- `WORLDPAY` - **WORLDPAY**\n- `TDBANKCA` - **TDBANKCA**\n\n "
}
]
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency in which an entity should board with. This is an optional field that is only required for some platforms. See Currency codes for all valid values."
}
]
},
"fundingCurrency": {
"allOf": [
{
"$ref": "#/$defs/entityRoutesFundingCurrency"
},
{
"description": "The currency for which this entity will be funded on.\n\n\nValid Values
\n\n- `USD` - **US Dollar.**\n- `CAD` - **Canadian Dollar.**\n\n "
}
]
},
"options": {
"type": "string",
"description": "Whether to disable ACH.\nThis is a JSON field.\nAccepted values are {\"eCheckDisabled\": true}."
},
"default": {
"allOf": [
{
"$ref": "#/$defs/entityDefault"
},
{
"description": "Whether this entityRef is the default one. Default entityRefs will have priority when processing transactions with no MID or Platform set. Valid Values
- `0` - **Not default.** - `1` - **Default.** "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"entityTermsPostRequest": {
"title": "entityTermsPostRequest",
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The identifier of the entity that the terms are associated with."
},
"type": {
"type": "string",
"description": "The type of entity that has accepted the terms."
},
"version": {
"type": "string",
"description": "The version of the terms that the entity has accepted."
},
"versionId": {
"type": "string",
"description": "The identifier of the version of the terms that the entity has accepted."
},
"ip": {
"type": "string",
"description": "The IP address of the entity that accepted the terms."
},
"dateAccepted": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The date and time when the entity accepted the terms.\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"entityType": {
"title": "entityType",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer"
},
"entryMode": {
"title": "entryMode",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14
],
"type": "integer"
},
"feeApplication": {
"title": "feeApplication",
"enum": [
"both",
"fee",
"collection"
],
"type": "string"
},
"feeCollection": {
"title": "feeCollection",
"enum": [
1,
2,
3
],
"type": "integer"
},
"feeModifiersMarkupUm": {
"title": "feeModifiersMarkupUm",
"enum": [
1,
2
],
"type": "integer"
},
"feeModifiersPostRequest": {
"title": "feeModifiersPostRequest",
"required": [
"fee"
],
"type": "object",
"properties": {
"fee": {
"type": "string",
"description": "The identifier of the Fee that this Fee Modifier applies."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this Fee Modifier applies for."
},
"org": {
"type": "string",
"description": "The identifier of the Org this Fee Modifiers should apply for on behalf of the Entity identified in the value of the 'entity' field. \nThis field is optional. If it is set, then the Fee Modifier is applied to this Org instead."
},
"fromentity": {
"type": "string",
"description": "The identifier of the Entity who should pay this Fee on behalf of the Entity identified in the value of the 'entity' or 'org' field. \nThis field is optional. If it is set, then the Fee is charged to this Entity instead."
},
"markupUm": {
"allOf": [
{
"$ref": "#/$defs/feeModifiersMarkupUm"
},
{
"description": "The unit of measure for the markup amount for the Fee.\n\n\nValid Values
\n\n- `1` - **Fixed Amount.** Specified in the 'markupAmount' field as an integer in cents.\n- `2` - **Percentage.** Specified in the 'markupAmount' field in basis points.\n\n "
}
]
},
"markupAmount": {
"type": [
"integer",
"null"
],
"description": "The total amount of the markup value for this Fee. \nThe units used in this field are determined by the value of the 'markupUm' field on the Fee. If the 'markupUm' field is set to 'percentage', then this field specifies the Fee percentage to levy in basis points. If the 'markupUm' field is set to 'actual', then this field specifies the markup amount in cents.",
"contentEncoding": "int32"
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"feeRuleType": {
"title": "feeRuleType",
"enum": [
"3dsResult",
"activeInactive",
"avsResult",
"bin",
"business",
"corporate",
"cvvResult",
"dynamicallyRouted",
"emv",
"entity",
"equal",
"fraudSightEnabled",
"fundingCurrencyEqual",
"fundingCurrencyMismatch",
"fundingCurrencyNotEqual",
"fundingEnabled",
"greater",
"icRetainPassthruRefund",
"imported",
"interchange",
"international",
"issuerCountry",
"less",
"mcc",
"merchantCountry",
"method",
"methodType",
"misuse",
"notEqual",
"omnitokensEnabled",
"origin",
"platform",
"related",
"relatedCeil",
"relatedDelay",
"relatedFloor",
"sameDay",
"settledCurrencyMismatch",
"signed",
"softPos",
"status",
"subscription",
"swiped",
"taxForm1099k",
"type"
],
"type": "string"
},
"feeRulesPostRequest": {
"title": "feeRulesPostRequest",
"required": [
"fee",
"type",
"value"
],
"type": "object",
"properties": {
"fee": {
"type": "string",
"description": "The identifier of the Fee that this Fee Rule applies."
},
"name": {
"type": "string",
"description": "The name of this Fee Rule. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "The description of this Fee Rule."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/feeRuleType"
},
{
"description": "The type of Fee Rule.\n\n\nValid Values
\n\n- `3dsResult`\n- `activeInactive`\n- `avsResult`\n- `bin`\n- `business`\n- `corporate`\n- `cvvResult`\n- `dynamicallyRouted`\n- `emv`\n- `entity`\n- `equal`\n- `fraudSightEnabled`\n- `fundingCurrencyEqual`\n- `fundingCurrencyMismatch`\n- `fundingCurrencyNotEqual`\n- `fundingEnabled`\n- `greater`\n- `icRetainPassthruRefund`\n- `imported`\n- `interchange`\n- `international`\n- `issuerCountry`\n- `less`\n- `mcc`\n- `merchantCountry`\n- `method`\n- `methodType`\n- `misuse`\n- `notEqual`\n- `omnitokensEnabled`\n- `origin`\n- `platform`\n- `related`\n- `relatedCeil`\n- `relatedDelay`\n- `relatedFloor`\n- `sameDay`\n- `settledCurrencyMismatch`\n- `signed`\n- `softPos`\n- `status`\n- `subscription`\n- `swiped`\n- `taxForm1099k`\n- `type`\n\n "
}
]
},
"application": {
"allOf": [
{
"$ref": "#/$defs/feeApplication"
},
{
"description": "Where the feeRule should apply.\n\n\nValid Values
\n\n- `both` - **Both.** The rule should apply to the fee and to the calculation of collections.\n- `fee` - **Fee.** The rule should apply only to the fee itself.\n- `collection` - **Collection.** The fee should be only used when calculating a collection.\n\n "
}
]
},
"value": {
"type": "string",
"description": "The value to compare against when evaluating this Fee Rule."
},
"grouping": {
"type": "string",
"description": "A name for a group of rules to be applied in conjunction when evaluating this Fee Rule.\nWhen grouping is used, the Fee will be allowed to be processed if at least one of the rules are matched."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"feeSchedule": {
"title": "feeSchedule",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
43,
44,
45,
46,
47,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
88,
89,
90,
91,
92,
93,
96,
200,
201,
202,
203,
204,
205,
206,
207,
208,
209,
210,
211,
212,
213,
214,
215,
216,
217,
218,
230,
231,
232,
233,
234,
235,
236,
237,
238,
239,
240,
241,
242,
243,
244,
245,
246,
247,
248,
249,
250,
251,
252,
253,
254,
255,
256,
257,
258,
259,
260,
261,
262,
263,
264,
265,
266,
267,
268,
269,
270,
271,
272,
273,
274,
275,
276,
277,
278,
279,
280,
281,
282,
283,
284,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
601,
602,
603,
604,
605,
606,
607,
608,
701,
702,
703,
704,
705,
801,
802,
803,
804,
805,
806,
807
],
"type": "integer"
},
"feeType": {
"title": "feeType",
"enum": [
1,
2
],
"type": "integer"
},
"feeUm": {
"title": "feeUm",
"enum": [
1,
2,
3
],
"type": "integer"
},
"feesCollectionFactor": {
"title": "feesCollectionFactor",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"feesPostRequest": {
"title": "feesPostRequest",
"required": [
"entity",
"type",
"schedule",
"start",
"collectionOffset",
"um",
"amount",
"currency"
],
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The identifier of the Entity that will charge this Fee."
},
"forentity": {
"type": "string",
"description": "The identifier of the Entity that this Fee applies for."
},
"org": {
"allOf": [
{
"$ref": "#/$defs/feesPostRequestModelOrg"
},
{
"description": "The identifier of the Org who should pay this Fee on behalf of the Entity identified in the value of the 'forentity' field. \nThis field is optional. If it is set, then the Fee is charged to this Org instead."
}
]
},
"type": {
"allOf": [
{
"$ref": "#/$defs/feeType"
},
{
"description": "The type of the fee.\n\n\nValid Values
\n\n- `1` - **Fee.** A Standard Fee.\n- `2` - **Assessment.** A Third-Party Platform Fee.\n\n "
}
]
},
"name": {
"type": "string",
"description": "The name of this Fee. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Fee. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"schedule": {
"allOf": [
{
"$ref": "#/$defs/feeSchedule"
},
{
"description": "The schedule that determines when this Fee is triggered to be charged. \n\n\nValid Values
\n\n `1` - **Days.** The Fee is charged every day.\n\n `2` - **Weeks.** The Fee is charged every week.\n\n `3` - **Months.** The Fee is charged every month.\n\n `4` - **Years.** The Fee is charged every year.\n\n `5` - **Single.** The Fee is a one-off charge.\n\n `6` - **Auth.** The Fee is triggered at the time of authorization of a transaction.\n\n `7` - **Capture.** The Fee triggers at the capture time of a Transaction.\n\n `8` - **Refund.** The Fee triggers when a refund transaction is processed.\n\n `9` - **Board.** The Fee triggers when the Merchant is boarded.\n\n `10` - **Payout.** The Fee triggers when a payout is processed.\n\n `11` - **Chargeback.** The Fee triggers when a card chargeback occurs.\n\n `12` - **Overdraft.** The Fee triggers when an overdraft usage charge from a bank is levied.\n\n `13` - **Interchange.** The Fee triggers when interchange default are assessed for the Transactions of this Merchant.\n\n `14` - **Processor.** The Fee triggers when the Transactions of this Merchant are processed by a payment processor.\n\n `15` - **ACH failure.** The Fee triggers when an automated clearing house failure occurs.\n\n `16` - **Account.** The Fee triggers when a bank account is verified.\n\n `17` - **Sift.** The Fee triggers when a txn uses SIFT for fraud checking.\n\n `18` - **Adjustment.** The Fee triggers when an adjustment is created.\n\n `19` - **Retrieval.** The Fee triggers when a chargeback retrieval is processed.\n\n `20` - **Arbitration.** The Fee triggers when a chargeback arbitration is processed.\n\n `21` - **eCheck Sale.** The Fee triggers when an eCheck sale is processed.\n\n `22` - **eCheck Refund.** The Fee triggers when an eCheck refund is processed.\n\n `23` - **eCheck Return.** The Fee triggers when an eCheck txn is returned because of a failure while processing.\n\n `24` - **Settlement.** The Fee triggers when a txn is settled.\n\n `25` - **Misuse.** The Fee triggers when a txn authorization is misused.\n\n `26` - **Profit share.** The Fee triggers when a profit share is executed.\n\n `27` - **Unauth.** The Fee triggers when an auth reversal is created.\n\n `28` - **Disbursement NOC.** The Fee triggers on Notice Of Change events for Disbursements.\n\n `29` - **Transaction NOC.** The Fee triggers on Notice Of Change events for Transactions.\n\n `30` - **eCheck failure return.** The Fee triggers when an eCheck txn is returned due to customer rejection or incorrect account information.\n\n `31` - **eCheck NSF return.** The Fee triggers when an eCheck txn is returned due to insufficient funds.\n\n `32` - **Currency conversion.** The Fee triggers when there is a currency conversion on a transaction.\n\n `33` - **Terminal transaction.** The Fee triggers when there is a transaction processed via a terminal.\n\n `34` - **Reverse payout.** The Fee triggers when a payout is reversed.\n\n `35` - **Partial reverse payout.** The Fee triggers when a payout is partially reversed.\n\n `43` - **Payment check.** The Fee triggers on a payment check.\n\n `44` - **Payment update.** The Fee triggers when a payment is updated.\n\n `45` - **Payment group check.** The Fee triggers on a payment group check.\n\n `46` - **Payment group update.** The Fee triggers on a payment group update.\n\n `47` - **Entry refund.** The Fee triggers when an entry is refunded.\n\n `51` - **Statement Payment.** A statement bill was paid.\n\n `52` - **Merchant Created.** A new Merchant entity has been created, but not boarded.\n\n `53` - **Realtime Business Search.** Real-time Business Entity OFAC Search from Bridger by LexisNexis.\n\n `54` - **Realtime Member Search.** Real-time Business Entity Managing Member Personal OFAC Search from Bridger by LexisNexis.\n\n `55` - **MasterCard MATCH.** Merchant History Check from Mastercard Alert To Control High-risk Merchants (MATCH) program.\n\n `56` - **Business Instant ID.** KYB Verification from LexisNexis.\n\n `57` - **Consumer Instance ID.** KYC Verification from LexisNexis.\n\n `58` - **ThreatMetrix.** Not for partner/referrer use.\n\n `59` - **LegitScript Registration.** Merchant Compliance and Risk Rating Checks.\n\n `60` - **Equifax Consumer Report.** Business owner's consumer credit report from Equifax.\n\n `61` - **CharityCheck.** Business entity nonprofit eligibility verification from GuideStar.\n\n `62` - **Internal Decision V2.** Payrix Risk services decision.\n\n `63` - **TIN Check.** Tax Identification Number matching service for tax identity management from Sovos.\n\n `64` - **Equifax Commercial Report.** Entity's commercial credit report from Equifax.\n\n `65` - **LegitScript Merchant Check.** Merchant Compliance and Risk Rating Checks.\n\n `66` - **Plaid.** Bank account link, info update and verification services.\n\n `67` - **Statement Reversal.** A statement eCheck payment was reversed.\n\n `68` - **GIACT eCheck Verification.** Real-time account status check for consumer and business bank accounts from gVerify by GIACT.\n\n `69` - **GIACT Account Verification.** Real-time Business Entity Owner identity & authorized signer status verification from gAuthenticate by GIACT.\n\n `70` - **Boarding Decision.** Merchant boarding decision made by the platform via risk checks.\n\n `71` - **Transaction Risk Decision.** Transaction decision made by the platform via risk checks.\n\n `72` - **FANF.** Fixed Acquirer Network Fee from Visa for Merchants processing card-present and card-not-present transactions.\n\n `73` - **MCLocation.** Merchant Location Fee from Mastercard for Merchants processing card-present and card-not-present transactions.\n\n `74` - **VisaIntegrity.** Transaction Integrity Fee from Visa.\n\n `75` - **SaferPayments: Basic.** PCI DSS Compliance Portal from WorldPay for Partner and Facilitator Merchant portfolios.\n\n `76` - **SaferPayments: Managed.** PCI DSS Compliance Managed Services from WorldPay for Merchants in Partner and Facilitator portfolios.\n\n `77` - **SaferPayments - PCI Non-Validation.** PCI DSS Compliance Portal and/or services were provided but the Merchant failed to meet PCI DSS Compliance.\n\n `78` - **OMNITOKENS_VOLUME.** Omni-Channel payment tokenization from WorldPay.\n\n `79` - **Payout Return.** A Payout Disbursement was returned when attempted.\n\n `80` - **Payout Partial Return.** A Payout Disbursement was partially returned when attempted.\n\n `81` - **Revenue Share.** A configuration of multiple entities dividing revenue.\n\n `82` - **Card Settlement.** The funds from a card payment captured and authorized in a transaction have been settled.\n\n `83` - **eCheck Settlement.** The funds from an ACH/eCheck payment used in a transaction have been settled.\n\n `84` - **Revenue Share from Card.** Funds have been captured in a Revenue Share configuration from a card payment transaction.\n\n `85` - **Revenue Share from eCheck.** Funds have been captured in a Revenue Share configuration from an ACH / eCheck payment transaction.\n\n `86` - **Revenue Share Payout.** Funds from a Revenue Share capture have been settled and disbursed to the applicable entities.\n \n `88` - **PLAID_IDENTITY_MACH** \n \n `89` - **TXN_PLAID_IDENTITY_MACH** \n \n `90` - **PLAID_GET_IDENTITY** \n \n `91` - **TXN_PLAID_GET_IDENTITY** \n \n `92` - **PLAID_GET_AUTH** \n \n `93` - **TXN_PLAID_GET_AUTH**\n \n `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n \n `200` - **VALUTEC_ESSENTIAL_GIFT. External Fees**\n\n `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN. External Fees**\n\n `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE. External Fees**\n\n `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN. External Fees**\n\n `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE. External Fees**\n\n `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN. External Fees**\n\n `206` - **VALUTEC_TRANSACTION_FEE. External Fees**\n\n `207` - **VALUTEC_SETUP_FEE. External Fees**\n\n `208` - **VALUTEC_GIFT_ACH_POOLING. External Fees**\n\n `209` - **VALUTEC_JUMP_START_KIT. External Fees**\n\n `210` - **VALUTEC_LAUNCH_BOX_KIT. External Fees**\n\n `211` - **VALUTEC_500_CUSTOM_CARDS. External Fees**\n\n `212` - **VALUTEC_MAINTENANCE_FEE. External Fees**\n\n `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME. External Fees**\n\n `214` - **EFE_MWC_RESIDUAL_ATELIO** \n\n `215` - **EFE_MWC_RESIDUAL_PARAFIN** \n\n `216` - **EFE_MWC_BILLING** \n\n `217` - **FRAUDSIGHT_CNP_DECISION** \n\n `218` - **FRAUDSIGHT_CP_DECISION** \n\n `230` - **VALUTEC_OVERAGE_TRANSACTION_FEE. External Fees** \n\n `231` - **VALUTEC_STANDARD_MOBILE_PASS_MONTHLY_APPLE. External Fees** \n\n `232` - **VALUTEC_NFC_MOBILE_PASS_MONTHLY. External Fees** \n\n `233` - **VALUTEC_STANDARD_MOBILE_PASS_MONTHLY_GOOGLE. External Fees** \n\n `234` - **VALUTEC_ONLINE_GIFT_WEBSITE_MONTHLY. External Fees** \n\n `235` - **VALUTEC_MARKETING_360_MONTHLY. External Fees** \n\n `236` - **VALUTEC_ONLINE_GIFT_CARD_VOLUME_FEE. External Fees** \n\n `237` - **VALUTEC_SOCIAL_SHARING_MONTHLY. External Fees** \n\n `238` - **VALUTEC_DIGICARD_MONTHLY. External Fees** \n\n `239` - **VALUTEC_LOYALTY_STANDARD_MONTHLY. External Fees** \n\n `240` - **VALUTEC_AUTO_REWARDS_LPR_MONTHLY. External Fees** \n\n `241` - **VALUTEC_ONECARD_SETUP_FEE. External Fees** \n\n `242` - **VALUTEC_ONECARD_MONTHLY_FEE. External Fees** \n\n `243` - **VALUTEC_MONTHLY_FEE_CHOICE. External Fees** \n\n `244` - **VALUTEC_SYSTEM_ACCESS. External Fees** \n\n `245` - **VALUTEC_TRANSACTION. External Fees** \n\n `246` - **VALUTEC_MONTHLY_FEE_LAUNCHBOX. External Fees** \n\n `247` - **VALUTEC_MONTHLY_FEE_JUMPSTART** \n\n `248` - **VALUTEC_ONECARD_PHYSICAL_FULFILLMENT_FEE. External Fees** \n\n `249` - **VALUTEC_ONECARD_VIRTUAL_FULFILLMENT_FEE. External Fees** \n\n `250` - **VALUTEC_CUSTOMIZED_REPORTING. External Fees** \n\n `251` - **VALUTEC_TRANSACTION_FILE_FEED. External Fees** \n\n `252` - **VALUTEC_250_CUSTOM_CARDS. External Fees** \n\n `253` - **VALUTEC_1000_CUSTOM_CARDS. External Fees** \n\n `254` - **VALUTEC_2500_CUSTOM_CARDS. External Fees** \n\n `255` - **VALUTEC_5000_CUSTOM_CARDS. External Fees** \n\n `256` - **VALUTEC_10000_CUSTOM_CARDS. External Fees** \n \n `257` - **VALUTEC_15000_CUSTOM_CARDS. External Fees** \n \n `258` - **VALUTEC_20000_CUSTOM_CARDS. External Fees** \n \n `259` - **VALUTEC_25000_CUSTOM_CARDS. External Fees** \n \n `260` - **VALUTEC_250_EXPRESS_CARDS. External Fees** \n\n `261` - **VALUTEC_500_EXPRESS_CARDS. External Fees** \n\n `262` - **VALUTEC_1000_EXPRESS_CARD. External FeesS** \n \n `263` - **VALUTEC_2500_EXPRESS_CARDS. External Fees** \n \n `264` - **VALUTEC_5000_EXPRESS_CARDS. External Fees** \n \n `265` - **VALUTEC_10000_EXPRESS_CARDS. External Fees** \n\n `266` - **VALUTEC_SPECIALTY_CARDS. External Fees** \n\n `267` - **VALUTEC_KEYTAGS. External Fees** \n\n `268` - **VALUTEC_SLEEVES_CARRIERS_HANGERS. External Fees** \n\n `269` - **VALUTEC_SIGNATURE_PANEL. External Fees** \n\n `270` - **VALUTEC_4_4_PRINTING. External Fees** \n \n `271` - **VALUTEC_SPECIALTY_FINISH. External Fees** \n\n `272` - **VALUTEC_PANTONE. External Fees** \n\n `273` - **VALUTEC_PIN_SCRATCH. External Fees** \n\n `274` - **VALUTEC_MERCHANDISE. External Fees** \n\n `275` - **VALUTEC_GIFT_CARD_DESIGN_SETUP_FEE. External Fees**\n\n `276` - **VALUTEC_SHIPPING_HANDLING. External Fees** \n\n `277` - **VALUTEC_RUSH_FEES. External Fees** \n\n `278` - **VALUTEC_SEQUENCING. External Fees** \n\n `279` - **VALUTEC_WHOLESALE_FULFILLMENT_FEE. External Fees** \n\n `280` - **VALUTEC_MISCELLANEOUS_FEES. External Fees** \n\n `281` - **VALUTEC_HOSTING_FEE. External Fees** \n\n `282` - **VALUTEC_STORECARD_MONTHLY_FEE. External Fees** \n\n `283` - **VALUTEC_GIFT_ACH_FEE_MONTHLY. External Fees** \n\n `284` - **VALUTEC_ONECARD_MONTHLY_FEE_STORECARD. External Fees** \n\n `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** \n\n `401` - **REVBOOST_EMBEDDED_TMS_PPT**\n\n `402` - **TXN_THREAT_METRIX. External Fees**\n\n `403` - **THREAT_METRIX_EMAILAGE. External Fees**\n\n `404` - **THREAT_METRIX_FRAUD_POINT. External Fees**\n\n `405` - **GIACT_INQUIRY. External Fees**\n\n `406` - **GIACT_TXN_GAUTHENTICATE. External Fees**\n\n `407` - **TRULIOO_IDV. External Fees**\n\n `408` - **TRULIOO_AMLLDV. External Fees**\n\n `409` - **TRULIOO_BUSINESS_VERIFICATION. External Fees**\n\n `410` - **THREAT_METRIX_PHONE_FINDER. External Fees**\n\n `601` - **TIER_NON_QUALIFIED_COUNT** \n\n `602` - **TIER_QUALIFIED_COUNT** \n\n `603` - **TIER_MID_QUALIFIED_COUNT** \n\n `604` - **TIER_HIGH_RISK_COUNT** \n\n `605` - **TIER_NON_QUALIFIED_VOLUME** \n\n `606` - **TIER_QUALIFIED_VOLUME** \n\n `607` - **TIER_MID_QUALIFIED_VOLUME** \n\n `608` - **TIER_HIGH_RISK_VOLUME** \n\n `701` - **NYCE_ANNUAL_FEE** \n\n `702` - **PULSE_ANNUAL_FEE** \n\n `703` - **CU24_ANNUAL_FEE** \n\n `704` - **STAR_ANNUAL_FEE** \n\n `705` - **ACCEL_ANNUAL_FEE** \n\n `801` - **INGENICO_LINK_2500**, Canada (inactive) \n\n `802` - **INGENICO_LANE_3600_STD**, Canada \n\n `803` - **INGENICO_LANE_3600_DLX**, Canada (inactive) \n\n `804` - **INGENICO_LANE_7000_STD**, Canada \n\n `805` - **INGENICO_LANE_7000_DLX**, Canada (inactive) \n\n `806` - **INGENICO_MOVE_5000**, Canada (inactive) \n\n `807` - **PAYRIX_EQUIPMENT_SETUP_FEE** \n\n "
}
]
},
"scheduleFactor": {
"type": "integer",
"description": "A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. \nThis field is specified as an integer and its value determines how the interval is multiplied..",
"contentEncoding": "int32",
"default": 1
},
"start": {
"type": "integer",
"description": "The date on which charging of the Fee should start. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. \nThe value of this field must represent a date in the future, or the present date.",
"contentEncoding": "int32"
},
"finish": {
"type": "integer",
"description": "The date on which charging of the Fee should end. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. \nThe value of this field must represent a date in the future.",
"contentEncoding": "int32"
},
"collection": {
"allOf": [
{
"$ref": "#/$defs/feeCollection"
},
{
"description": "Applies the fee based on the volume of a resource.\n\n\nValid Values
\n\n- `1` - **Txn.** The total amount of all transactions.\n- `2` - **Txn-TaxID.** The total amount of all transactions per entity EIN/tax ID.\n- `3` - **Txn-Merchant.** The total amount of all transactions per entity.\n\n "
}
]
},
"collectionFactor": {
"allOf": [
{
"$ref": "#/$defs/feesCollectionFactor"
},
{
"description": "\"A multiplier that you can use to adjust the set of data to be used in the collection calculation. This field is specified as an integer and its value determines the period of time to be used.\"\n\nValid Values
\n\n- `1` - **DAYS**\n- `2` - **WEEKS**\n- `3` - **MONTHS**\n- `4` - **YEARS**\n\n "
}
]
},
"collectionOffset": {
"type": [
"integer",
"null"
],
"description": "The number of days, weeks, months or years to go back when selecting data for collection calculation.",
"contentEncoding": "int32"
},
"collectionIncludeCurrent": {
"type": "integer",
"description": "Whether to include the current period for the colleciton calculation.",
"contentEncoding": "int32"
},
"um": {
"allOf": [
{
"$ref": "#/$defs/feeUm"
},
{
"description": "The unit of measure for this Fee.\n\nNotes: \n * Percentage and Surcharge units will only apply to Fee schedules set to trigger from monetary events, such as an authorization, capture, or refund.\n\n\nValid Values
\n\n- `1` - **Percentage.** The Fee is a percentage of the related event amount, specified in the 'amount' field in basis points.\n\n- `2` - **Fixed Amount.** The Fee is a fixed amount, specified in the 'amount' field as an integer in cents.\n\n- `3` - **Surcharge.** The Fee is a percentage of the related event amount as a surcharge (the calculated amount will be based on the assumption that the related event amount already contains the fee amount in it), specified in the 'amount' field in basis points.\n\n "
}
]
},
"amount": {
"type": "number",
"description": "The total amount of this Fee. \nThe units used in this field are determined by the value of the 'um' field on the Fee. If the 'um' field is set to 'percentage', then this field specifies the Fee percentage to levy in basis points. If the 'um' field is set to 'amount', then this field specifies the Fee in cents(up to three decimal points)"
},
"maximum": {
"type": "number",
"description": "The maximum amount to charge for this fee when setting a percent-based fee. \n\n* Will be `null` for all other units."
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency of the amount in the fees resource. See Currency codes for all valid values."
}
]
},
"txnFee": {
"allOf": [
{
"$ref": "#/$defs/feesTxnFee"
},
{
"description": "Indicator to extract fee from txn supplied fee. When set, amount will correspond to the fee amount in the txn and only that amount will be extractable, anything over that amount will not be extracted. Valid Values
\n\n- `0` - **Disabled.** Fee will be calculated normally.\n\n- `1` - **Enabled.** Fee will be calculated based on transaction fee.\n\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"feeModifiers": {
"type": "array",
"items": {
"$ref": "#/$defs/feeModifiersPostRequest"
},
"description": ""
},
"feeRules": {
"type": "array",
"items": {
"$ref": "#/$defs/feeRulesPostRequest"
},
"description": ""
}
}
},
"feesPostRequestModelOrg": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/orgsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Org who should pay this Fee on behalf of the Entity identified in the value of the 'forentity' field. \nThis field is optional. If it is set, then the Fee is charged to this Org instead."
},
"feesTxnFee": {
"title": "feesTxnFee",
"enum": [
0,
1
],
"type": "integer"
},
"frozen": {
"title": "frozen",
"enum": [
0,
1
],
"type": "integer"
},
"globalBusinessType": {
"title": "globalBusinessType",
"enum": [
"ssn",
"tin",
"other",
"CD",
"AB",
"BC",
"MB",
"NB",
"NL",
"NT",
"NS",
"NU",
"ON",
"PE",
"QC",
"SK",
"YT"
],
"type": "string"
},
"holdsHoldSource": {
"title": "holdsHoldSource",
"enum": [
"DS_MODEL_POLICY_RUN",
"API_DECISION",
"POLICY_RUN",
"RISK_ALERT",
"MANUAL",
"ERROR"
],
"type": "string"
},
"holdsPostRequest": {
"title": "holdsPostRequest",
"required": [
"login"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login that owns this holds resource."
},
"verificationRef": {
"type": "string",
"description": "If this hold resource was triggered through Payrix Integration Risk, then this field stores the identifier of the VerificationRef."
},
"released": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
"type": "string",
"description": "If this hold was released, this will contain the timestamp for when it was released. (YYYY-MM-DD HH:II:SS)"
},
"reviewed": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
"type": "string",
"description": "If this hold was reviewed, this will contain the timestamp for when it was reviewed. The format should be YYYY-MM-DD HH:MM:SS."
},
"releaseAction": {
"allOf": [
{
"$ref": "#/$defs/holdsReleaseAction"
},
{
"description": "The final action taken on the hold while it's been released.\n\n\nValid Values
\n\n- `1` - **Holds released because the hold resource was approved.**\n- `2` - **Holds released because the hold resource was cancelled.**\n- `3` - **Holds released because the hold resource was refunded.**\n- `4` - **Holds released because the hold resource was failed.**\n- `5` - **Expired.**\n\n "
}
]
},
"holdSource": {
"allOf": [
{
"$ref": "#/$defs/holdsHoldSource"
},
{
"description": "Field created to know the reason for why a hold was created.\n\n\nValid Values
\n\n- `DS_MODEL_POLICY_RUN` - **DS_MODEL_POLICY_RUN**\n- `API_DECISION` - **API_DECISION**\n- `POLICY_RUN` - **POLICY_RUN**\n- `RISK_ALERT` - **RISK_ALERT**\n- `MANUAL` - **MANUAL**\n- `ERROR` - **ERROR**\n\n "
}
]
},
"holdSourceId": {
"type": "string",
"description": "reasonid for why a hold was created."
},
"delayedFundingStartDate": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
"type": "string",
"description": "The timestamp when hold was considered to be delaying funding. The format should be YYYY-MM-DD HH:MM:SS."
},
"delayedFundingEndDate": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
"type": "string",
"description": "The timestamp when hold stopped delaying funding, this might be due to the hold been released, cancelled or funded. (YYYY-MM-DD HH:II:SS)"
},
"analyst": {
"type": "string",
"description": "The person who review the hold applied."
},
"claimed": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$",
"type": [
"string",
"null"
],
"description": "The timestamp for the most recent update of the analyst field. (YYYY-MM-DD HH:II:SS)"
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"notes": {
"type": "array",
"items": {
"$ref": "#/$defs/notesPostRequest"
},
"description": ""
}
}
},
"holdsReleaseAction": {
"title": "holdsReleaseAction",
"enum": [
1,
2,
3,
4,
5
],
"type": "integer"
},
"hostsPostRequest": {
"title": "hostsPostRequest",
"required": [
"partition",
"api"
],
"type": "object",
"properties": {
"partition": {
"type": "string",
"description": "The identifier of the Partition resource that this Host belongs to."
},
"division": {
"type": "string",
"description": "The identifier of the Division resource that this Host belongs to."
},
"api": {
"type": "string",
"description": "The fully-qualified host name of the API for this Host. \nFor example, 'api.example.com'. \nThis field must be unique."
},
"portal": {
"type": "string",
"description": "The fully-qualified host name of the portal for this Host. \nFor example, 'portal.example.com'."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"inactive": {
"title": "inactive",
"enum": [
0,
1
],
"type": "integer"
},
"invoiceLineItemsPostRequest": {
"title": "invoiceLineItemsPostRequest",
"required": [
"invoice",
"invoiceItem"
],
"type": "object",
"properties": {
"invoice": {
"type": "string",
"description": "The identifier of the Invoice that owns this InvoiceLineItem."
},
"invoiceItem": {
"type": "string",
"description": "The identifier of the InvoiceItem associated with this InvoiceLineItem."
},
"quantity": {
"type": "integer",
"description": "The quantity purchased for this line item, specified as an integer.",
"contentEncoding": "int32",
"default": 1
},
"price": {
"type": [
"integer",
"null"
],
"description": "The price for each item, this field is specified as an integer in cents.",
"contentEncoding": "int64"
},
"discount": {
"type": [
"integer",
"null"
],
"description": "The discount for the line item, this field is specified as an integer in cents.",
"contentEncoding": "int64"
}
}
},
"invoiceParameterLocked": {
"title": "invoiceParameterLocked",
"enum": [
0,
1
],
"type": "integer"
},
"invoiceParameterType": {
"title": "invoiceParameterType",
"enum": [
"apikey",
"fromEmail",
"replyToEmail",
"dba",
"address1",
"address2",
"city",
"state",
"zip",
"country",
"phone",
"website",
"receiptTitle",
"receiptMessage",
"billingRequired",
"shippingRequired",
"eCheckAuthorization"
],
"type": "string"
},
"invoiceParametersPostRequest": {
"title": "invoiceParametersPostRequest",
"required": [
"login",
"type",
"value"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login that owns this invoiceParameter resource."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity associated with this invoiceParameter."
},
"division": {
"type": "string",
"description": "The identifier of the Division associated with this invoiceParameter."
},
"org": {
"type": "string",
"description": "The identifier of the Org associated with this invoiceParameter."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition associated with this invoiceParameter."
},
"locked": {
"allOf": [
{
"$ref": "#/$defs/invoiceParameterLocked"
},
{
"description": "Whether this invoiceParameter is locked. If locked, it defaults to the value of the invoiceParameter.\n\n\nValid Values
\n\n- `0` - **Not locked**\n- `1` - **Locked**\n\n "
}
]
},
"type": {
"allOf": [
{
"$ref": "#/$defs/invoiceParameterType"
},
{
"description": "The type of Transaction.\n\n\nValid Values
\n\n- `1` - **Credit Card Only:** Sale Transaction, processes a sale and charges the customer.\n- `2` - **Credit Card Only:** Auth Transaction, authorizes and holds the requested total on the credit card.\n- `3` - **Credit Card Only:** Capture Transaction, finalizes a prior Auth Transaction and charges the customer.\n- `4` - **Credit Card Only:** Reverse Authorization, reverses a prior Auth or Sale Transaction and releases the credit hold.\n- `5` - **Credit Card Only:** Refund Transaction, refunds a prior Capture or Sale Transaction (total may be specified for a partial refund).\n- `7` - **Echeck Only:** Echeck Sale Transaction, sale transaction for ECheck payment.\n- `8` - **Echeck Only:** ECheck Refund Transaction, refund transaction for prior ECheck Sale Transaction.\n- `11` - **Echeck Only:** Echeck Redeposit Transaction, attempt to redeposit a prior failed eCheck Sale Transaction.\n- `12` - **Echeck Only:** Echeck Account Verification Transaction, attempt to verify eCheck payment details.\n\n "
}
]
},
"value": {
"type": "string",
"description": "The value of this type of invoiceParameter."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"invoiceStatus": {
"title": "invoiceStatus",
"enum": [
"pending",
"cancelled",
"expired",
"viewed",
"paid",
"confirmed",
"refunded",
"rejected"
],
"type": "string"
},
"invoiceType": {
"title": "invoiceType",
"enum": [
"single",
"multiUse",
"recurring"
],
"type": "string"
},
"invoicesEmailStatus": {
"title": "invoicesEmailStatus",
"enum": [
"send",
"sent",
"pending"
],
"type": "string"
},
"invoicesPostRequest": {
"title": "invoicesPostRequest",
"required": [
"login",
"merchant",
"subscription",
"number",
"status"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login of this invoice resource."
},
"merchant": {
"type": [
"string",
"null"
],
"description": "The identifier of the Merchant of this invoice resource."
},
"customer": {
"allOf": [
{
"$ref": "#/$defs/invoicesPostRequestModelCustomer"
},
{
"description": "The identifier of the Customer of this invoice resource."
}
]
},
"subscription": {
"type": [
"string",
"null"
],
"description": "The identifier of the Subscription of this invoice resource."
},
"number": {
"type": "string",
"description": "The invoice number."
},
"allowedPaymentMethods": {
"type": "string",
"description": "The methods of payment allowed for this invoice. This field accepts multiple options concatenated into a \nsingle string with a pipe (|) separator between each option.\n\n\nAllowed Values
\n\n- `Amex` - **American Express**\n- `Visa` - **Visa card**\n- `Mc` - **MasterCard**\n- `Diners` - **Diners Club card**\n- `Discover` - **Discover card**\n- `PayPal` - **PayPal payment method**\n- `Debit` - **Debit card**\n- `Checking` - **Checking account**\n- `Savings` - **Savings account**\n- `CorpChecking` - **Corporate checking account**\n- `CorpSavings` - **Corporate savings account**\n- `Gift` - **Gift card**\n- `EBT` - **Electronic Benefits Transfer**\n- `WIC` - **Women, Infants, and Children program**\n- `Accel` - **Accel network**\n- `ATH` - **ATH network**\n- `AFFN` - **Armed Forces Financial Network**\n- `Culiance` - **Culiance network**\n- `Interlink` - **Interlink network**\n- `Jeanie` - **Jeanie network**\n- `Maestro` - **Maestro card**\n- `NYCE` - **NYCE network**\n- `Pulse` - **Pulse network**\n- `Shazam` - **Shazam network**\n- `Star` - **Star network**\n- `Interac` - **Interac network**\n- `Omnitoken` - **Omnitoken**\n\n "
},
"title": {
"type": "string",
"description": "The title of the invoice."
},
"message": {
"type": "string",
"description": "The message that will be sent with the invoice."
},
"total": {
"type": "integer",
"description": "The total amount for this invoice.",
"contentEncoding": "int64",
"default": 0
},
"tax": {
"type": [
"integer",
"null"
],
"description": "The tax amount for this invoice.",
"contentEncoding": "int64"
},
"discount": {
"type": [
"integer",
"null"
],
"description": "The discount amount applied to this invoice.",
"contentEncoding": "int64"
},
"dueDate": {
"type": [
"integer",
"null"
],
"description": "The date the invoice is due.",
"contentEncoding": "int32"
},
"expirationDate": {
"type": [
"integer",
"null"
],
"description": "The date the invoice is due.",
"contentEncoding": "int32"
},
"sendOn": {
"type": [
"integer",
"null"
],
"description": "The date to send this invoice.",
"contentEncoding": "int32"
},
"status": {
"allOf": [
{
"$ref": "#/$defs/invoiceStatus"
},
{
"description": "The current status of the transaction.\n\nValid Values
\n - `pending` - **Pending**\n - `cancelled` - **Cancelled**\n - `expired` - **Expired**\n - `viewed` - **Viewed**\n - `paid` - **Paid**\n - `confirmed` - **Confirmed**\n - `refunded` - **Refunded** \n - `rejected` - **Rejected**\n "
}
]
},
"emailStatus": {
"allOf": [
{
"$ref": "#/$defs/invoicesEmailStatus"
},
{
"description": "The current status of the invoice.\n\n\nValid Values
\n\n - `send` - **Updated email status to indicate the invoice is ready to be sent to the customer.**\n - `sent` - **Updated email status once the invoice is sent to the customer.**\n - `pending` - **Updated email status pending**\n\n "
}
]
},
"emails": {
"type": [
"string",
"null"
],
"description": "The email addresses to send the invoice to."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/invoiceType"
},
{
"description": "The type of invoice.\n\n\nValid Values
\n\n- `single` - **A single-use invoice.**\n- `multiUse` - **A static, reusable invoice. (Payment Page.)**\n- `recurring` - **A subscription-based invoice.**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"invoiceLineItems": {
"type": "array",
"items": {
"$ref": "#/$defs/invoiceLineItemsPostRequest"
},
"description": ""
}
}
},
"invoicesPostRequestModelCustomer": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"allOf": [
{
"$ref": "#/$defs/customersPostRequest"
},
{}
]
}
],
"description": "The identifier of the Customer of this invoice resource."
},
"loginsMfaEnabled": {
"title": "loginsMfaEnabled",
"enum": [
0,
1
],
"type": "integer"
},
"loginsPortalAccess": {
"title": "loginsPortalAccess",
"enum": [
0,
1
],
"type": "integer"
},
"loginsPostRequest": {
"title": "loginsPostRequest",
"required": [
"username",
"password",
"first",
"last",
"email",
"mfaEnabled"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The parent user that owns this user. Defaults to authenticated user’s ID if no value is explicitly set."
},
"partition": {
"type": "string",
"description": "The partition that this Login is associated with. The partition association opens access to partition-level administrators on this user and all records owned by this user. Defaults to authenticated user’s partition if no value is explicitly set."
},
"division": {
"allOf": [
{
"$ref": "#/$defs/loginsPostRequestModelDivision"
},
{
"description": "The division that this Login belongs to. The division association opens access to division-level administrators on this user and all records owned by this user. Defaults to authenticated user’s division if no value is explicitly set."
}
]
},
"parentDivision": {
"type": "string",
"description": "The parent division that this Login belongs to. Children of this Login will inherit its parent division. The parentDivision association may be used for whitelabeling the user experience for parent divisions that have implemented a whitelabel solution (as long as the child division that the user is associated with has not implemented their own). Defaults to authenticated user’s parentDivision if no value is explicitly set."
},
"roles": {
"type": "integer",
"description": "The roles associated with this Login, specified as an integer. Single Roles- Valid Values
16 - Entity64 - Vendor128 - Merchant256 - Create Merchant512 - Password1024 - Log2048 - Unfreeze4096 - Modify Roles8192 - Payment IDs65536 - MCC131072 - TXN Report262144 - Disbursement524288 - Fund Reserve1048576 - Platform Refs2097152 - Verification4194304 - Fee8388608 - Challenge16777216 - Reserve TXN33554432 - Set Boarded67108864 - Assessment134217728 - Adjustment268435456 - Merchant Flow1073741824 - Confirm Email2147483648 - TIN Status4294967296 - Entity Route8589934592 - Files17179869184 - Unmask Private34359738368 - Unmask Bank68719476736 - Thread Create137438953472 - BIN Query274877906944 - BIN Change1099511627776 - Assessment View17592186044416 - Entity Return70368744177664 - Watchlist140737488355328 - Profit Share281474976710656 - MFA
Multi-Roles- Valid Values
144 - Entity, Merchant192 - Vendor, Merchant208 - Entity, Vendor, Merchant320 - Vendor, Create Merchant384 - Merchant, Create Merchant400 - Entity, Merchant, Create Merchant131136 - Vendor, TXN Report131200 - Merchant, TXN Report131456 - Merchant, Create Merchant, TXN Report1048640 - Vendor, Platform Refs1048704 - Merchant, Platform Refs1048768 - Vendor, Merchant, Platform Refs2097216 - Vendor, Verification4194368 - Vendor, Fee4194384 - Entity, Vendor, Fee134217792 - Vendor, Adjustment268435584 - Merchant, Merchant Flow272630160 - Entity, Merchant, Create Merchant, Fee, Merchant Flow272630224 - Entity, Vendor, Merchant, Create Merchant, Fee, Merchant Flow273154512 - Entity, Vendor, Merchant, Create Merchant, Fund Reserve, Fee, Merchant Flow1099511627840 - Vendor, Assessment View1099511758912 - Vendor, TXN Report, Assessment View
",
"contentEncoding": "int64",
"default": 0
},
"username": {
"type": "string",
"description": "The username associated with this Login. \nThis field is stored as a text string, all lowercase, and must be between 0 and 50 characters long."
},
"password": {
"type": "string",
"description": "The password associated with this Login. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"first": {
"type": "string",
"description": "The first name associated with this Login."
},
"middle": {
"type": "string",
"description": "The middle name associated with this Login."
},
"last": {
"type": "string",
"description": "The last name associated with this Login."
},
"email": {
"type": "string",
"description": "The email address associated with this Login."
},
"allowedResources": {
"type": "string",
"description": "The allowedResources field specifies the actions and resources a user can access. The JSON structure includes action keys (create, update, read, delete, totals) and lists of resources (e.g., logins, apikeys, sessions). Omitted action keys indicate no access for those actions. Instructions
In addition to the roles for this login, you can specify API functionality by creating a JSON object as the value for this field using with data arrays titled: ”create”: [], ”read”: [], ”update”: [], ”delete”: [], and ”totals”: [] for their API CRUD functions POST, GET, PUT, DELETE with the totals array setting users ability to calculate and report on disbursements, funds, and other monetary totals relevant to the specified endpoint resources. Add the names of each endpoint resource separated by a comma (,) for which you want to provide functionality.\nFor example, { \"create\": [\"payouts\"] } allows this login to create payout transactions using the POST /payouts API request method.\n - Note: Resources are case sensitive. Our API uses camelCase. If you are unsure of formatting, refer to the API specification to copy the exact endpoint title without the initial forward slash ( / ) for the relevant allowedResources or restrictedResources arrays.
\n "
},
"restrictedResources": {
"type": "string",
"description": "The restrictedResources field defines the actions and resources a user is restricted from accessing. The JSON structure includes action keys (create, update, read, delete, totals) and lists of resources (e.g., logins, apikeys, sessions). Omitted action keys indicate no restrictions for those actions. Instructions
In addition to the roles for this login, you can specify API functionality by creating a JSON object as the value for this field using with data arrays titled: ”create”: [], ”read”: [], ”update”: [], ”delete”: [], and ”totals”: [] for their API CRUD functions POST, GET, PUT, DELETE with the totals array setting users ability to calculate and report on disbursements, funds, and other monetary totals relevant to the specified endpoint resources. Add the names of each endpoint resource separated by a comma (,) for which you want to provide functionality.\nFor example, { \"create\": [\"payouts\"] } allows this login to create payout transactions using the POST /payouts API request method.\n - Note: Resources are case sensitive. Our API uses camelCase. If you are unsure of formatting, refer to the API specification to copy the exact endpoint title without the initial forward slash ( / ) for the relevant allowedResources or restrictedResources arrays.
\n "
},
"portalAccess": {
"allOf": [
{
"$ref": "#/$defs/loginsPortalAccess"
},
{
"description": "Whether or not this user should have access to portal functionality. \n\n\nValid Values
\n\n - `0` - **No access to the portal**\n\n - `1` - **Has access to the portal**\n\n "
}
]
},
"mfaEnabled": {
"allOf": [
{
"$ref": "#/$defs/loginsMfaEnabled"
},
{
"description": "Whether or not this user should have multi factor authentication (MFA) feature.\n\n\nValid Values
\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n "
}
]
},
"mfaSecret": {
"type": "string",
"description": "The MFA secret key used to link the MFA device with this Login. \nThis field is stored as a text string and must be between 1 and 128 characters long."
},
"mfaEnrolledDate": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The datetimestamp when this Login was enabled for MFA."
},
"mfaType": {
"type": "string",
"description": "The Type of the MFA enrolled. \nThis field is stored as a text string and must be between 1 and 50 characters long."
},
"address1": {
"type": "string",
"description": "The first line of the address associated with this Login. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"address2": {
"type": "string",
"description": "The second line of the address associated with this Login. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"city": {
"type": "string",
"description": "The name of the city in the address associated with this Login. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"state": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"zip": {
"type": "string",
"description": "The ZIP code in the address associated with this Login. \nThis field is stored as a text string and must be between 1 and 20 characters long."
},
"country": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country associated with this Customer/InvoiceResult, valid values for this field are the 3-letter ISO code for the country."
}
]
},
"phone": {
"type": "string",
"description": "The phone number associated with this Login. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"fax": {
"type": "string",
"description": "The fax number associated with this Login. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/$defs/aggregationsPostRequest"
},
"description": ""
},
"customers": {
"type": "array",
"items": {
"$ref": "#/$defs/customersPostRequest"
},
"description": ""
},
"billings": {
"type": "array",
"items": {
"$ref": "#/$defs/billingsPostRequest"
},
"description": ""
},
"divisions": {
"type": "array",
"items": {
"$ref": "#/$defs/divisionsPostRequest"
},
"description": ""
},
"entities": {
"type": "array",
"items": {
"$ref": "#/$defs/entitiesPostRequest"
},
"description": ""
},
"invoiceParameters": {
"type": "array",
"items": {
"$ref": "#/$defs/invoiceParametersPostRequest"
},
"description": ""
},
"messageThreads": {
"type": "array",
"items": {
"$ref": "#/$defs/messageThreadsPostRequest"
},
"description": ""
},
"notes": {
"type": "array",
"items": {
"$ref": "#/$defs/notesPostRequest"
},
"description": ""
},
"orgFlows": {
"type": "array",
"items": {
"$ref": "#/$defs/orgFlowsPostRequest"
},
"description": ""
},
"orgFlowsforlogin": {
"type": "array",
"items": {
"$ref": "#/$defs/orgFlowsPostRequest"
},
"description": ""
},
"profitShares": {
"type": "array",
"items": {
"$ref": "#/$defs/profitSharesPostRequest"
},
"description": ""
},
"teamLogins": {
"type": "array",
"items": {
"$ref": "#/$defs/teamLoginPostRequest"
},
"description": ""
},
"teams": {
"type": "array",
"items": {
"$ref": "#/$defs/teamsPostRequest"
},
"description": ""
}
}
},
"loginsPostRequestModelDivision": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/divisionsPostRequest"
},
{}
]
}
],
"description": "The division that this Login belongs to. The division association opens access to division-level administrators on this user and all records owned by this user. Defaults to authenticated user’s division if no value is explicitly set."
},
"membersPoliticallyExposed": {
"title": "membersPoliticallyExposed",
"enum": [
0,
1
],
"type": "integer"
},
"membersPostRequest": {
"title": "membersPostRequest",
"required": [
"merchant",
"first",
"last",
"dob",
"email",
"ownership",
"timezone"
],
"type": "object",
"properties": {
"merchant": {
"type": "string",
"description": "The identifier of the Merchant associated with this Member."
},
"title": {
"type": "string",
"description": "The title that this Member holds in relation to the associated Merchant. \nThis field is stored as a text string and must be between 0 and 100 characters long.\nFor example, 'CEO', 'Owner' or 'Director of Finance'."
},
"first": {
"type": "string",
"description": "The first name associated with this Member. \nThis field is stored as a text string and must be between 1 and 100 characters long."
},
"middle": {
"type": "string",
"description": "The middle name associated with this Member. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"last": {
"type": "string",
"description": "The last name associated with this Member. \nThis field is stored as a text string and must be between 1 and 100 characters long."
},
"ssn": {
"type": "string",
"description": "The social security number of this Member. This field is required if the Merchant associated with the Member is a sole trader. \nThis field is stored as a text string and must be 9 characters long and numeric characters only."
},
"citizenship": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country of which the owner is a citizen. \nValid values for this field is the 3-letter ISO code for the country."
}
]
},
"dob": {
"type": "integer",
"description": "The date of birth of this Member. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.",
"contentEncoding": "int32"
},
"gender": {
"allOf": [
{
"$ref": "#/$defs/MembersGender"
},
{
"description": "The gender of this Member.\n\n\nValid Values
\n\n- `male` - **Male** \n\n- `female` - **Female**\n\n "
}
]
},
"dl": {
"type": "string",
"description": "The driver's license number of this Member. \nThis field is stored as a text string and must be between 0 and 15 characters long."
},
"dlstate": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"email": {
"type": "string",
"description": "The email address of this Member. \nThis field is stored as a text string and must be between 1 and 100 characters long."
},
"ownership": {
"type": "integer",
"description": "The share of the Member's ownership of the associated Merchant, expressed in basis points. \nFor example, 25.3% is expressed as '2530'. \nThis field is stored as an integer and must be between 1 and 10000 characters long.",
"contentEncoding": "int32"
},
"primary": {
"allOf": [
{
"$ref": "#/$defs/membersPrimary"
},
{
"description": "Indicates whether the Member is the 'primary' contact for the associated Merchant. Only one Member associated with each Merchant can be the 'primary' Member.\n\n\nValid Values
\n\n- `0` - **Not Primary contact.** \n\n- `1` - **Primary contact.**\n\n "
}
]
},
"creditScore": {
"type": "integer",
"description": "A credit score is a three-digit number that rates your creditworthiness. scores range from 334 to 818.",
"contentEncoding": "int32",
"default": 0
},
"creditScoreDate": {
"type": "string",
"description": "Date for Credit Score."
},
"significantResponsibility": {
"allOf": [
{
"$ref": "#/$defs/membersSignificantResponsibility"
},
{
"description": "'A controlling authority', or 'Control Prong'. Includes, but is not limited to:\n\n * Chief Executive Officer,\n \n * Chief Financial Officer, \n \n * Chief Operating Officer, \n \n * Managing Member, \n \n * General Partner, \n \n * President, \n \n * Vice Presidents, or \n \n * An individual with significant legal authority to enter the Legal Entity into a commercial relationship.\n\n\nValid Values
\n\n- `0` - **No significant responsibility.** \n\n- `1` - **Significant reponsibility.**\n\n "
}
]
},
"politicallyExposed": {
"allOf": [
{
"$ref": "#/$defs/membersPoliticallyExposed"
},
{
"description": "This person is politically exposed, defined as: \"persons whom through their prominent position or influence, is more susceptible to being involved in bribery or corruption.\"\n\n\nValid Values
\n\n- `0` - **Not politically exposed.** \n\n- `1` - **Politically exposed.**\n\n "
}
]
},
"mailingAddress1": {
"type": "string",
"description": "The mailing first line of the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"mailingAddress2": {
"type": "string",
"description": "The mailing second line of the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"mailingCity": {
"type": "string",
"description": "The mailing name of the city in the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"mailingState": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"mailingCountry": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country of which the owner is a citizen. \nValid values for this field is the 3-letter ISO code for the country."
}
]
},
"mailingPostalCode": {
"type": "string",
"description": "The mailing postal code in the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 20 characters long."
},
"treasuryPrimeRoles": {},
"timezone": {
"allOf": [
{
"$ref": "#/$defs/MembersTimezone"
},
{
"description": "The timezone for the address associated with the terminal's location.\n\n\nValid Values
\n\n - `est` - **Eastern Standard Time**\n \n - `cst` - **Central Standard Time**\n \n - `pst` - **Pacific Standard Time**\n \n - `mst` - **Mountain Daylight Time**\n \n - `akst` - **Alaska Standard Time**\n \n - `hst` - **Hawaii Standard Time**\n \n - `sst` - **Samoa Standard Time**\n \n - `chst` - **Chamorro Standard Time**\n \n - `ast` - **Atlantic Standard Time**\n \n - `pwt` - **Palau Time**\n \n - `mht` - **Marshall Islands Time**\n \n - `chut` - **Chuuk Time**\n \n - `nst` - **Newfoundland Standard Time**\n\n "
}
]
},
"address1": {
"type": "string",
"description": "The first line of the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"address2": {
"type": "string",
"description": "The second line of the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"city": {
"type": "string",
"description": "The name of the city in the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"state": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"zip": {
"type": "string",
"description": "The ZIP code in the address associated with this Member. \nThis field is stored as a text string and must be between 1 and 20 characters long."
},
"country": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country of which the owner is a citizen. \nValid values for this field is the 3-letter ISO code for the country."
}
]
},
"phone": {
"type": "string",
"description": "The phone number associated with this Member. \nThis field is stored as a text string and must be between 5 and 15 characters long."
},
"fax": {
"type": "string",
"description": "The fax number associated with this Member. \nThis field is stored as a text string and must be between 5 and 15 characters long."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"membersPrimary": {
"title": "membersPrimary",
"enum": [
0,
1
],
"type": "integer"
},
"membersSignificantResponsibility": {
"title": "membersSignificantResponsibility",
"enum": [
0,
1
],
"type": "integer"
},
"merchantAutoBoarded": {
"title": "merchantAutoBoarded",
"enum": [
0,
1
],
"type": "integer"
},
"merchantEnvironment": {
"title": "merchantEnvironment",
"enum": [
"supermarket",
"moto",
"cardPresent",
"fuel",
"serviceStation",
"restaurant",
"ecommerce"
],
"type": "string"
},
"merchantLocationType": {
"title": "merchantLocationType",
"enum": [
77,
78,
79,
80,
81
],
"type": "integer"
},
"merchantRiskLevel": {
"title": "merchantRiskLevel",
"enum": [
"restricted",
"prohibited",
"high",
"medium",
"low"
],
"type": "string"
},
"merchantStatus": {
"title": "merchantStatus",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"type": "integer"
},
"merchantStatusReason": {
"title": "merchantStatusReason",
"enum": [
"rejected",
"fraud",
"noResponse",
"withdrawn"
],
"type": "string"
},
"merchantsAdvanceBilling": {
"title": "merchantsAdvanceBilling",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsApplePayActive": {
"title": "merchantsApplePayActive",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsExpressBatchCloseMethod": {
"title": "merchantsExpressBatchCloseMethod",
"enum": [
"TimeInitiated",
"MerchantInitiated"
],
"type": "string"
},
"merchantsGooglePayActive": {
"title": "merchantsGooglePayActive",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsIncrementalAuthSupported": {
"title": "merchantsIncrementalAuthSupported",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsLetterStatus": {
"title": "merchantsLetterStatus",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsNaics": {
"title": "merchantsNaics",
"enum": [
"11",
"21",
"22",
"23",
"31-33",
"41",
"44-45",
"48-49",
"51",
"52",
"53",
"54",
"55",
"56",
"61",
"62",
"71",
"72",
"81",
"91/92"
],
"type": "string"
},
"merchantsOmniTokenEnabled": {
"title": "merchantsOmniTokenEnabled",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsPassTokenEnabled": {
"title": "merchantsPassTokenEnabled",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsPostRequest": {
"title": "merchantsPostRequest",
"required": [
"entity",
"environment"
],
"type": "object",
"properties": {
"totalApprovedSales": {
"type": "integer",
"description": "Show the total approved amount to this merchant.",
"contentEncoding": "int64",
"default": 0
},
"entity": {
"allOf": [
{
"$ref": "#/$defs/merchantsPostRequestModelEntity"
},
{
"description": "The Entity associated with this Merchant."
}
]
},
"dba": {
"type": "string",
"description": "The name under which the Merchant is doing business, if applicable. This field is stored as a text string and must be between 0 and 50 characters long."
},
"new": {
"allOf": [
{
"$ref": "#/$defs/MerchantsNew"
},
{
"description": "An indicator that specifies whether the Merchant is new to credit card processing, where merchants are considered to be new by default and can have a valid value of either '0' (Not new) or '1' (New).\n\n\nValid Values
\n\n- `0` - **Not new**\n- `1` - **New**\n\n "
}
]
},
"advancedBilling": {
"allOf": [
{
"$ref": "#/$defs/merchantsAdvanceBilling"
},
{
"description": "Indicates whether the merchant accepts pre-purchase for products that are shipped at a later date or not currently available, specifying advanced billing as either disabled (0) or enabled (1).\n\n\nValid Values
\n\n- `0` - **AdvancedBilling is disabled.**\n- `1` - **AdvancedBilling is enabled.**\n\n "
}
]
},
"seasonal": {
"allOf": [
{
"$ref": "#/$defs/merchantsSeasonal"
},
{
"description": "Indicates if the merchant is a seasonal merchant or operates year-round.\n\n\nValid Values
\n\n- `0` - **Year-Round Merchant**\n- `1` - **Seasonal Merchant**\n\n "
}
]
},
"established": {
"type": "integer",
"description": "The date on which the Merchant was established. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.\n\n**Note:** Include the `established` date value to ensure successful underwriting and new Merchant onboarding to the VCore platform.",
"contentEncoding": "int32"
},
"annualCCSales": {
"type": "integer",
"description": "The value of the annual credit card sales of this Merchant. \nThis field is specified as an integer in cents. For example, $25.30 is expressed as '2530'.",
"contentEncoding": "int64",
"default": 0
},
"annualCCSaleVolume": {
"type": "integer",
"description": "The value of the annual credit card sale volume of this Merchant. \nThis field is specified as an integer in cents. For example, $25.30 is expressed as '2530'.",
"contentEncoding": "int64"
},
"annualACHSaleVolume": {
"type": "integer",
"description": "The value of the annual direct deposit sale volume of this Merchant. \nThis field is specified as an integer in cents. For example, $25.30 is expressed as '2530'.",
"contentEncoding": "int64"
},
"amexVolume": {
"type": "integer",
"description": "Indicates the Annual AMEX Sales Volume for the outlet.",
"contentEncoding": "int64"
},
"avgTicket": {
"type": "integer",
"description": "The value of the average credit card sales of this Merchant. \nThis field is specified as an integer in cents. For example, $25.30 is expressed as '2530'.",
"contentEncoding": "int64",
"default": 0
},
"amex": {
"type": "string",
"description": "The American Express merchant identifier for this Merchant, if applicable. \nThis field is stored as a string and must be between 1 and 15 characters long."
},
"discover": {
"type": "string",
"description": "The Discover merchant identifier for this Merchant, if applicable. \nThis field is stored as a string and must be between 1 and 15 characters long."
},
"mcc": {
"type": "string",
"description": "The Merchant Category Code (MCC) for this Merchant. This code is not required to create a Merchant, but it is required to successfully board a Merchant."
},
"visaMvv": {
"type": "string",
"description": "Merchant Verification Value. A value assigned by Visa to identify participation in select merchant programs."
},
"visaDisclosure": {
"allOf": [
{
"$ref": "#/$defs/merchantsVisaDisclosureIP"
},
{
"description": "Whether or not the merchant has acknowledged and accepted the Visa Disclosure.\n\n\nValid Values
\n\n- `0` - **Not Accepted**\n- `1` - **Accepted**\n\n "
}
]
},
"disclosureIP": {
"type": "string",
"description": "The IP address where the Merchant platform disclosure is hosted."
},
"disclosureDate": {
"type": "integer",
"description": "The date the Merchant platform disclosure is reviewed by the Merchant. The format should be YYYYMMDD",
"contentEncoding": "int32"
},
"environment": {
"allOf": [
{
"$ref": "#/$defs/merchantEnvironment"
},
{
"description": "The environment which the Merchant is in, if applicable.\n\n\nValid Values
\n\n- `supermarket` - **Supermarkets / Grocery**\n- `moto` - **Mail Order / Telephone Order**\n- `cardPresent` - **Card Present Environment**\n- `fuel` - **Fuel / Gas Stations**\n- `serviceStation` - **Service Stations**\n- `restaurant` - **Restaurants**\n- `ecommerce` - **eCommerce / Online Sales**\n\n "
}
]
},
"status": {
"allOf": [
{
"$ref": "#/$defs/merchantStatus"
},
{
"description": "The status of the Merchant.\n\n\nValid Values
\n\n- `0` - **Not ready**. Occurs when a new Merchant is created. Unable to process payments.\n- `1` - **Ready**. New Merchant submitted for underwriting approval after submitting a signup form.\n- `2` - **Boarded**. Merchant has been approved and boarded to the platform. Payment processing now available.\n- `3` - **Manual**. Set internally by platform underwriting. New Merchant is pending manual verification.\n- `4` - **Closed**. Set internally by platform underwriting. New Merchant was declined and cannot access the platform.\n- `5` - **Incomplete**. Set by user boarding the merchant. Can be manually set to \"save\" an incomplete Merchant boarding request for a later time.\n- `6` - **Pending**. New Merchant was submitted for boarding, platform access pending review.\n\n "
}
]
},
"incrementalAuthSupported": {
"allOf": [
{
"$ref": "#/$defs/merchantsIncrementalAuthSupported"
},
{
"description": "This field allows the ability to submit merchant registration files with a MasterCard (MC) Auth Integrity value.\n\n\nValid Values
\n\n- `0` - **Incremental Auth Not Supported**\n- `1` - **Incremental Auth Supported**\n\n "
}
]
},
"autoBoarded": {
"allOf": [
{
"$ref": "#/$defs/merchantAutoBoarded"
},
{
"description": "Whether the merchant auto-boarded.\n\n\nValid Values
\n\n- `0` - **Not Auto-Boarded**\n- `1` - **Auto-Boarded**\n\n "
}
]
},
"statusReason": {
"allOf": [
{
"$ref": "#/$defs/merchantStatusReason"
},
{
"description": "The reason for manual or closure status. \n\n\nValid Values
\n\n `rejected` - **Merchant account rejected for servicing.**\n\n`fraud` - **Merchant or submission was determined to be fraudulent.**\n\n`noResponse` - **No response given in expected time frame for verification/validation inquiry.**\n\n`withdrawn` - **Merchant submission withdrawn.**\n\n\n "
}
]
},
"locationType": {
"allOf": [
{
"$ref": "#/$defs/merchantLocationType"
},
{
"description": "Description of the type of address that the business operates at.\n\n\nValid Values
\n\n- `77` - **Retail Storefront**\n- `78` - **Warehouse**\n- `79` - **Private Residence**\n- `80` - **Others**\n- `81` - **P. RES-PROF/Construction**\n\n "
}
]
},
"percentEcomm": {
"type": "integer",
"description": "This field indicates what percentage are internet originated transactions.",
"contentEncoding": "int32"
},
"percentKeyed": {
"type": "integer",
"description": "The merchant percentage of transactions that are Card Not Present (Includes MOTO and eCommerce).",
"contentEncoding": "int32"
},
"percentBusiness": {
"type": "integer",
"description": "This field indicates what percentage of the transactions are Business to Business.",
"contentEncoding": "int32"
},
"totalVolume": {
"type": "integer",
"description": "The expected total volume for all credit card and ACH payments that the merchant will process for the current year.",
"contentEncoding": "int64"
},
"accountClosureReasonCode": {
"type": "string",
"description": "The denial or account closure reason code."
},
"accountClosureReasonDate": {
"type": "integer",
"description": "The date the account closure reason code was provided. The format should be YYYMMDD.",
"contentEncoding": "int32"
},
"riskLevel": {
"allOf": [
{
"$ref": "#/$defs/merchantRiskLevel"
},
{
"description": "The risk level which the Merchant is in, if applicable.\n\n\nValid Values
\n\n- `restricted` - **Restricted from processing transactions.**\n- `prohibited` - **Prohibited business use category.**\n- `high` - **High merchant risk score.**\n- `medium` - **Medium merchant risk score.**\n- `low` - **Low merchant risk score.**\n\n "
}
]
},
"creditRatio": {
"type": "integer",
"description": "The credit ratio to use while calculating risk factors for credit, if applicable.",
"contentEncoding": "int32"
},
"creditTimeliness": {
"type": "integer",
"description": "The credit timeliness for the Merchant, if applicable.",
"contentEncoding": "int32"
},
"chargebackRatio": {
"type": "integer",
"description": "Chargeback Ratio.",
"contentEncoding": "int32"
},
"ndxDays": {
"type": "integer",
"description": "The ndx (Non Delivery Exposure) days which the Merchant is in, if applicable.",
"contentEncoding": "int32"
},
"ndxPercentage": {
"type": "integer",
"description": "The ndx (Non Delivery Exposure) percentage to be used for the merchant, if applicable.",
"contentEncoding": "int32"
},
"saqType": {
"allOf": [
{
"$ref": "#/$defs/merchantsSaqType"
},
{
"description": "Payment Card Industry Data Security Standard (PCI DSS) Self-assessment questionnaire (SAQ). Details about a merchant's business and the way they currently accept payments or plan to in the future.\n\n\nValid Values
\n\n- `SAQ-A` - **Card-not-present merchants (e-commerce or mail/telephone-order) with PCI DSS-validated third-party payments service provider(s) and does not store cardholder data.**\n- `SAQ-A-EP` - **E-commerce merchants with PCI DSS-validated third-party payments service provider(s) with a website that doesn't directly collect cardholder data, but may impact it in some way, and does not store cardholder data.**\n- `SAQ-B` - **Merchants with imprint machines or standalone, dial-out terminals that do not store cardholder data.**\n- `SAQ-B-IP` - **Merchants with standalone, PTS-approved payment terminals that have an IP connection to the payment processor, but do not store cardholder data.**\n- `SAQ-C-VT` - **Merchants that enter single transactions manually into an internet-based terminal hosted by PCI DSS-validated third-party payments service provider(s) and does not store cardholder data.**\n- `SAQ-C` - **Merchants with payment application systems connected to the internet that do not store cardholder data.**\n- `SAQ-P2PE-HW` - **Merchants with hardware-only payment terminals managed by a PCI SSC-listed P2PE solution, and does not store cardholder data.**\n- `SAQ-D` - **Generic field for all Merchants that do not fall under the requirements for any above SAQ types.**\n\n "
}
]
},
"saqDate": {
"type": "integer",
"description": "The date of the PCI SAQ assessment. The format should be YYYYMMDD.",
"contentEncoding": "int32"
},
"qsa": {
"type": "string",
"description": "Qualified Security Assessor (QSA) companies are independent security organizations that have been qualified by the PCI Security Standards Council to validate an entity's adherence to PCI DSS. This is a free-text field for inputting the QSA's business name.\n The name of the Qualified Security Assessor (QSA) used by the Merchant to assess, verify and prove their PCI DSS compliance."
},
"letterStatus": {
"allOf": [
{
"$ref": "#/$defs/merchantsLetterStatus"
},
{
"description": "Indicates whether the letter status is ON or OFF.\n\n\nValid Values
\n\n- `0` - **OFF**\n- `1` - **ON**\n\n "
}
]
},
"letterDate": {
"type": "integer",
"description": "The date of letter. The format should be YYYYMMDD.",
"contentEncoding": "int32"
},
"chargebackNotificationEmail": {
"type": "string",
"description": "Notification Email for chargebacks."
},
"tcAttestation": {
"allOf": [
{
"$ref": "#/$defs/merchantsTcAttestation"
},
{
"description": "Whether or not the merchant has acknowledged and accepted the Terms and Conditions.\n\n\nValid Values
\n\n- `0` - **Not Accepted**\n- `1` - **Accepted**\n\n "
}
]
},
"applePayActive": {
"allOf": [
{
"$ref": "#/$defs/merchantsApplePayActive"
},
{
"description": "This field indicates if Apple Pay is active for this merchant.\n\n\nValid Values
\n\n- `0` - **Inactive**\n- `1` - **Active**\n\n "
}
]
},
"googlePayActive": {
"allOf": [
{
"$ref": "#/$defs/merchantsGooglePayActive"
},
{
"description": "This field indicates if Google Pay is active for this merchant.\n\n\nValid Values
\n\n- `0` - **Inactive**\n- `1` - **Active**\n\n "
}
]
},
"naics": {
"allOf": [
{
"$ref": "#/$defs/merchantsNaics"
},
{
"description": "The NAICS sector code that accurately describes the industry the business operates in.\n\nFor more information, see the [NAICS Manual provided by the US Census Bureau's North American Industry Classification System.](https://www.census.gov/naics/reference_files_tools/2022_NAICS_Manual.pdf)\n\n\nValid Values
\n\n- `11` - **Agriculture, Forestry, Fishing and Hunting**\n- `21` - **Mining, Quarrying, and Oil and Gas Extraction**\n- `22` - **Utilities**\n- `23` - **Construction**\n- `31` / `33` - **Manufacturing**\n- `41` - **Wholesale Trade**\n- `44` / `45` - **Retail Trade**\n- `48` / `49` - **Transportation and Warehousing**\n- `51` - **Information**\n- `52` - **Finance and Insurance**\n- `53` - **Real Estate and Property Rental / Leasing**\n- `54` - **Professional, Scientific, and Technical Services**\n- `55` - **Management of Companies and Enterprises**\n- `56` - **Administrative and Support and Waste Management and Remediation Services**\n- `61` - **Educational Services**\n- `62` - **Health Care and Social Assistance**\n- `71` - **Arts, Entertainment, and Recreation**\n- `72` - **Accommodation and Food Services**\n- `81` - **Other Services (except Public Administration)**\n- `91` / `92` - **Public Administration**\n\n "
}
]
},
"naicsDescription": {
"type": "string",
"description": "The NAICS sector description matching the above NAICS sector code. If \"Other\", industry description is prefixed with \"Other: \"."
},
"tmxSessionId": {
"type": "string",
"description": "Transaction Session Id."
},
"passTokenEnabled": {
"allOf": [
{
"$ref": "#/$defs/merchantsPassTokenEnabled"
},
{
"description": "This field indicates if Pass Token is enabled for this merchant.\n\n\nValid Values
\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n "
}
]
},
"expressBatchCloseMethod": {
"allOf": [
{
"$ref": "#/$defs/merchantsExpressBatchCloseMethod"
},
{
"description": "This field indicates the batch close method for this merchant applicable to Express platform.\n\n\nValid Values
\n\n- `TimeInitiated` - **Batch close occurs at specific time intervals (Automated).**\n- `MerchantInitiated` - **Batch close occurs when initiated by the Merchant (Manual).**\n\n "
}
]
},
"expressBatchCloseTime": {
"type": "string",
"description": "This field indicates the batch close time for this merchant applicable to Express platform."
},
"omniTokenEnabled": {
"allOf": [
{
"$ref": "#/$defs/merchantsOmniTokenEnabled"
},
{
"description": "This field indicates if Omni Token is enabled for this merchant.\n\n\nValid Values
\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"batches": {
"type": "array",
"items": {
"$ref": "#/$defs/batchesPostRequest"
},
"description": ""
},
"customers": {
"type": "array",
"items": {
"$ref": "#/$defs/customersPostRequest"
},
"description": ""
},
"members": {
"type": "array",
"items": {
"$ref": "#/$defs/membersPostRequest"
},
"description": ""
},
"plans": {
"type": "array",
"items": {
"$ref": "#/$defs/plansPostRequest"
},
"description": ""
},
"terminals": {
"type": "array",
"items": {
"$ref": "#/$defs/terminalsPostRequest"
},
"description": ""
}
}
},
"merchantsPostRequestModelEntity": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/entitiesPostRequest"
},
{}
]
}
],
"description": "The Entity associated with this Merchant."
},
"merchantsSaqType": {
"title": "merchantsSaqType",
"enum": [
"SAQ-A",
"SAQ-A-EP",
"SAQ-B",
"SAQ-B-IP",
"SAQ-C-VT",
"SAQ-C",
"SAQ-P2PE-HW",
"SAQ-D"
],
"type": "string"
},
"merchantsSeasonal": {
"title": "merchantsSeasonal",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsTcAttestation": {
"title": "merchantsTcAttestation",
"enum": [
0,
1
],
"type": "integer"
},
"merchantsVisaDisclosureIP": {
"title": "merchantsVisaDisclosureIP",
"enum": [
0,
1
],
"type": "integer"
},
"messageThreadsPostRequest": {
"title": "messageThreadsPostRequest",
"required": [
"login",
"sender",
"recipient",
"subject"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login that owns this messageThreads resource."
},
"forlogin": {
"type": "string",
"description": "The identifier of the receiving Login of this messageThreads resource."
},
"hold": {
"type": "string",
"description": "The identifier of the Hold that is related to this messageThread."
},
"entityReturn": {
"type": "string",
"description": "This field has the ID from the EntityReturns table that hold ACH returns for disbursements or eCheck txns."
},
"opposingMessageThread": {
"type": "string",
"description": "Specifies whether this is the opposing MessageThread."
},
"folder": {
"type": "string",
"description": "Free-form text. By default, a messageThread resource is set as 'default'.",
"default": "default"
},
"sender": {
"type": "string",
"description": "Free-form text that represents the name of the sender of a messageThread resource."
},
"recipient": {
"type": "string",
"description": "Free-form text that represents the name of the recipient of a messageThread resource."
},
"subject": {
"type": "string",
"description": "Free-form text for adding a subject to a messageThread resource."
},
"messages": {
"type": "array",
"items": {
"$ref": "#/$defs/messagesPostRequest"
},
"description": ""
}
}
},
"messagesPostRequest": {
"title": "messagesPostRequest",
"required": [
"messageThread",
"read",
"message"
],
"type": "object",
"properties": {
"messageThread": {
"type": "string",
"description": "The identifier of the messageThreads that owns this Messages resource."
},
"secure": {
"allOf": [
{
"$ref": "#/$defs/messagesSecure"
},
{
"description": "Whether this resource is marked as secure.\n\n\nValid Values
\n\n- `0` - **Messages will protected in email notifications.** \n\n- `1` - **Message will display entirely.**\n\n "
}
]
},
"read": {
"allOf": [
{
"$ref": "#/$defs/messagesRead"
},
{
"description": "Whether this resource is marked as read.\n\n\nValid Values
\n\n- `0` - **Message has not been read yet.**\n\n- `1` - **Message has been read and a value.** \n\n "
}
]
},
"message": {
"type": "string",
"description": "Free-form text for adding a message to a messageThread resource."
}
}
},
"messagesRead": {
"title": "messagesRead",
"enum": [
0,
1
],
"type": "integer"
},
"messagesSecure": {
"title": "messagesSecure",
"enum": [
0,
1
],
"type": "integer"
},
"minPasswordComplexity": {
"title": "minPasswordComplexity",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"noteDocumentStatus": {
"title": "noteDocumentStatus",
"enum": [
"created",
"processed",
"failed"
],
"type": "string"
},
"noteDocumentType": {
"title": "noteDocumentType",
"enum": [
"jpg",
"jpeg",
"gif",
"png",
"pdf",
"tif",
"tiff",
"txt",
"xml",
"asc",
"rtf",
"csv",
"xls",
"doc",
"odt",
"ods",
"json",
"soap"
],
"type": "string"
},
"noteDocumentsDocumentType": {
"title": "noteDocumentsDocumentType",
"enum": [
"general",
"personalId",
"companyId",
"voidCheck",
"bankStatement",
"bankLetter",
"contract",
"taxDocument"
],
"type": "string"
},
"noteDocumentsPostRequest": {
"title": "noteDocumentsPostRequest",
"required": [
"note"
],
"type": "object",
"properties": {
"note": {
"type": "string",
"description": "The identifier of the Note that owns this note documents resource."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/noteDocumentType"
},
{
"description": "The desired type to take on the referenced Note.\n\n\nValid Values
\n\n- `jpg` - **JPG Image File Type**\n- `jpeg` - **JPEG Image File Type**\n- `gif` - **GIF Image File Type**\n- `png` - **PNG Image File Type**\n- `pdf` - **PDF Document File Type**\n- `tif` - **TIF Tag Image File Type**\n- `tiff` - **TIFF Tag Image File Type**\n- `txt` - **TXT Document File Type**\n- `xml` - **XML Document File Type**\n- `asc` - **American Standard Code II File Type**\n- `rtf` - **Rich Text Document File Type**\n- `csv` - **Comma Separated Values Table File Type**\n- `xls` - **Microsoft Excel File Type**\n- `doc` - **Microsoft Word File Type**\n- `odt` - **OpenDocument Text File Type**\n- `ods` - **OpenDocument Spreadsheet File Type**\n- `json` - **JSON Document File Type**\n- `soap` - **SOAP Document File Type**\n\n "
}
]
},
"name": {
"type": "string",
"description": "The name of the document on the referenced NoteDocument."
},
"custom": {
"type": "string",
"description": "The identifier of the Custom that relates to this notes resource."
},
"description": {
"type": "string",
"description": "A brief description of the document."
},
"status": {
"allOf": [
{
"$ref": "#/$defs/noteDocumentStatus"
},
{
"description": "The current status of the document upload.\n\n\nValid Values
\n\n- `created` - **The database record has been created.**\n- `processed` - **The document upload for this record was processed successfully.**\n- `failed` - **The document upload for this record could not be processed.**\n\n "
}
]
},
"documentType": {
"allOf": [
{
"$ref": "#/$defs/noteDocumentsDocumentType"
},
{
"description": "The purpose of the document upload.\n\n\nValid Values
\n\n- `general` - **General use for unspecified type.**\n- `personalId` - **An identification document for a person.**\n- `companyId` - **An identification document for a company.**\n- `voidCheck` - **A voided check for bank account verification.**\n- `bankStatement` - **A bank statement.**\n- `bankLetter` - **A bank letter for verification.**\n- `contract` - **A contract for goods or services.**\n- `taxDocument` - **A tax document for verification.**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"noteType": {
"title": "noteType",
"enum": [
"note",
"release",
"review",
"reReview",
"amexSales",
"businessSales",
"consumerSales",
"deliverySchedule",
"immediateDeliveryPercent",
"sevenDayDeliveryPercent",
"fourteenDayDeliveryPercent",
"thirtyDayDeliveryPercent",
"cardPresentSales",
"motoSales",
"ecommerceSales",
"siteVisit",
"goodsSold",
"authorizationFlatFee",
"capturePercentFee",
"captureFlatFee",
"riskApproved",
"riskPending",
"riskCancelled",
"riskDenied",
"riskClosed",
"riskInvestigation",
"riskPendingData",
"riskFundsReleased",
"riskActivityApproved"
],
"type": "string"
},
"notesPostRequest": {
"title": "notesPostRequest",
"required": [
"type"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login that owns this notes resource."
},
"txn": {
"type": "string",
"description": "The identifier of the Txn that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set."
},
"terminalTxn": {
"type": "string",
"description": "The identifier of the TerminalTxn that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set."
},
"hold": {
"type": "string",
"description": "The identifier of the Hold that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that relates to this notes resource, Only one of txn, hold, entity, terminalTxn may be set."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/noteType"
},
{
"description": "The desired type to take on the referenced Note.\n\n\nValid Values
\n\n- `note` - **Just add a note to the hold.**\n- `release` - **Release the hold for this Hold.**\n- `review` - **Mark the hold as having been reviewed.**\n- `reReview` - **If the hold was marked as reviewed, this will allow resetting the review.**\n- `amexSales` - **If the entity does sales with amex.**\n- `businessSales` - **If the entity does business direct sales.**\n- `consumerSales` - **If the entity does consumer direct sales.**\n- `deliverySchedule` - **The delivery schedule of the entity.**\n- `immediateDeliveryPercent` - **The amount of immediate deliveries with 0 day after the transaction.**\n- `sevenDayDeliveryPercent` - **The amount of deliveries between 1-7 days after the transaction.**\n- `fourteenDayDeliveryPercent` - **The amount of deliveries between 8-14 days after the transaction.**\n- `thirtyDayDeliveryPercent` - **The amount of deliveries between 15-30 days after the transaction.**\n- `cardPresentSales` - **If the entity does sales with card present.**\n- `motoSales` - **If the entity does sales over the phone or mail.**\n- `ecommerceSales` - **If the entity does ecommerce sales.**\n- `siteVisit` - **If the entity had the site visit.**\n- `goodsSold` - **The type of goods the entity sales.**\n- `authorizationFlatFee` - **The flat fee agreement for each authorization.**\n- `capturePercentFee` - **The percentage fee agreement for each capture.**\n- `captureFlatFee` - **The flat fee agreement for each capture.**\n- `riskApproved` - **The entity was approved.**\n- `riskPending` - **The entity is in pending status.**\n- `riskCancelled` - **The entity has a cancelled status.**\n- `riskDenied` - **The entity has a denied status.**\n- `riskClosed` - **The entity has a closed status.**\n- `riskInvestigation` - **The entity is in investigation status.**\n- `riskPendingData` - **Pending Docs/Info for The entity.**\n- `riskFundsReleased` - **Funds released for The entity.**\n- `riskActivityApproved` - **Activity approved for the entity.**\n\n "
}
]
},
"data": {
"type": "string",
"description": "Free-form text for adding a message along with the type , \nrequired in case of type value is in one of these - amexSales, businessSales, consumerSales, deliverySchedule, immediateDeliveryPercent, sevenDayDeliveryPercent, fourteenDayDeliveryPercent, thirtyDayDeliveryPercent, cardPresentSales, motoSales, ecommerceSales, siteVisit, goodsSold, authorizationFlatFee, capturePercentFee, captureFlatFee\nelse null"
},
"note": {
"type": "string",
"description": "A Message/Note regarding this notes resource. This field is stored as a text string."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"noteDocuments": {
"type": "array",
"items": {
"$ref": "#/$defs/noteDocumentsPostRequest"
},
"description": ""
}
}
},
"omniTokensPostRequest": {
"title": "omniTokensPostRequest",
"type": "object",
"properties": {
"enablementDate": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The Date and time when an entity was enabled for omniTokens.\\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am."
},
"org": {
"type": "string",
"description": "The identifier of the Org (group) that omniTokens is associated to."
},
"division": {
"type": "string",
"description": "The identifier of the Division that omniTokens is associated to."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition that omniTokens is associated to."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this omniTokens is associated to."
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/platformModel"
},
{
"description": "The platform used to process this resource.\n\n\nValid Values
\n\n- `APPLE` - **The Apple Payment Processor.**\n- `ELAVON` - **The Elavon processor.**\n- `FIRSTDATA` - **The FirstData processor.**\n- `GOOGLE` - **The Google Payment Processor.**\n- `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n- `VCORE` - **The WorldPay (aka Vantiv) Core processor.**\n- `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**\n- `WELLSACH` - **The Wells Fargo ACH processor.**\n- `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**\n- `WFSINGLE` - **The WFSINGLE processor.**\n- `WORLDPAY` - **The WORLDPAY processor.**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"deleted": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The date and time at which this resource was deleted.\\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am."
},
"deleter": {
"type": "string",
"description": "The id of user who deleted the omniToken."
}
}
},
"orgEntitiesPostRequest": {
"title": "orgEntitiesPostRequest",
"required": [
"org",
"entity"
],
"type": "object",
"properties": {
"org": {
"allOf": [
{
"$ref": "#/$defs/orgEntitiesPostRequestModelOrg"
},
{
"description": "The identifier of the Org that this orgEntity is associated with."
}
]
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this orgEntity is associated with."
}
}
},
"orgEntitiesPostRequestModelOrg": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/orgsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Org that this orgEntity is associated with."
},
"orgFlowAction": {
"title": "orgFlowAction",
"enum": [
"add",
"remove"
],
"type": "string"
},
"orgFlowActionsPostRequest": {
"title": "orgFlowActionsPostRequest",
"required": [
"orgFlow",
"org",
"action"
],
"type": "object",
"properties": {
"orgFlow": {
"type": "string",
"description": "The identifier of the orgFlow resource that this orgFlowActions resource is associated with."
},
"org": {
"allOf": [
{
"$ref": "#/$defs/orgFlowActionsPostRequestModelOrg"
},
{
"description": "The identifier of the OrgFlow resource that this orgFlowActions resource is associated with."
}
]
},
"action": {
"allOf": [
{
"$ref": "#/$defs/orgFlowAction"
},
{
"description": "The action to take in relation to the Entity being processed.\n\n\nValid Values
\n\n - `add` - **Add the referenced Entity to the referenced Org.**\n - `remove` - **Remove the referenced Entity from the referenced Org.**\n\n "
}
]
}
}
},
"orgFlowActionsPostRequestModelOrg": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/orgsPostRequest"
},
{}
]
}
],
"description": "The identifier of the OrgFlow resource that this orgFlowActions resource is associated with."
},
"orgFlowRulesPostRequest": {
"title": "orgFlowRulesPostRequest",
"type": "object",
"properties": {
"orgFlow": {
"allOf": [
{
"$ref": "#/$defs/orgFlowRulesPostRequestModelOrgFlow"
},
{
"description": "The identifier of the orgFlow resource that this orgFlowActions resource is associated with."
}
]
},
"name": {
"type": "string",
"description": "The name of the orgFlowRules resource."
},
"description": {
"type": "string",
"description": "The description of the orgFlowRules resource."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/orgFlowRulesType"
},
{
"description": "The type of logic to apply with this OrgFlow Rule.\n\n\nValid Values
\n\n- `MCC` - **Type MCC.** The Orgflow applies based on the MCC properties of the merchants.\n- `Custom` - **Type Custom.** The Orgflow applies based on the custom properties of the entities.\n\n "
}
]
},
"value": {
"type": "string",
"description": "The value to compare against when evaluating this OrgFlowRule."
},
"grouping": {
"type": "string",
"description": "A name for a group of rules to be applied in conjunction when evaluating this OrgFlow Rule. \\nWhen grouping is used the OrgFlow will be allowed to be processed if at least one of the rules are matched."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"orgFlowRulesPostRequestModelOrgFlow": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/orgFlowsPostRequest"
},
{}
]
}
],
"description": "The identifier of the orgFlow resource that this orgFlowActions resource is associated with."
},
"orgFlowRulesType": {
"title": "orgFlowRulesType",
"enum": [
"MCC",
"Custom"
],
"type": "string"
},
"orgFlowTrigger": {
"title": "orgFlowTrigger",
"enum": [
"create",
"low",
"high",
"board"
],
"type": "string"
},
"orgFlowsPostRequest": {
"title": "orgFlowsPostRequest",
"required": [
"trigger"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"forlogin": {
"type": "string",
"description": "The identifier of the Login resource for which this orgFlows resource is triggered."
},
"team": {
"type": "string",
"description": "The identifier of the Team resource for which this orgFlows resource is triggered."
},
"division": {
"type": "string",
"description": "The identified of the Division resource for which this orgFlows resource is triggered."
},
"trigger": {
"allOf": [
{
"$ref": "#/$defs/orgFlowTrigger"
},
{
"description": "This field sets the trigger that determines when this orgFlow runs.\n\nValid Values
\n- `create` - **Entity creation.**\n- `low` - **Entity verification through decisions hits a configured low score.**\n- `high` - **Entity verification through decisions hits a configured high score.**\n- `board` - **Merchant boarding.**\n "
}
]
},
"partition": {
"type": "string",
"description": "The identified of the Partition resource for which this orgFlows resource is triggered."
},
"orgFlowActions": {
"type": "array",
"items": {
"$ref": "#/$defs/orgFlowActionsPostRequest"
},
"description": ""
},
"orgFlowRules": {
"type": "array",
"items": {
"$ref": "#/$defs/orgFlowRulesPostRequest"
},
"description": ""
}
}
},
"orgsPostRequest": {
"title": "orgsPostRequest",
"type": "object",
"properties": {
"login": {
"type": [
"string",
"null"
],
"description": "The Login that owns this Org."
},
"name": {
"type": "string",
"description": "The name of this Org. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Org. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"billings": {
"type": "array",
"items": {
"$ref": "#/$defs/billingsPostRequest"
},
"description": ""
},
"feeModifiers": {
"type": "array",
"items": {
"$ref": "#/$defs/feeModifiersPostRequest"
},
"description": ""
},
"fees": {
"type": "array",
"items": {
"$ref": "#/$defs/feesPostRequest"
},
"description": ""
},
"invoiceParameters": {
"type": "array",
"items": {
"$ref": "#/$defs/invoiceParametersPostRequest"
},
"description": ""
},
"orgEntities": {
"type": "array",
"items": {
"$ref": "#/$defs/orgEntitiesPostRequest"
},
"description": ""
},
"payoutFlows": {
"type": "array",
"items": {
"$ref": "#/$defs/payoutFlowsPostRequest"
},
"description": ""
},
"profitShares": {
"type": "array",
"items": {
"$ref": "#/$defs/profitSharesPostRequest"
},
"description": ""
},
"reserves": {
"type": "array",
"items": {
"$ref": "#/$defs/reservesPostRequest"
},
"description": ""
},
"secrets": {
"type": "array",
"items": {
"$ref": "#/$defs/secretsPostRequest"
},
"description": ""
}
}
},
"paymentMethod": {
"title": "paymentMethod",
"enum": [
0,
1,
2,
3,
4,
5,
7,
8,
9,
10,
11,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27
],
"type": "integer"
},
"paymentPostRequest": {
"title": "paymentPostRequest",
"type": "object",
"properties": {
"method": {
"allOf": [
{
"$ref": "#/$defs/paymentMethod"
},
{
"description": "The payment method for this Transaction."
}
]
},
"number": {
"type": "string",
"description": "For credit payment method, the card number of the credit card associated with this Transaction.\nFor eCheck payment method, the bank account number associated with this Transaction."
},
"last4": {
"type": "string"
},
"routing": {
"type": "string",
"description": "The routing code for the eCheck or bank account payment associated with this Transaction."
},
"bin": {
"type": "string"
},
"payment": {
"type": [
"string",
"null"
]
},
"lastChecked": {
"type": [
"integer",
"null"
],
"description": "Times timestamp with last time payment was checked.",
"contentEncoding": "int32"
},
"mask": {
"type": [
"string",
"null"
]
},
"plaidConsumerAccount": {
"type": [
"string",
"null"
]
}
}
},
"payoutFlowSchedule": {
"title": "payoutFlowSchedule",
"enum": [
"days",
"weeks",
"months",
"years",
"single"
],
"type": "string"
},
"payoutFlowTrigger": {
"title": "payoutFlowTrigger",
"enum": [
"accountCreate",
"board"
],
"type": "string"
},
"payoutFlowUm": {
"title": "payoutFlowUm",
"enum": [
"percent",
"actual",
"percentneg"
],
"type": "string"
},
"payoutFlowsPostRequest": {
"title": "payoutFlowsPostRequest",
"required": [
"login",
"trigger"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"payoutLogin": {
"type": "string",
"description": "The Login that will own the Payout resource. When set to null, the Payout resource will be owned by the triggerring Entity."
},
"org": {
"type": "string",
"description": "The identifier of the Org that this payoutFlows resource applies to. \nIf you set this field, then the payoutFlow applies to all Entities in the Org."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this payoutFlow applies to."
},
"billing": {
"type": "string",
"description": "The identifier of a Billing that this PayoutFlow is associated with. \nThe Billing identifier will be carried over to Payouts created based on this PayoutFlow."
},
"trigger": {
"allOf": [
{
"$ref": "#/$defs/payoutFlowTrigger"
},
{
"description": "The event on the Org or Entity that should trigger the creation of an associated Payout resource.\n\n\nValid Values
\n\n- `accountCreate` - **Primary payment account creation.** (primary must be 1)\n- `board` - **Merchant boarding.**\n\n "
}
]
},
"schedule": {
"allOf": [
{
"$ref": "#/$defs/payoutFlowSchedule"
},
{
"description": "The schedule that determines when the Payout resource that is created should be triggered to be paid.\n\n\nValid Values
\n\n- `days` - **Daily.** The Payout is paid every day.\n- `weeks` - **Weekly.** The Payout is paid every week.\n- `months` - **Monthly.** The Payout is paid every month.\n- `years` - **Annually.** The Payout is paid every year.\n- `single` - **Single.** The Payout is a one-off payment.\n\n "
}
]
},
"scheduleFactor": {
"type": "integer",
"description": "A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. This affects the Payout resource that is created by this payoutFlow. This field is specified as an integer and its value determines how the interval is multiplied. \n\n\nValid Values
\n\n - `1` - **Subscription to trigger daily**.\n\n ",
"contentEncoding": "int32",
"default": 1
},
"start": {
"type": "integer",
"description": "The date on which payment of the Payout should start. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.",
"contentEncoding": "int32"
},
"um": {
"allOf": [
{
"$ref": "#/$defs/payoutFlowUm"
},
{
"description": "The unit of measure for this Payout is the percentage of funds. \nIf the Entity has a negative balance of $10 and the amount is set to 10000 (100%), \nthen $10 will be drawn from their account to fully replenish the balance to $0.\n\n\nValid Values
\n\n- `percent` - **Percentage unit measurement.** (Percentage of Funds).\n- `actual` - **Actual unit measurement.** (Exact Currency Amount).\n- `percentneg` - **Negative Percentage unit measurement.** (Replenish account by percent negative back to $0).\n\n "
}
]
},
"amount": {
"type": "integer",
"description": "The total amount of the Payout resource that is created. \nThe units used in this field are determined by the value of the 'um' field on the Payout. If the 'um' field is set to '1' or '3', then this field specifies the Payout percentage to levy in basis points. If the 'um' field is set to '2', then this field specifies the Payout in cents.",
"contentEncoding": "int64",
"default": 10000
},
"minimum": {
"type": "integer",
"description": "The minium amount of payout that will process.",
"contentEncoding": "int64"
},
"payoutInactive": {
"allOf": [
{
"$ref": "#/$defs/payoutInactive"
},
{
"description": "Whether the Payout resource will be marked as inactive.\n\n\nValid Values
\n\n- `0` - **Inactive**\n- `1` - **Active**\n\n "
}
]
},
"skipOffDays": {
"allOf": [
{
"$ref": "#/$defs/payoutFlowsSkipOffDays"
},
{
"description": "Whether the Payout resource will be marked to skip the creation of disbursements on holidays and weekends.\n\n\nValid Values
\n\n- `0` - **Do not skip Holidays and Weekends.** Disbursement will be generated in a Requested status and process the next business day.\n- `1` - **Skip Holidays and Weekends.** IMPORTANT: We do not advise setting this for weekly, monthly, or yearly Payout schedules as the disbursement will skip and not be generated until the next scheduled date.\n\n "
}
]
},
"secondaryDescriptor": {
"type": "string",
"description": "The secondary billing descriptor to appear on the bank statements in which entities will have automated payouts generated."
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The identifier of the currency that this PayoutFlow is associated with, or the currency for this statement if it's not set. See Currency codes for all valid values."
}
]
},
"sameDay": {
"allOf": [
{
"$ref": "#/$defs/payoutFlowsSameDay"
},
{
"description": "Whether the payout workflow allows for same day payouts.\n\n\nValid Values
\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"payoutFlowsSameDay": {
"title": "payoutFlowsSameDay",
"enum": [
0,
1
],
"type": "integer"
},
"payoutFlowsSkipOffDays": {
"title": "payoutFlowsSkipOffDays",
"enum": [
0,
1
],
"type": "integer"
},
"payoutInactive": {
"title": "payoutInactive",
"enum": [
0,
1
],
"type": "integer"
},
"payoutPostRequest": {
"title": "payoutPostRequest",
"required": [
"account",
"entity",
"schedule",
"start",
"um",
"amount",
"skipOffDays"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"account": {
"allOf": [
{
"$ref": "#/$defs/payoutsPostRequestModelAccount"
},
{
"description": "The token of the Account that this Payout is associated with. \nThis account will either receive the funds or be debited for the funds every time a Disbursement occurs, depending on the direction of the Disbursement."
}
]
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this Payout is associated with."
},
"billing": {
"type": "string",
"description": "The identifier of a Billing that this Payout is associated with. Payout associated with a Billing record will be used to pay for Statements."
},
"payoutFlow": {
"type": "string",
"description": "The identifier of the PayoutFlow associated with this Payout."
},
"name": {
"type": "string",
"description": "The name of this Payout. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Payout. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"schedule": {
"allOf": [
{
"$ref": "#/$defs/payoutSchedule"
},
{
"description": "The schedule that determines when the Payout resource that is created should be triggered to be paid.\n\n\nValid Values
\n\n- `1` - **Daily.** The Payout is paid every day.\n- `2` - **Weekly.** The Payout is paid every week.\n- `3` - **Monthly.** The Payout is paid every month.\n- `4` - **Annually.** The Payout is paid every year.\n- `5` - **Single.** The Payout is a one-off payment.\n\n "
}
]
},
"scheduleFactor": {
"type": "integer",
"description": "A multiplier that you can use to adjust the schedule set in the 'schedule' field, if it is set to a duration-based trigger, such as daily, weekly, monthly, or annually. \nThis field is specified as an integer and its value determines how the interval is multiplied.",
"contentEncoding": "int32",
"default": 1
},
"start": {
"type": "integer",
"description": "The date on which payment of the Payout should start. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. \nThe value of this field must represent a date in the future, or the present date.",
"contentEncoding": "int32"
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency of the amount in this Payout. \\nThis field is only required when Um is set to ACTUAL.\\nIf this field is not set we will process disbursements for all currencies. See Currency codes for all valid values."
}
]
},
"um": {
"allOf": [
{
"$ref": "#/$defs/payoutUm"
},
{
"description": "The unit of measure for this Payout is the percentage of funds. \nIf the Entity has a negative balance of $10 and the amount is set to 10000 (100%), \nthen $10 will be drawn from their account to fully replenish the balance to $0.\n\n\nValid Values
\n\n- `1` - **Percentage unit measurement.** (Percentage of Funds).\n- `2` - **Actual unit measurement.** (Exact Currency Amount).\n- `3` - **Negative Percentage unit measurement.** (Replenish account by percent negative back to $0).\n\n "
}
]
},
"amount": {
"type": "integer",
"description": "The total amount of this Payout. \nThe units used in this field are determined by the value of the 'um' field on the Payout. If the 'um' field is set to '1' or '3', then this field specifies the Payout percentage to levy in basis points. If the 'um' field is set to '2', then this field specifies the Payout in cents.",
"contentEncoding": "int64"
},
"minimum": {
"type": "integer",
"description": "The threshold that will ensure no disbursement is generated if it doesn't reach the minimum value.",
"contentEncoding": "int64"
},
"maximum": {
"type": "integer",
"description": "The maximum threshold for a disbursement. Any amount in a disbursement exceeding this value will not be released, and will roll over to the next disbursement.",
"contentEncoding": "int64"
},
"float": {
"type": "integer",
"description": "An optional field indicating the minimum balance you want to maintain, despite any Payouts occurring. If the Payout would reduce the balance to below this value, then it is not processed. \nThis field is specified as an integer in cents. \nFor example, a float value of 1000 would ensure that a balance of 10 USD is maintained at all times.",
"contentEncoding": "int64",
"default": 0
},
"secondaryDescriptor": {
"type": "string",
"description": "The secondary billing descriptor to appear on the bank statements for the payout."
},
"skipOffDays": {
"allOf": [
{
"$ref": "#/$defs/payoutFlowsSkipOffDays"
},
{
"description": "Whether the Payout resource will be marked to skip the creation of disbursements on holidays and weekends.\n\n\nValid Values
\n\n- `0` - **Do not skip Holidays and Weekends.** Disbursement will be generated in a Requested status and process the next business day.\n- `1` - **Skip Holidays and Weekends.** IMPORTANT: We do not advise setting this for weekly, monthly, or yearly Payout schedules as the disbursement will skip and not be generated until the next scheduled date.\n\n "
}
]
},
"sameDay": {
"allOf": [
{
"$ref": "#/$defs/payoutFlowsSameDay"
},
{
"description": "Whether the payout workflow allows for same day payouts.\n\n\nValid Values
\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"payoutSchedule": {
"title": "payoutSchedule",
"enum": [
1,
2,
3,
4,
5
],
"type": "integer"
},
"payoutUm": {
"title": "payoutUm",
"enum": [
1,
2,
3
],
"type": "integer"
},
"payoutsPostRequestModelAccount": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/accountsPostRequest"
},
{}
]
}
],
"description": "The token of the Account that this Payout is associated with. \nThis account will either receive the funds or be debited for the funds every time a Disbursement occurs, depending on the direction of the Disbursement."
},
"pinlessDebitConversionsPlatform": {
"title": "pinlessDebitConversionsPlatform",
"const": "VCORE",
"type": "string"
},
"pinlessDebitConversionsPostRequest": {
"title": "pinlessDebitConversionsPostRequest",
"type": "object",
"properties": {
"enablementDate": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The Date and time when an entity was enabled for pinlessDebitConversion.\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am."
},
"org": {
"type": "string",
"description": "The identifier of the Org (group) that pinlessDebitConversion is associated to."
},
"division": {
"type": "string",
"description": "The identifier of the Division that pinlessDebitConversion is associated to."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition that pinlessDebitConversion is associated to."
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/pinlessDebitConversionsPlatform"
},
{
"description": "The platform used to process this transaction."
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"deleted": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "In case resource is deleted, this field will then show the date it occurred."
},
"deleter": {
"type": "string",
"description": "The id of user who deleted the pinlessDebitConversion."
}
}
},
"planSchedule": {
"title": "planSchedule",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"planType": {
"title": "planType",
"enum": [
"recurring",
"installment"
],
"type": "string"
},
"planUm": {
"title": "planUm",
"enum": [
"actual",
"percent"
],
"type": "string"
},
"plansPostRequest": {
"title": "plansPostRequest",
"required": [
"amount",
"merchant",
"schedule"
],
"type": "object",
"properties": {
"amount": {
"type": "integer",
"description": "The amount to charge with each payment under this Plan, specified as an integer in cents.",
"contentEncoding": "int64"
},
"billing": {
"type": "string",
"description": "The attached billing for which recurring payments should be made to pay off statements."
},
"order": {
"type": "string",
"description": "The order of the Txn that will be created through this Plan."
},
"txnDescription": {
"type": "string",
"description": "The description of the Txn that will be created through this Plan."
},
"description": {
"type": "string",
"description": "A description of this Plan. This field is stored as a text string and must be between 0 and 100 characters long."
},
"maxFailures": {
"type": "integer",
"description": "The maximum consecutive amount of payment failures to allow for a subscription before inactivating it.",
"contentEncoding": "int32"
},
"merchant": {
"type": "string",
"description": "The identifier of the Merchant associated with this Plan."
},
"name": {
"type": "string",
"description": "The name of this Plan. This field is stored as a text string and must be between 0 and 100 characters long."
},
"schedule": {
"allOf": [
{
"$ref": "#/$defs/planSchedule"
},
{
"description": "The schedule that determines when the subscription related to this Plan is triggered.\n\n\nValid Values
\n\n- `1` - **Daily**\n- `2` - **Weekly**\n- `3` - **Monthly**\n- `4` - **Annually**\n\n "
}
]
},
"scheduleFactor": {
"type": "integer",
"description": "A multiplier that you can use to adjust the schedule set in the 'schedule' field, such as daily, weekly, monthly, or annually. In this field is specified as an integer and its value determines how the interval is multiplied.",
"contentEncoding": "int32",
"default": 0
},
"um": {
"allOf": [
{
"$ref": "#/$defs/planUm"
},
{
"description": "The unit of measure for the amount on the plan.\n\n\nValid Values
\n\n- `actual` - **An actual amount to charge, in cents.**\n- `percent` - **A percentage of another amount, in basis points.**\n\n "
}
]
},
"type": {
"allOf": [
{
"$ref": "#/$defs/planType"
},
{
"description": "The type of plan.\n\n\nValid Values
\n\n- `recurring` - **A recurring payment plan (subcription).**\n\n- `installment` - **A deferred payment installment plan.** \n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/$defs/subscriptionsPostRequest"
},
"description": ""
}
}
},
"platformModel": {
"title": "platformModel",
"enum": [
"APPLE",
"ELAVON",
"FIRSTDATA",
"GOOGLE",
"VANTIV",
"VCORE",
"TDBANKCA",
"WELLSACH",
"WELLSFARGO",
"WFSINGLE",
"WORLDPAY"
],
"type": "string"
},
"profitShareRuleType": {
"title": "profitShareRuleType",
"enum": [
"less",
"equal",
"notEqual",
"greater",
"event",
"notEvent",
"fee",
"notFee",
"fromentity",
"notFromentity"
],
"type": "string"
},
"profitShareRulesPostRequest": {
"title": "profitShareRulesPostRequest",
"required": [
"profitShare",
"type",
"value"
],
"type": "object",
"properties": {
"profitShare": {
"allOf": [
{
"$ref": "#/$defs/profitShareRulesPostRequestModelProfitShare"
},
{
"description": "The identifier of the ProfitShare that this ProfitShare Rule applies to."
}
]
},
"name": {
"type": "string",
"description": "The name of this ProfitShare Rule. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "Description of the Profit Share Rules."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/profitShareRuleType"
},
{
"description": "The type of logic to apply with this ProfitShare Rule.\n\n\nValid Values
\n\n- `less` - **The ProfitShare applies only if the entry amount is lower than the amount set in the 'value' field of the ProfitShare Rule.**\n- `equal` - **The ProfitShare applies only if the entry amount is exactly the same as the amount set in the 'value' field of the ProfitShare Rule.**\n- `notEqual` - **The ProfitShare applies only if the entry amount is not exactly equal to the amount set in the 'value' field of the ProfitShare Rule.**\n- `greater` - **The ProfitShare applies only if the entry amount is higher than the amount set in the 'value' field of the ProfitShare Rule.**\n- `event` - **The ProfitShare applies only if the entry event is exactly the same as the event set in the 'value' field of the ProfitShare Rule.**\n- `notEvent` - **The ProfitShare applies only if the entry event is not exactly equal to the event set in the 'value' field of the ProfitShare Rule.**\n- `fee` - **The ProfitShare applies only if the entry fee is exactly the same as the fee set in the 'value' field of the ProfitShare Rule.**\n- `notFee` - **The ProfitShare applies only if the entry fee is not exactly equal to the fee set in the 'value' field of the ProfitShare Rule.**\n- `fromentity` - **The ProfitShare applies only if the entry fromentity (or opposingEntryfromentity) is exactly the same as the entity set in the 'value' field of the ProfitShare Rule.**\n- `notFromentity` - **The ProfitShare applies only if the entry fromentity (or opposingEntryfromentity) is not exactly equal to the entity set in the 'value' field of the ProfitShare Rule.**\n\n "
}
]
},
"value": {
"type": "string",
"description": "The value to compare against when evaluating this ProfitShare Rule."
},
"grouping": {
"type": "string",
"description": "A name for a group of rules to be applied in conjunction when evaluating this ProfitShare Rule. \nWhen grouping is used the ProfitShare will be allowed to be processed if at least one of the rules are matched."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"profitShareRulesPostRequestModelProfitShare": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/profitSharesPostRequest"
},
{}
]
}
],
"description": "The identifier of the ProfitShare that this ProfitShare Rule applies to."
},
"profitShareType": {
"title": "profitShareType",
"enum": [
"income",
"expense",
"both"
],
"type": "string"
},
"profitSharesPostRequest": {
"title": "profitSharesPostRequest",
"required": [
"login",
"entity",
"type",
"amount"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login that owns this ProfitShare."
},
"entity": {
"allOf": [
{
"$ref": "#/$defs/profitSharesPostRequestModelEntity"
},
{
"description": "The identifier of the Entity that this ProfitShare refers to. This is the entity that will receive the split income/expense."
}
]
},
"forentity": {
"allOf": [
{
"$ref": "#/$defs/profitSharesPostRequestModelForentity"
},
{
"description": "The identifier of the Entity that will have it's earnings/expenses shared."
}
]
},
"org": {
"allOf": [
{
"$ref": "#/$defs/profitSharesPostRequestModelOrg"
},
{
"description": "The identifier of the Org in which entities will have their earnings/expenses shares."
}
]
},
"division": {
"type": "string",
"description": "The identifier of the Division in which entities will have their earnings/expenses shares."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition in which entities will have their earnings/expenses shares."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/profitShareType"
},
{
"description": "Indicates if the Profit Share should be processed when there is an income, expense, or both.\n\n\nValid Values
\n\n- `income` - **Profit Share processing for income-only.**\n- `expense` - **Profit Share processing for expense-only.**\n- `both` - **Profit Share processing for both income and expense.**\n\n "
}
]
},
"name": {
"type": "string",
"description": "The name of this ProfitShare. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this ProfitShare. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"amount": {
"type": "integer",
"description": "The percentage to be shared. \nThis field is specified as an integer between 1 and 10000. \n Percentages are calculated over the income/expense amount.",
"contentEncoding": "int32"
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"profitShareRules": {
"type": "array",
"items": {
"$ref": "#/$defs/profitShareRulesPostRequest"
},
"description": ""
}
}
},
"profitSharesPostRequestModelEntity": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/entitiesPostRequest"
},
{}
]
}
],
"description": "The identifier of the Entity that this ProfitShare refers to. This is the entity that will receive the split income/expense."
},
"profitSharesPostRequestModelForentity": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/entitiesPostRequest"
},
{}
]
}
],
"description": "The identifier of the Entity that will have it's earnings/expenses shared."
},
"profitSharesPostRequestModelOrg": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/orgsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Org in which entities will have their earnings/expenses shares."
},
"reservesLevel": {
"title": "reservesLevel",
"enum": [
"admin",
"division",
"merchant",
"partition"
],
"type": "string"
},
"reservesPostRequest": {
"title": "reservesPostRequest",
"required": [
"login",
"percent"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"org": {
"allOf": [
{
"$ref": "#/$defs/reservesPostRequestModelOrg"
},
{
"description": "The identifier of the Org that this Reserve's resource applies to. If you set this field, then the Reserve applies to all Entities in the Org."
}
]
},
"division": {
"type": "string",
"description": "The division on which this reserve applies."
},
"partition": {
"type": "string",
"description": "The partition on which this reserve applies."
},
"level": {
"allOf": [
{
"$ref": "#/$defs/reservesLevel"
},
{
"description": "The hierarchical level for this reserve setting.\n\n\nValid Values
\n\n- `admin` - **Admin User.**\n- `division` - **Division-level User.**\n- `merchant` - **Merchant-level User.**\n- `partition` - **Partition-level User.**\n\n "
}
]
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this Reserve applies to."
},
"hold": {
"type": "string",
"description": "The entity hold from which this reserve was generated."
},
"name": {
"type": "string",
"description": "The name of this Reserve. This field is stored as a text string and must be between 1 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Reserve. This field is stored as a text string and must be between 0 and 100 characters long."
},
"percent": {
"type": "integer",
"description": "The percentage of funds to reserve, expressed in basis points. For example, 25.3% is expressed as '2530'.",
"contentEncoding": "int32"
},
"release": {
"allOf": [
{
"$ref": "#/$defs/reservesRelease"
},
{
"description": "The schedule that determines when the funds in this Reserve should be released, which can have valid values such as never, days, weeks, months, or years.\n\n\nValid Values
\n\n- `never` - **Never.**\n- `days` - **Daily. The funds are released every day.**\n- `weeks` - **Weekly. The funds are released every week.**\n- `months` - **Monthly. The funds are released every month.**\n- `years` - **Annually. The funds are released every year.**\n\n "
}
]
},
"releaseFactor": {
"type": "integer",
"description": "A multiplier that you can use to adjust the schedule set in the 'release' field, which is specified as an integer and its value determines how the schedule is multiplied.",
"contentEncoding": "int32",
"default": 1
},
"start": {
"type": "integer",
"description": "The date on which this Reserve resource should start reserving funds from the Entity or Org. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.",
"contentEncoding": "int32"
},
"finish": {
"type": "integer",
"description": "The date on which this Reserve resource should stop reserving funds from the Entity or Org. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.",
"contentEncoding": "int32"
},
"max": {
"type": "integer",
"description": "The maximum amount to reserve.",
"contentEncoding": "int64"
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"reservesPostRequestModelOrg": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/orgsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Org that this Reserve's resource applies to. If you set this field, then the Reserve applies to all Entities in the Org."
},
"reservesRelease": {
"title": "reservesRelease",
"enum": [
"never",
"days",
"weeks",
"months",
"years"
],
"type": "string"
},
"resource": {
"title": "resource",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
117,
118,
119,
120,
121,
122,
123,
124,
125,
126,
127,
128,
129,
130,
131,
132,
133,
134,
135,
136,
137,
138,
139,
140,
141,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
156,
157,
158,
159,
160,
161,
162,
163,
165,
166,
167,
168,
169,
170,
171,
172
],
"type": "integer"
},
"revenueBoostsPlatform": {
"title": "revenueBoostsPlatform",
"const": "VCORE",
"type": "string"
},
"revenueBoostsPostRequest": {
"title": "revenueBoostsPostRequest",
"required": [
"entity"
],
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The identifier of the Entity that networkPaymentManager is associated with."
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/revenueBoostsPlatform"
},
{
"description": "The platform used to process this transaction.\nValid Values : - `VCORE` - **VCORE**"
}
]
},
"org": {
"type": "string",
"description": "The identifier of the Org (group) that networkPaymentManager is associated with."
},
"division": {
"type": "string",
"description": "The identifier of the Division that networkPaymentManager is associated with."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition that networkPaymentManager is associated with."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
},
"description": "A request body for creating new networkPaymentManager"
},
"saferPaymentNonComplianceFeeManagedModel": {
"title": "saferPaymentNonComplianceFeeManagedModel",
"enum": [
0,
1
],
"type": "integer"
},
"saferPaymentPciNonValidationFeeEnabled": {
"title": "saferPaymentPciNonValidationFeeEnabled",
"enum": [
0,
1
],
"type": "integer"
},
"saferPaymentProgram": {
"title": "saferPaymentProgram",
"enum": [
"basic",
"managed"
],
"type": "string"
},
"saferPaymentStatus": {
"title": "saferPaymentStatus",
"enum": [
"compliance",
"non-compliance",
"pending"
],
"type": "string"
},
"saferPaymentsPostRequest": {
"title": "saferPaymentsPostRequest",
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The identifier of the Entity that saferPayments is associated to."
},
"status": {
"allOf": [
{
"$ref": "#/$defs/saferPaymentStatus"
},
{
"description": "This field indicates the entity's current PCI compliance status for the service.\n\n\nValid Values
\n\n- `compliance` - **Compliance**\n- `non-compliance` - **Non-Compliance**\n- `pending` - **Pending**\n\n "
}
]
},
"enablementDate": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The Date and time when an entity was enabled for saferPayments.\\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am."
},
"pciNonValidationFeeEnabled": {
"allOf": [
{
"$ref": "#/$defs/saferPaymentPciNonValidationFeeEnabled"
},
{
"description": "This field indicates if the entity should be charged penalty fees for non-compliance.\n\n\nValid Values
\n\n- `0` - **Penalty Disabled.**\n- `1` - **Penalty Enabled.**\n\n "
}
]
},
"org": {
"type": "string",
"description": "The identifier of the Org (group) that saferPayments is associated to."
},
"division": {
"type": "string",
"description": "The identifier of the Division that saferPayments is associated to."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition that saferPayments is associated to."
},
"program": {
"allOf": [
{
"$ref": "#/$defs/saferPaymentProgram"
},
{
"description": "This field contains the program type of the saferPayments.\n\n\nValid Values
\n\n- `basic` - **Basic**\n- `managed` - **Managed**\n\n "
}
]
},
"deleted": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The date and time at which this resource was deleted.\\nThe date is specified as an eight digit string in YYYY-MM-DD hh:mm:ss format, for example, '2023-06-01 01:00:00' for June 01, 2023. 1:00 am."
},
"deleter": {
"type": "string",
"description": "The id of user who deleted the omniToken."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"secretLocked": {
"title": "secretLocked",
"enum": [
0,
1
],
"type": "integer"
},
"secretType": {
"title": "secretType",
"enum": [
"baseKey",
"sftp",
"publicKey",
"privateKey",
"ecPrivateKey",
"apikey",
"oldPrivateKey"
],
"type": "string"
},
"secretsPlatform": {
"title": "secretsPlatform",
"enum": [
"APPLE",
"ELAVON",
"FIRSTDATA",
"GOOGLE",
"VANTIV",
"VCORE",
"WELLSACH",
"WELLSFARGO",
"WFSINGLE",
"WORLDPAY",
"TDBANKCA"
],
"type": "string"
},
"secretsPostRequest": {
"title": "secretsPostRequest",
"required": [
"login",
"type",
"key"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login that owns this secret resource."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity associated with this secret."
},
"org": {
"allOf": [
{
"$ref": "#/$defs/secretsPostRequestModelOrg"
},
{
"description": "The identifier of the Org associated with this secret."
}
]
},
"division": {
"type": "string",
"description": "The identifier of the Division associated with this secret."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition associated with this secret."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/secretType"
},
{
"description": "The type of secret.\n\n\nValid Values
\n\n- `baseKey` - **Base Derivation Key.**\n- `sftp` - **SFTP Server Key.**\n- `publicKey` - **Public Key.**\n- `privateKey` - **Private Key.**\n- `ecPrivateKey` - **Elliptic Curve Private Key.**\n- `apikey` - **API Key.**\n- `oldPrivateKey` - **Expired Private Key.**\n\n "
}
]
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/secretsPlatform"
},
{
"description": "The platform used to process this Transaction.\n\n\nValid Values
\n\n- `APPLE` - **Apple Payment Processor**\n- `ELAVON` - **ELAVON Payment Processor**\n- `FIRSTDATA` - **FirstData Payment Processor**\n- `GOOGLE` - **Google Payment Processor**\n- `VANTIV` - **WorldPay / Vantiv eComm Payment Processor (VAP)**\n- `VCORE` - **WorldPay / Vantiv Core Payment Processor**\n- `WELLSACH` - **Wells Fargo Merchant Services Payment Processor (ACH)**\n- `WELLSFARGO` - **Wells Fargo Merchant Services Payment Processor**\n- `WFSINGLE` - **Wells Fargo Single Payment Processor**\n- `WORLDPAY` - **WORLDPAY**\n- `TDBANKCA` - **TDBANKCA**\n "
}
]
},
"name": {
"type": "string",
"description": "The name of this Secret. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Secret. \nThis field is stored as a text string and must be between 0 and 500 characters long."
},
"key": {
"type": "string",
"description": "The actual key or the indicator of which key to use. \nThis field is stored as a text string and must be between 1 and 5000 characters long."
},
"locked": {
"allOf": [
{
"$ref": "#/$defs/secretLocked"
},
{
"description": "Whether this secret is locked or not. \nIf it is locked, then the value of this type of secret will prevail.\n\n\nValid Values
\n\n- `0` - **Not Locked**\n- `1` - **Locked**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"secretsPostRequestModelOrg": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/orgsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Org associated with this secret."
},
"subscriptionOrigin": {
"title": "subscriptionOrigin",
"enum": [
2,
3,
4,
5,
6,
8
],
"type": "integer"
},
"subscriptionTokensPostRequest": {
"title": "subscriptionTokensPostRequest",
"required": [
"subscription",
"token"
],
"type": "object",
"properties": {
"subscription": {
"allOf": [
{
"$ref": "#/$defs/subscriptionTokensPostRequestModelSubscription"
},
{
"description": "The identifier of the Subscription resource that this Subscription Token is associated with. This is the Subscription that the Token identified in the 'token' field of this resource is responsible for paying for."
}
]
},
"token": {
"allOf": [
{
"$ref": "#/$defs/subscriptionTokensPostRequestModelToken"
},
{
"description": "The identifier of the Token resource that this Subscription Token is associated with. This resource identifies the means of payment for the Subscription identified in the 'subscription' field of this resource."
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"subscriptionTokensPostRequestModelSubscription": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/subscriptionsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Subscription resource that this Subscription Token is associated with. This is the Subscription that the Token identified in the 'token' field of this resource is responsible for paying for."
},
"subscriptionTokensPostRequestModelToken": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/tokenPostRequest"
},
{}
]
}
],
"description": "The identifier of the Token resource that this Subscription Token is associated with. This resource identifies the means of payment for the Subscription identified in the 'subscription' field of this resource."
},
"subscriptionsPostRequest": {
"title": "subscriptionsPostRequest",
"required": [
"plan",
"start",
"authentication",
"failures"
],
"type": "object",
"properties": {
"plan": {
"type": "string",
"description": "The identifier of the Plan that this Subscription is associated with. The Plan determines the frequency and amount of each payment."
},
"statementEntity": {
"type": "string",
"description": "For a plan that is attached to a billing, this is the paying entity to match to the generated statements of that billing for which the recurring payments will be made."
},
"firstTxn": {
"type": "string",
"description": "The identification of the first transaction processed through this subscription. This is used internally to process subsequent transactions."
},
"start": {
"type": "integer",
"description": "The date on which the Subscription should start. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. The value of this field must represent a date in the future.",
"contentEncoding": "int32"
},
"finish": {
"type": "integer",
"description": "The date on which the Subscription should finish. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016. The value of this field must represent a date in the future.",
"contentEncoding": "int32"
},
"tax": {
"type": "integer",
"description": "The amount of the total sum of this Subscription that is made up of tax. This field is specified as an integer in cents.",
"contentEncoding": "int64"
},
"descriptor": {
"type": "string",
"description": "The descriptor used in this Subscription. This field is stored as a text string and must be between 1 and 50 characters long. If a value is not set, an attempt is made to set a default value from the merchant information."
},
"txnDescription": {
"type": "string",
"description": "The description of the Txn that will be created through this Subscription."
},
"order": {
"type": "string",
"description": "The order of the Txn that will be created through this Subscription."
},
"origin": {
"allOf": [
{
"$ref": "#/$defs/subscriptionOrigin"
},
{
"description": "The origin of the Txn that will be created through this Subscription.\n\n\nValid Values
\n\n- `2` - **Customer will be subscribing through eCommerce.**\n- `3` - **Customer will be subscribing by Mail Order/Telephone.**\n- `4` - **Originated with Apple Pay.**\n- `5` - **Originated as a Successful 3D Secure transaction.**\n- `6` - **Originated as an Attempted 3D Secure transaction.**\n- `8` - **Originated in a Payframe.**\n\n "
}
]
},
"authentication": {
"type": "string",
"description": "Authentication token for 3D Secure transactions."
},
"authenticationId": {
"type": "string",
"description": "Authentication reference ID for 3D Secure transactions."
},
"failures": {
"type": "integer",
"description": "The current count of consecutive payment failures for this subscription.",
"contentEncoding": "int32"
},
"maxFailures": {
"type": "integer",
"description": "The maximum consecutive amount of payment failures to allow for this subscription before inactivating it.",
"contentEncoding": "int32"
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"subscriptionTokens": {
"type": "array",
"items": {
"$ref": "#/$defs/subscriptionTokensPostRequest"
},
"description": ""
}
}
},
"teamLoginCreate": {
"title": "teamLoginCreate",
"enum": [
0,
1
],
"type": "integer"
},
"teamLoginDelete": {
"title": "teamLoginDelete",
"enum": [
0,
1
],
"type": "integer"
},
"teamLoginPostRequest": {
"title": "teamLoginPostRequest",
"required": [
"login",
"team"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this resource."
},
"team": {
"allOf": [
{
"$ref": "#/$defs/teamLoginPostRequestModelTeam"
},
{
"description": "The identifier of the Team resource that the Login identified in the 'login' field should be marked as part of."
}
]
},
"create": {
"allOf": [
{
"$ref": "#/$defs/teamLoginCreate"
},
{
"description": "Create rights for this Login on this Team.\n\n\nValid Values
\n\n- `0` - **None**\n- `1` - **Allow**\n\n "
}
]
},
"read": {
"allOf": [
{
"$ref": "#/$defs/teamLoginRead"
},
{
"description": "Read rights for this Login on this Team.\n\n\nValid Values
\n\n- `0` - **None**\n- `1` - **Allow**\n\n "
}
]
},
"update": {
"allOf": [
{
"$ref": "#/$defs/teamLoginUpdate"
},
{
"description": "Update rights for this Login on this Team.\n\n\nValid Values
\n\n- `0` - **None**\n- `1` - **Allow**\n\n "
}
]
},
"delete": {
"allOf": [
{
"$ref": "#/$defs/teamLoginDelete"
},
{
"description": "Delete rights for this Login on this Team.\n\n\nValid Values
\n\n- `0` - **None**\n- `1` - **Allow**\n\n "
}
]
},
"reference": {
"allOf": [
{
"$ref": "#/$defs/teamLoginReference"
},
{
"description": "Reference use rights for this Login on this Team.\n\n\nValid Values
\n\n- `0` - **None**\n- `1` - **Allow**\n\n "
}
]
},
"teamAdmin": {
"allOf": [
{
"$ref": "#/$defs/teamLoginTeamAdmin"
},
{
"description": "Team administration rights for this Login on this Team.\n\n\nValid Values
\n\n- `0` - **None**\n- `1` - **Allow**\n\n "
}
]
}
}
},
"teamLoginPostRequestModelTeam": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/teamsPostRequest"
},
{}
]
}
],
"description": "The identifier of the Team resource that the Login identified in the 'login' field should be marked as part of."
},
"teamLoginRead": {
"title": "teamLoginRead",
"enum": [
0,
1
],
"type": "integer"
},
"teamLoginReference": {
"title": "teamLoginReference",
"enum": [
0,
1
],
"type": "integer"
},
"teamLoginTeamAdmin": {
"title": "teamLoginTeamAdmin",
"enum": [
0,
1
],
"type": "integer"
},
"teamLoginUpdate": {
"title": "teamLoginUpdate",
"enum": [
0,
1
],
"type": "integer"
},
"teamsAutoCascadeDisabled": {
"title": "teamsAutoCascadeDisabled",
"enum": [
0,
1
],
"type": "integer"
},
"teamsAutoCascadeOwner": {
"title": "teamsAutoCascadeOwner",
"enum": [
0,
1
],
"type": "integer"
},
"teamsPostRequest": {
"title": "teamsPostRequest",
"required": [
"login"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The Login that owns this Team."
},
"name": {
"type": "string",
"description": "The name of this Team. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Team. \nThis field is stored as a text string and must be between 0 and 500 characters long."
},
"autoCascadeDisabled": {
"allOf": [
{
"$ref": "#/$defs/teamsAutoCascadeDisabled"
},
{
"description": "Whether new Logins created by member Logins of this Team will be added to this team or not. Default is 0 (enabled). \n\n\nValid Values
\n\n - `0` - **Disabled**\n\n - `1` - **Enabled**\n\n "
}
]
},
"autoCascadeOwner": {
"allOf": [
{
"$ref": "#/$defs/teamsAutoCascadeOwner"
},
{
"description": "An integer-boolean indicating whether or not the cascading functionality should extend to the owner of this team. \n\n\nValid Values
\n\n - `0` - **OFF**\n\n - `1` - **ON**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"alerts": {
"type": "array",
"items": {
"$ref": "#/$defs/alertsPostRequest"
},
"description": ""
},
"teamLogins": {
"type": "array",
"items": {
"$ref": "#/$defs/loginsPostRequest"
},
"description": ""
},
"orgFlows": {
"type": "array",
"items": {
"$ref": "#/$defs/orgFlowsPostRequest"
},
"description": ""
}
}
},
"terminalEnvironment": {
"title": "terminalEnvironment",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"type": "integer"
},
"terminalRefPlatform": {
"title": "terminalRefPlatform",
"enum": [
"ELAVON",
"FIRSTDATA",
"VCORE",
"VANTIV",
"WELLSFARGO",
"SOUNDPAYMENTS",
"PAYRIX"
],
"type": "string"
},
"terminalRefStage": {
"title": "terminalRefStage",
"enum": [
"create",
"pid",
"tid",
"token",
"ctid"
],
"type": "string"
},
"terminalRefsPostRequest": {
"title": "terminalRefsPostRequest",
"required": [
"terminal",
"ref",
"stage",
"platform",
"processor"
],
"type": "object",
"properties": {
"terminal": {
"type": "string",
"description": "The identifier of the Terminal that owns this terminalRefs resource."
},
"ref": {
"type": "string",
"description": "The reference code itself. This field is stored as a text string and must be between 0 and 50 characters long."
},
"stage": {
"allOf": [
{
"$ref": "#/$defs/terminalRefStage"
},
{
"description": "An indicator showing what this terminalRef refers to, such as 'create', 'pid', 'tid', 'token', or 'ctid'.\n\n\nValid Values
\n\n- `create` - **Terminal Creation**\n- `pid` - **Platform ID**\n- `tid` - **Terminal ID**\n- `token` - **Token ID**\n- `ctid` - **Custom Terminal ID**\n\n "
}
]
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/terminalRefPlatform"
},
{
"description": "The platform that issued this terminalRef.\n\n\nValid Values
\n\n- `ELAVON` - **ELAVON Payments Platform.**\n- `FIRSTDATA` - **FirstData Payments Platform.**\n- `VCORE` - **WorldPay / Vantiv Core Payments Platform.**\n- `VANTIV` - **WorldPay / Vantiv eComm Payments (VAP) Platform.**\n- `WELLSFARGO` - **Wells Fargo Merchant Services Payments Platform.**\n- `SOUNDPAYMENTS` - **SoundPayments EMV and POS Payments Platform.**\n- `PAYRIX` - **Payrix Merchant Payments Platform.**\n\n "
}
]
},
"processor": {
"allOf": [
{
"$ref": "#/$defs/terminalRefsProcessor"
},
{
"description": "The processor that issued this terminalTxnRef.\n\n\nValid Values
\n\n- `APPLE` - **APPLE**\n- `ELAVON` - **ELAVON**\n- `FIRSTDATA` - **FIRSTDATA**\n- `GOOGLE` - **GOOGLE**\n- `VANTIV` - **VANTIV**\n- `VCORE` - **VCORE**\n- `WELLSACH` - **WELLSACH**\n- `WELLSFARGO` - **WELLSFARGO**\n- `WFSINGLE` - **WFSINGLE**\n- `WORLDPAY` - **WORLDPAY**\n- `TDBANKCA` - **TDBANKCA**\n\n "
}
]
}
}
},
"terminalRefsProcessor": {
"title": "terminalRefsProcessor",
"enum": [
"APPLE",
"ELAVON",
"FIRSTDATA",
"GOOGLE",
"VANTIV",
"VCORE",
"WELLSACH",
"WELLSFARGO",
"WFSINGLE",
"WORLDPAY",
"TDBANKCA"
],
"type": "string"
},
"terminalStatus": {
"title": "terminalStatus",
"enum": [
0,
1
],
"type": "integer"
},
"terminalTxnsCvvStatus": {
"title": "terminalTxnsCvvStatus",
"enum": [
"notPresent",
"illegible",
"notProvided"
],
"type": "string"
},
"terminalTxnsPin": {
"title": "terminalTxnsPin",
"enum": [
0,
1
],
"type": "integer"
},
"terminalTxnsSignature": {
"title": "terminalTxnsSignature",
"enum": [
0,
1
],
"type": "integer"
},
"terminalTxnsSwiped": {
"title": "terminalTxnsSwiped",
"enum": [
0,
1
],
"type": "integer"
},
"terminalTxnsTerminalCapability": {
"title": "terminalTxnsTerminalCapability",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"terminalTxnsUnattended": {
"title": "terminalTxnsUnattended",
"enum": [
0,
1
],
"type": "integer"
},
"terminalType": {
"title": "terminalType",
"enum": [
"125158LLC",
"3Delta",
"3DeltaPws",
"911SoftwareCreditline",
"abcLiquors",
"abc610SE",
"achDirect",
"aciRcsSwitch",
"acoSoftware",
"activantFalcon",
"adsGilbarco",
"advancedMobilePayment",
"adyen",
"ahcc",
"ajb",
"ajbFipayDirectTandem",
"ajbIcip610",
"ajbRtsIbm",
"ajbRtsTandem",
"ajbBevn",
"ajbRue21",
"ajbSpoch",
"allureGlobal",
"alohaEnhanced610",
"alohaTerm",
"aprivaGateway",
"aprivaIwl255",
"apriva610",
"aprivapayAtt",
"aprivapayMobile",
"aptosEpicorRetail",
"ascom",
"asig",
"aurus",
"authorizeNet",
"automatedCashSystems",
"b2kSystems",
"bevnSoftware",
"billabong",
"bncb",
"bobEvans610",
"bookstoreManager",
"boost2Delta",
"boostBoraPayer",
"boostDirectInsite",
"boostMpg",
"breakawayVisionPos",
"bridgepay",
"brinkSoftware",
"buyAtab",
"caclGift",
"cardinalHealth610",
"cayan",
"ccciWebsite",
"cdsGlobalPaydq",
"cenposHostCapture",
"cenposIsoEmd",
"cfre610",
"chargePayments",
"chargesmartPaywareConnect",
"chrb610",
"chsp",
"ckfrIntrixSupercharge",
"clre610Salepoint",
"comdataSmartdesq",
"commerciant",
"crackerBarrel",
"crainAtlanta",
"craneVendingServices",
"creditCall",
"ctrSystems",
"cubicPaymentApplication",
"cyberSource",
"cyberSourceVsntConversion",
"cyberSourceVsntResellerBasic",
"cyberSourceVsntResellerPremier",
"dataBusnessSystems",
"dataCap",
"dataCapDialTran",
"dataCapEpayRepro",
"dataCapGiftEpay",
"dataCapIpTran",
"dataCapIpTranLt",
"dataCapIpTranLtMoble",
"dataCapNetEpay",
"dataCapTranRepro",
"dataCapTwinTran",
"dataCapTwinTxnServer",
"dataVantage",
"dataVantageFnln610",
"dbsTplusEnHanced",
"dbsTransactionPlus",
"dealBird",
"dejavoo",
"delego",
"digicom",
"directInsite",
"discGoTech",
"dl610Snt",
"dlglVarSoftware",
"dlgl610s",
"dominosAci",
"ecommercePlus",
"edgil",
"eesCompanies",
"elavonEnConcert610",
"elavonFuseboxGateway",
"elavonProtobase",
"elavonPayments",
"elpl610r",
"epayHealthcareMonetra",
"equinox",
"esdCard",
"eatouch",
"exatouchVsb",
"exit41",
"expressTriPos",
"ezDine",
"ezRetail",
"fandango",
"firstGlobalBillingSapwalletVsb",
"fitb610s",
"fredmeyr610",
"freedomPay",
"ftniGatewayEtran",
"futurePosVsb",
"GambleidTsevo",
"Giftango",
"Givex",
"gmsPaymentGateway",
"gmsPajb",
"gnctSoftware",
"goEMerchant",
"govolution",
"grantStreet",
"greatLakesScrip",
"greatLakesScripVar",
"gsiCommerce",
"handpoint",
"harleyOwnersGroup",
"highradius",
"hp",
"hypercom5500m",
"hypercomPaymentServer",
"hypercomT4205",
"hypercomT4205E2e",
"hypercomT4210",
"hypercomT4210E2e",
"hypercom4220Dial",
"hypercom4220DialE2e",
"hypercom4220Ssl",
"hypercom4220SslE2e",
"i2cVsb",
"ibmace",
"icVerify",
"incentPay",
"index",
"ingenico610",
"ingenico720",
"ingenicoIct2203xDial",
"ingenicoIct2203xDialE2ee",
"ingenicoIct2203xDialPilot",
"ingenicoIct2203xSsl",
"ingenicoIct2203xSslE2ee",
"ingenicoIct2203xSSLPilot",
"ingenicoIct220Ctls3xDial",
"ingenicoIct220Ctls3xDialEe2e",
"ingenicoIct220Ctls3xSsl",
"ingenicoIct220Ctls3xSslE2ee",
"ingenicoIct2503xDial",
"ingenicoIct2503xDialE2ee",
"ingenicoIct2503xSsl",
"ingenicoIct2503xSSLE2ee",
"ingenicoIwl222BtDial",
"ingenicoIwl222BtDialE2ee",
"ingenicoIwl222BtSsl",
"ingenicoIwl222BtSSlE2ee",
"ingenicoIwl252BtDial",
"ingenicoIw252BtDialE2ee",
"ingenicoIw252BtSsl",
"ingenicoIw252BtSslE2ee",
"ingenicoIw2553g",
"ingenicoIw2553gE2ee",
"ingenicoSiEnterprise",
"instamed",
"ipayGateway",
"isd",
"islandPacific",
"isvOpenmotionVsb",
"isv510",
"isv600",
"isv610",
"isvVsk",
"itransact",
"jewlSoftware",
"jockeyEcomm",
"jockeyRetail",
"kachyng",
"klik",
"kmartGift",
"kubra",
"lightYear",
"linked2Pay",
"longRangeSystemsLrs",
"lumberVisaK",
"lumgPos",
"magicWrighter",
"magnetCardServices",
"mainstreetMonetra510",
"mainstreetMonetra610",
"mastercardOpenapi",
"mastercardPaymentGateway",
"meiApriva",
"menusoftDigitalDining",
"merchantLinkCDG",
"merchantLinkCredit",
"meritSolar",
"microsSymphony",
"microsalePos",
"midniteExpressSlipstream",
"mightyTicket",
"milleniumRetailSolutions",
"mobileAccept",
"mobileAcceptFlatRate",
"mobileCheckoutQms",
"mobileCheckoutStandard",
"monetraAuth",
"monroMuffler",
"mpayGateway",
"mtxepsWineps",
"mvsp",
"ncrAdvancedRestaurant",
"ncrCinema",
"ncrCounterpoint510",
"ncrCounterpoint610",
"ncrRetalixConnectedPayments",
"ncrSilver",
"ncrSilverPro",
"ncrSilverProQms",
"neoGames610",
"networkMerchants",
"nsbEps",
"nourdersOdp",
"nurit2159",
"nurit8400EDial",
"oCharleys",
"olo",
"opConnect",
"optimalPaymentsGateway",
"orccCollectPay",
"orccAciWorldwide",
"orderTalk",
"paVitalcheck",
"paFidelityExpress",
"paGrantStreet",
"parkmobile",
"paxSp30Casio",
"payGov",
"paydiantSj",
"payFirstEdcVpos",
"paypalPayflowLink",
"paypalPayflowLinkReseller",
"paypalPayflowPro",
"paypalPayflowProReseller",
"payright",
"paytechVsb",
"pcAmerica",
"PLSTQ610",
"plugNPlay",
"poynt",
"precida",
"pricetonCardConnect",
"princetonEcommCollectpay",
"princetonPayments",
"princetonPayware",
"propSoftware",
"purecommerceVsb",
"pxpSolutionsRetail",
"rediantRposLighthouse",
"rainbowApparel",
"rdyc610s",
"redOakPs",
"redfinNetwork",
"remcoSoftware",
"rentACenter",
"reproOnlyIngIct220Dial",
"reproOnlyIngIct220DialE2ee",
"reproOnlyIngIct220SslE2ee",
"reproOnlyIngIct250Dial",
"reproOnlyIngIct250DialE2ee",
"reproOnlyIngIct250Ssl",
"reproOnlyIngIct250SslE2ee",
"reproOnlyVerifoneVx520DcDial",
"reproOnlyVerifoneVx520DcSsl",
"reproOnlyVerifoneVx520DialCtls",
"reproOnlyVerifoneVx520SslCtls",
"retrieverSoftware",
"revlinkCollect",
"revtrak",
"reamMobile",
"roamMobileTest",
"roamData",
"salepoint",
"salepointClaires",
"sbcSolutions",
"secureTrading",
"sequoiaRetialSystems",
"shci610",
"shift4OnTheNet",
"sightlinePayments",
"slimCdEntNonReseller",
"slimCdEnterprise",
"slimCdPro",
"slimCdProNonReseller",
"snlh610",
"southernDataComm",
"spsEzpay",
"squirrelSystems",
"ster610",
"storisVision9",
"ststSoftware",
"talbots",
"tangiblePayments",
"tapToPayIphone",
"tenderRetail",
"tillster",
"tnspayGateway",
"toast",
"toyzPos",
"transactionWirelessSvs",
"transax",
"tranzgate",
"trem610",
"triversity",
"triversityPos",
"trustcommVault610",
"trustcommVault600",
"trustcommerce2011",
"tsysAmexPipPcSoftware",
"tsysAmexPipTerminal",
"tsysDialPay",
"tsysPosPort",
"twitpay",
"uhaul",
"uicBezel8",
"upSolution610",
"usaEpay",
"usfs",
"ventek",
"verifone",
"verifone510Terminal",
"verifone600Terminal",
"verifone610",
"verifoneOmni3200",
"verifonePaywareConnect",
"verifonePaywareMobile",
"verifonePaywarePc",
"verifonePaywareTranactRita",
"verifonePcChargeGoSoftware",
"verifonePoint",
"verifonePointEntMx",
"verifonePointEntVx",
"verifoneRuby",
"verifoneVx510",
"verifoneVx510DcDial",
"verifoneVx510DcIp",
"verifoneVx510DcSsl",
"verifoneVx510le",
"verifoneVx520DcDialCtlsE2ee",
"verifoneVx520DcDialE2ee",
"verifoneVx520DcIp1",
"verifoneVx520DcIp2",
"verifoneVx520DcIpCtls",
"verifoneVx520DcIpCtlsE2ee",
"verifoneVx520DcSslCtlsE2ee",
"verifoneVx520DcSslE2ee",
"verifoneVx520DialOnly",
"verifoneVx570Dial",
"verifoneVx570Ip",
"verifoneVx570Ssl",
"verifoneVx6803gGprs",
"vicoSoftware",
"virtualTerminal",
"vistaEntertainment",
"vitalcheck",
"vmcAddOnAndroidByodQmd",
"vmcAddOnAndroidByodStandard",
"vmcAddOnBundleByodQms",
"vmcAddOnBundleByodStandard",
"vmcAddOnBundleCellularQmd",
"vmcAddOnBundleCellularStandard",
"vmcAddOnBundleWifiQmd",
"vmcAddOnBundleWifiStandard",
"vmcFieldBundleByodQmd",
"vmcFieldBundleByodStandard",
"vmcFieldBundleCellularQms",
"vmcFieldBundleCellularStandard",
"vmcStoreAndroidByodQms",
"vmcStoreAndroidByodStandard",
"vmcStoreBundleByodQms",
"vmcStoreBundleByodStandard",
"vmcStoreBundleCellularQms",
"vmcStoreBundleCellularStandard",
"vmcStoreBundleWifiQms",
"vmcStoreBundleWifiStandard",
"vPlus",
"vsb",
"vsbGreenbeanRecycle",
"vsbKaizen",
"vsbOrderbridge",
"vsbPhonixManagedNetwork",
"vsbSamurai",
"vsbVisat",
"vsbWiretrust",
"vsbXgateway",
"wandGift",
"waySystemsMtt5000",
"wendysCom",
"whirl",
"winn610s",
"xpaySoftware",
"xpient610",
"xpientSolutions"
],
"type": "string"
},
"terminalsAutoClose": {
"title": "terminalsAutoClose",
"enum": [
0,
1,
2
],
"type": "integer"
},
"terminalsCapability": {
"title": "terminalsCapability",
"enum": [
1,
2,
3,
4
],
"type": "integer"
},
"terminalsCloudEnabled": {
"title": "terminalsCloudEnabled",
"enum": [
0,
1
],
"type": "integer"
},
"terminalsPostRequest": {
"title": "terminalsPostRequest",
"required": [
"merchant",
"type",
"autoClose",
"status"
],
"type": "object",
"properties": {
"merchant": {
"type": "string",
"description": "The identifier of the Merchant that owns this terminals resource."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/terminalType"
},
{
"description": "The type of terminal. This field is stored as an integer and must be between 1 and 419. Valid Values
\n \n- `125158LLC` - **12:51:58 LLC POS**\n\n- `3Delta` - **3 Delta Systems Virtual Terminal**\n\n- `3DeltaPws` - **3 Delta Systems Payment WorkSuite**\n\n- `911SoftwareCreditline` - **911 Software Credit Line**\n\n- `abcLiquors` - **''**\n\n- `abc610SE` - **''**\n\n- `achDirect` - **''**\n\n- `aciRcsSwitch` - **''**\n\n- `acoSoftware` - **''**\n\n- `activantFalcon` - **''**\n\n- `adsGilbarco` - **''**\n\n- `advancedMobilePayment` - **''**\n\n- `adyen` - **''**\n\n- `ahcc` - **''**\n\n- `ajb` - **''**\n\n- `ajbFipayDirectTandem`- **''**\n\n- `ajbIcip610` - **''**\n\n- `ajbRtsIbm` - **''**\n\n- `ajbRtsTandem` - **''**\n\n- `ajbBevn` - **''**\n\n- `ajbRue21` - **''**\n\n- `ajbSpoch` - **''**\n\n- `allureGlobal` - **''**\n\n- `alohaEnhanced610` - **''**\n\n- `alohaTerm` - **''**\n\n- `aprivaGateway` - **''**\n\n- `aprivaIwl255` - **''**\n\n- `apriva610` - **''**\n\n- `aprivapayAtt` - **''**\n\n- `aprivapayMobile` - **''**\n\n- `aptosEpicorRetail` - **''**\n\n- `ascom` - **''**\n\n- `asig` - **''**\n\n- `aurus` - **''**\n\n- `authorizeNet` - **''**\n\n- `automatedCashSystems` - **''**\n\n- `b2kSystems` - **''**\n\n- `bevnSoftware` - **''**\n\n- `billabong` - **''**\n\n- `bncb` - **''**\n\n- `bobEvans610` - **''**\n\n- `bookstoreManager` - **''**\n\n- `boost2Delta` - **''**\n\n- `boostBoraPayer` - **''**\n\n- `boostDirectInsite` - **''**\n\n- `boostMpg` - **''**\n\n- `breakawayVisionPos` - **''**\n\n- `bridgepay` - **''**\n\n- `brinkSoftware` - **''**\n\n- `buyAtab` - **''**\n\n- `caclGift` - **''**\n\n- `cardinalHealth610` - **''**\n\n- `cayan` - **''**\n\n- `ccciWebsite` - **''**\n\n- `cdsGlobalPaydq` - **''**\n\n- `cenposHostCapture` - **''**\n\n- `cenposIsoEmd` - **''**\n\n- `cfre610` - **''**\n\n- `chargePayments` - **''**\n\n- `chargesmartPaywareConnect` - **''**\n\n- `chrb610` - **''**\n\n- `chsp` - **''**\n\n- `ckfrIntrixSupercharge` - **''**\n\n- `clre610Salepoint` - **''**\n\n- `comdataSmartdesq` - **''**\n\n- `commerciant` - **''**\n\n- `crackerBarrel` - **''**\n\n- `crainAtlanta` - **''**\n\n- `craneVendingServices` - **''**\n\n- `creditCall` - **''**\n\n- `ctrSystems` - **''**\n\n- `cubicPaymentApplication` - **''**\n\n- `cyberSource` - **''**\n\n- `cyberSourceVsntConversion` - **''**\n\n- `cyberSourceVsntResellerBasic` - **''**\n\n- `cyberSourceVsntResellerPremier` - **''**\n\n- `dataBusnessSystems` - **''**\n\n- `dataCap` - **''**\n\n- `dataCapDialTran` - **''**\n\n- `dataCapEpayRepro` - **''**\n\n- `dataCapGiftEpay` - **''**\n\n- `dataCapIpTran` - **''**\n\n- `dataCapIpTranLt` - **''**\n\n- `dataCapIpTranLtMoble` - **''**\n\n- `dataCapNetEpay` - **''**\n\n- `dataCapTranRepro` - **''**\n\n- `dataCapTwinTran` - **''**\n\n- `dataCapTwinTxnServer` - **''**\n\n- `dataVantage` - **''**\n\n- `dataVantageFnln610` - **''**\n\n- `dbsTplusEnHanced` - **''**\n\n- `dbsTransactionPlus` - **''**\n\n- `dealBird` - **''**\n\n- `dejavoo` - **''**\n\n- `delego` - **''**\n\n- `digicom` - **''**\n\n- `directInsite` - **''**\n\n- `discGoTech` - **''**\n\n- `dl610Snt` - **''**\n\n- `dlglVarSoftware` - **''**\n\n- `dlgl610s` - **''**\n\n- `dominosAci` - **''**\n\n- `ecommercePlus` - **''**\n\n- `edgil` - **''**\n\n- `eesCompanies` - **''**\n\n- `elavonEnConcert610` - **''**\n\n- `elavonFuseboxGateway` - **''**\n\n- `elavonProtobase` - **''**\n\n- `elavonPayments` - **''**\n\n- `elpl610r` - **''**\n\n- `epayHealthcareMonetra` - **''**\n\n- `equinox` - **''**\n\n- `esdCard` - **''**\n\n- `eatouch` - **''**\n\n- `exatouchVsb` - **''**\n\n- `exit41` - **''**\n\n- `ezDine` - **''**\n\n- `ezRetail` - **''**\n\n- `fandango` - **''**\n\n- `firstGlobalBillingSapwalletVsb` - **''**\n\n- `fitb610s` - **''** \n- `fredmeyr610` - **''**\n\n- `freedomPay` - **''**\n\n- `ftniGatewayEtran` - **''**\n\n- `futurePosVsb` - **''**\n\n- `GambleidTsevo` - **GambleID / TSEVO POS**\n\n- `Giftango` - **Giftango POS**\n\n- `Givex` - **Givex POS**\n\n- `gmsPaymentGateway` - **''**\n\n- `gmsPajb` - **''**\n\n- `gnctSoftware` - **''**\n\n- `goEMerchant` - **''**\n\n- `govolution` - **''**\n\n- `grantStreet` - **''**\n\n- `greatLakesScrip` - **''**\n\n- `greatLakesScripVar` - **''**\n\n- `gsiCommerce` - **''**\n\n- `handpoint` - **''**\n\n- `harleyOwnersGroup` - **''**\n\n- `highradius` - **''**\n\n- `hp` - **''**\n\n- `hypercom5500m` - **''**\n\n- `hypercomPaymentServer` - **''**\n\n- `hypercomT4205` - **''**\n\n- `hypercomT4205E2e` - **''**\n\n- `hypercomT4210` - **''**\n\n- `hypercomT4210E2e` - **''**\n\n- `hypercom4220Dial` - **''**\n\n- `hypercom4220DialE2e` - **''**\n\n- `hypercom4220Ssl` - **''**\n\n- `hypercom4220SslE2e` - **''**\n\n- `i2cVsb` - **''**\n\n- `ibmace` - **''**\n\n- `icVerify` - **''**\n\n- `incentPay` - **''**\n\n- `index` - **''**\n\n- `ingenico610` - **''**\n\n- `ingenico720` - **''**\n\n- `ingenicoIct2203xDial` - **''**\n\n- `ingenicoIct2203xDialE2ee` - **''**\n\n- `ingenicoIct2203xDialPilot` - **''**\n\n- `ingenicoIct2203xSsl` - **''**\n\n- `ingenicoIct2203xSslE2ee` - **''**\n\n- `ingenicoIct2203xSSLPilot` - **''**\n\n- `ingenicoIct220Ctls3xDial` - **''**\n\n- `ingenicoIct220Ctls3xDialEe2e` - **''**\n\n- `ingenicoIct220Ctls3xSsl` - **''**\n\n- `ingenicoIct220Ctls3xSslE2ee` - **''**\n\n- `ingenicoIct2503xDial` - **''**\n\n- `ingenicoIct2503xDialE2ee` - **''**\n\n- `ingenicoIct2503xSsl` - **''**\n\n- `ingenicoIct2503xSSLE2ee` - **''**\n\n- `ingenicoIwl222BtDial` - **''**\n\n- `ingenicoIwl222BtDialE2ee` - **''**\n\n- `ingenicoIwl222BtSsl` - **''**\n\n- `ingenicoIwl222BtSSlE2ee` - **''**\n\n- `ingenicoIwl252BtDial` - **''**\n\n- `ingenicoIw252BtDialE2ee` - **''**\n\n- `ingenicoIw252BtSsl` - **''**\n\n- `ingenicoIw252BtSslE2ee` - **''**\n\n- `ingenicoIw2553g` - **''**\n\n- `ingenicoIw2553gE2ee` - **''**\n\n- `ingenicoSiEnterprise` - **''**\n\n- `instamed` - **''**\n\n- `ipayGateway` - **''**\n\n- `isd` - **''**\n\n- `islandPacific` - **''**\n\n- `isvOpenmotionVsb` - **''**\n\n- `isv510` - **''**\n\n- `isv600` - **''**\n\n- `isv610` - **''**\n\n- `isvVsk` - **''**\n\n- `itransact` - **''**\n\n- `jewlSoftware` - **''**\n\n- `jockeyEcomm` - **''**\n\n- `jockeyRetail` - **''**\n\n- `kachyng` - **''**\n\n- `klik` - **''**\n\n- `kmartGift` - **''**\n\n- `kubra` - **''**\n\n- `lightYear` - **''**\n\n- `linked2Pay` - **''**\n\n- `longRangeSystemsLrs` - **''**\n\n- `lumberVisaK` - **''**\n\n- `lumgPos` - **''**\n\n- `magicWrighter` - **''**\n\n- `magnetCardServices` - **''**\n\n- `mainstreetMonetra510` - **''**\n\n- `mainstreetMonetra610` - **''**\n\n- `mastercardOpenapi` - **''**\n\n- `mastercardPaymentGateway` - **''**\n\n- `meiApriva` - **''**\n\n- `menusoftDigitalDining` - **''**\n\n- `merchantLinkCDG` - **''**\n\n- `merchantLinkCredit` - **''**\n\n- `meritSolar` - **''**\n\n- `microsSymphony` - **''**\n\n- `microsalePos` - **''**\n\n- `midniteExpressSlipstream` - **''**\n\n- `mightyTicket` - **''**\n\n- `milleniumRetailSolutions` - **''**\n\n- `mobileAccept` - **''**\n\n- `mobileAcceptFlatRate` - **''**\n\n- `mobileCheckoutQms` - **''**\n\n- `mobileCheckoutStandard` - **''**\n\n- `monetraAuth` - **''**\n\n- `monroMuffler` - **''**\n\n- `mpayGateway` - **''**\n\n- `mtxepsWineps` - **''**\n\n- `mvsp` - **''**\n\n- `ncrAdvancedRestaurant` - **''**\n\n- `ncrCinema` - **''**\n\n- `ncrCounterpoint510` - **''**\n\n- `ncrCounterpoint610` - **''**\n\n- `ncrRetalixConnectedPayments` - **''**\n\n- `ncrSilver` - **''**\n\n- `ncrSilverPro` - **''**\n\n- `ncrSilverProQms` - **''**\n\n- `neoGames610` - **''**\n\n- `networkMerchants` - **''**\n\n- `nsbEps` - **''**\n\n- `nourdersOdp` - **''**\n\n- `nurit2159` - **''**\n\n- `nurit8400EDial` - **''**\n\n- `oCharleys` - **''**\n\n- `olo` - **''**\n\n- `opConnect` - **''**\n\n- `optimalPaymentsGateway` - **''**\n\n- `orccCollectPay` - **''**\n\n- `orccAciWorldwide` - **''**\n\n- `orderTalk` - **''**\n\n- `paVitalcheck` - **''**\n\n- `paFidelityExpress` - **''**\n\n- `paGrantStreet` - **''**\n\n- `parkmobile` - **''**\n\n- `paxSp30Casio` - **''**\n\n- `payGov` - **''**\n\n- `paydiantSj` - **''**\n\n- `payFirstEdcVpos` - **''**\n\n- `paypalPayflowLink` - **''**\n\n- `paypalPayflowLinkReseller` - **''**\n\n- `paypalPayflowPro` - **''**\n\n- `paypalPayflowProReseller` - **''**\n\n- `payright` - **''**\n\n- `paytechVsb` - **''**\n\n- `pcAmerica` - **''**\n\n- `PLSTQ610` - **''**\n\n- `plugNPlay` - **''**\n\n- `poynt` - **''**\n\n- `precida` - **''**\n\n- `pricetonCardConnect` - **''**\n\n- `princetonEcommCollectpay` - **''**\n\n- `princetonPayments` - **''**\n\n- `princetonPayware` - **''**\n\n- `propSoftware` - **''**\n\n- `purecommerceVsb` - **''**\n\n- `pxpSolutionsRetail` - **''**\n\n- `rediantRposLighthouse` - **''**\n\n- `rainbowApparel` - **''**\n\n- `rdyc610s` - **''**\n\n- `redOakPs` - **''**\n\n- `redfinNetwork` - **''**\n\n- `remcoSoftware` - **''**\n\n- `rentACenter` - **''**\n\n- `reproOnlyIngIct220Dial` - **''**\n\n- `reproOnlyIngIct220DialE2ee` - **''**\n\n- `reproOnlyIngIct220SslE2ee` - **''**\n\n- `reproOnlyIngIct250Dial` - **''**\n\n- `reproOnlyIngIct250DialE2ee` - **''**\n\n- `reproOnlyIngIct250Ssl` - **''**\n\n- `reproOnlyIngIct250SslE2ee` - **''**\n\n- `reproOnlyVerifoneVx520DcDial` - **''**\n\n- `reproOnlyVerifoneVx520DcSsl` - **''**\n\n- `reproOnlyVerifoneVx520DialCtls` - **''**\n\n- `reproOnlyVerifoneVx520SslCtls` - **''**\n\n- `retrieverSoftware` - **''**\n\n- `revlinkCollect` - **''**\n\n- `revtrak` - **''**\n\n- `reamMobile` - **''**\n\n- `roamMobileTest` - **''**\n\n- `roamData` - **''**\n\n- `salepoint` - **''**\n\n- `salepointClaires` - **''**\n\n- `sbcSolutions` - **''**\n\n- `secureTrading` - **''**\n\n- `sequoiaRetialSystems` - **''**\n\n- `shci610` - **''**\n\n- `shift4OnTheNet` - **''**\n\n- `sightlinePayments` - **''**\n\n- `slimCdEntNonReseller` - **''**\n\n- `slimCdEnterprise` - **''**\n\n- `slimCdPro` - **''**\n\n- `slimCdProNonReseller` - **''**\n\n- `snlh610` - **''**\n\n- `southernDataComm` - **''**\n\n- `spsEzpay` - **''**\n\n- `squirrelSystems` - **''**\n\n- `ster610` - **''**\n\n- `storisVision9` - **''**\n\n- `ststSoftware` - **''**\n\n- `talbots` - **''**\n\n- `tangiblePayments` - **''**\n\n- `tapToPayIphone` - **''**\n\n- `tenderRetail` - **''**\n\n- `tillster` - **''**\n\n- `tnspayGateway` - **''**\n\n- `toast` - **''**\n\n- `toyzPos` - **''**\n\n- `transactionWirelessSvs` - **''**\n\n- `transax` - **''**\n\n- `tranzgate` - **''**\n\n- `trem610` - **''**\n\n- `triversity` - **''**\n\n- `triversityPos` - **''**\n\n- `trustcommVault610` - **''**\n\n- `trustcommVault600` - **''**\n\n- `trustcommerce2011` - **''**\n\n- `tsysAmexPipPcSoftware` - **''**\n\n- `tsysAmexPipTerminal` - **''**\n\n- `tsysDialPay` - **''**\n\n- `tsysPosPort` - **''**\n\n- `twitpay` - **''**\n\n- `uhaul` - **''**\n\n- `uicBezel8` - **''**\n\n- `upSolution610` - **''**\n\n- `usaEpay` - **''**\n\n- `usfs` - **''**\n\n- `ventek` - **''**\n\n- `verifone` - **''**\n\n- `verifone510Terminal` - **''**\n\n- `verifone600Terminal` - **''**\n\n- `verifone610` - **''**\n\n- `verifoneOmni3200` - **''**\n\n- `verifonePaywareConnect` - **''**\n\n- `verifonePaywareMobile` - **''**\n\n- `verifonePaywarePc` - **''**\n\n- `verifonePaywareTranactRita` - **''**\n\n- `verifonePcChargeGoSoftware` - **''**\n\n- `verifonePoint` - **''**\n\n- `verifonePointEntMx` - **''**\n\n- `verifonePointEntVx` - **''**\n\n- `verifoneRuby` - **''**\n\n- `verifoneVx510` - **''**\n\n- `verifoneVx510DcDial` - **''**\n\n- `verifoneVx510DcIp` - **''**\n\n- `verifoneVx510DcSsl` - **''**\n\n- `verifoneVx510le` - **''**\n\n- `verifoneVx520DcDialCtlsE2ee` - **''**\n\n- `verifoneVx520DcDialE2ee` - **''**\n\n- `verifoneVx520DcIp1` - **''**\n\n- `verifoneVx520DcIp2` - **''**\n\n- `verifoneVx520DcIpCtls` - **''**\n\n- `verifoneVx520DcIpCtlsE2ee` - **''**\n\n- `verifoneVx520DcSslCtlsE2ee` - **''**\n\n- `verifoneVx520DcSslE2ee` - **''**\n\n- `verifoneVx520DialOnly` - **''**\n\n- `verifoneVx570Dial` - **''**\n\n- `verifoneVx570Ip` - **''**\n\n- `verifoneVx570Ssl` - **''**\n\n- `verifoneVx6803gGprs` - **''**\n\n- `vicoSoftware` - **''**\n\n- `virtualTerminal` - **''**\n\n- `vistaEntertainment` - **''** \n- `vitalcheck` - **''**\n\n- `vmcAddOnAndroidByodQmd` - **''**\n\n- `vmcAddOnAndroidByodStandard` - **''**\n\n- `vmcAddOnBundleByodQms` - **''**\n\n- `vmcAddOnBundleByodStandard` - **''**\n\n- `vmcAddOnBundleCellularQmd` - **''**\n\n- `vmcAddOnBundleCellularStandard` - **''**\n\n- `vmcAddOnBundleWifiQmd` - **''**\n\n- `vmcAddOnBundleWifiStandard` - **''**\n\n- `vmcFieldBundleByodQmd` - **''**\n\n- `vmcFieldBundleByodStandard` - **''**\n\n- `vmcFieldBundleCellularQms` - **''**\n\n- `vmcFieldBundleCellularStandard` - **''**\n\n- `vmcStoreAndroidByodQms` - **''**\n\n- `vmcStoreAndroidByodStandard` - **''**\n\n- `vmcStoreBundleByodQms` - **''**\n\n- `vmcStoreBundleByodStandard` - **''**\n\n- `vmcStoreBundleCellularQms` - **''**\n\n- `vmcStoreBundleCellularStandard` - **''**\n\n- `vmcStoreBundleWifiQms` - **''**\n\n- `vmcStoreBundleWifiStandard` - **''**\n\n- `vPlus` - **''**\n\n- `vsb` - **''**\n\n- `vsbGreenbeanRecycle` - **''**\n\n- `vsbKaizen` - **''**\n\n- `vsbOrderbridge` - **''**\n\n- `vsbPhonixManagedNetwork` - **''**\n\n- `vsbSamurai` - **''**\n\n- `vsbVisat` - **''**\n\n- `vsbWiretrust` - **''**\n\n- `vsbXgateway` - **''**\n\n- `wandGift` - **''**\n\n\n- `waySystemsMtt5000` - **''**\n\n- `wendysCom` - **''**\n\n- `whirl` - **''**\n\n- `winn610s` - **''**\n\n- `xpaySoftware` - **''**\n\n- `xpient610` - **''**\n\n- `xpientSolutions` - **''**\n\n \nValid Values
\n\n- `1` - **KEYED.** Manual Card Payment Entry.\n- `2` - **MAGSTRIPE.** Magstripe/Swipe.\n- `3` - **EMV.** (EuroPay, Mastercard, & Visa) Chip Card Payments.\n- `4` - **TAP.** Tap-to-Pay.\n\n "
}
]
},
"environment": {
"allOf": [
{
"$ref": "#/$defs/terminalEnvironment"
},
{
"description": "How is the terminal employed in the type of business using the terminal.\n\n\nValid Values
\n\n- `1` - **Retail**\n- `2` - **Retail with tips**\n- `3` - **Restaurant**\n- `4` - **Lodging**\n- `5` - **Bar**\n- `6` - **Cash Advance**\n- `7` - **Mail/Telephone Order**\n- `8` - **Pay At The Pump**\n- `9` - **Service Rest**\n- `10` - **E-commerce**\n- `11` - **Direct Marketing**\n- `12` - **Fine Dining**\n- `13` - **Gift Card Only**\n\n "
}
]
},
"autoClose": {
"allOf": [
{
"$ref": "#/$defs/terminalsAutoClose"
},
{
"description": "If the terminal should be manually or automatically closed for the day.\n\n\nValid Values
\n\n- `0` - **Automatic**\n- `1` - **Manual**\n- `2` - **None**\n\n "
}
]
},
"autoCloseTime": {
"type": "integer",
"description": "The time when the terminal should be automatically closed for the day. This field is only required when AutoClose is set to automatic; the format should be HHMM (1145, 2200, etc).",
"contentEncoding": "int32",
"default": 2000
},
"cloudEnabled": {
"allOf": [
{
"$ref": "#/$defs/terminalsCloudEnabled"
},
{
"description": "Whether or not the terminal has cloud services enabled.\n\n\nValid Values
\n\n- `0` - **Cloud Services Disabled**\n- `1` - **Cloud Services Enabled**\n\n "
}
]
},
"serial": {
"type": "string",
"description": "The serial number of the terminal device."
},
"token": {
"type": "string",
"description": "The ID of the token record to associate with this terminal transaction request."
},
"name": {
"type": "string",
"description": "The name of this Terminal. This field is stored as a text string and must be between 1 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of the Terminal. This field is stored as a text string and must be between 1 and 100 characters long."
},
"address1": {
"type": "string",
"description": "The first line of the address associated with this Terminal's location. This field is stored as a text string and must be between 1 and 500 characters long."
},
"address2": {
"type": "string",
"description": "The second line of the address associated with this Terminal's location. This field is stored as a text string and must be between 1 and 500 characters long."
},
"city": {
"type": "string",
"description": "The name of the city in the address associated with this Terminal's location. This field is stored as a text string and must be between 1 and 500 characters long."
},
"state": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"zip": {
"type": "string",
"description": "The ZIP code in the address associated with this Terminal's location, This field is stored as a text string and must be between 1 and 20 characters long."
},
"country": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country in the address associated with the Terminal's location. Currently, this field only accepts the value 'USA'."
}
]
},
"phone": {
"type": "string",
"description": "The Phone number is the telephone number associated with the Terminal's location, stored as a text string and must be between 5 and 15 characters long and numeric characters only."
},
"timezone": {
"allOf": [
{
"$ref": "#/$defs/terminalsTimezone"
},
{
"description": "The timezone for the address associated with the terminal's location.\n\n\nValid Values
\n\n- `est` - **Eastern Standard Time**\n- `cst` - **Central Standard Time**\n- `pst` - **Pacific Standard Time**\n- `mst` - **Mountain Standard Time**\n- `akst` - **Alaska Standard Time**\n- `hst` - **Hawaii Standard Time**\n- `sst` - **Samoa Standard Time**\n- `chst` - **Chamorro Standard Time**\n- `ast` - **Atlantic Standard Time**\n- `pwt` - **Palau Time**\n- `mht` - **Marshall Islands Time**\n- `chut` - **Chuuk Time**\n- `nst` - **Newfoundland Standard Time**\n\n "
}
]
},
"status": {
"allOf": [
{
"$ref": "#/$defs/terminalStatus"
},
{
"description": "The current active status of the terminal.\n\n\nValid Values
\n\n- `0` - **Inactive**\n- `1` - **Active**\n\n "
}
]
},
"terminalRefs": {
"type": "array",
"items": {
"$ref": "#/$defs/terminalRefsPostRequest"
},
"description": ""
}
}
},
"terminalsTimezone": {
"title": "terminalsTimezone",
"enum": [
"est",
"cst",
"pst",
"mst",
"akst",
"hst",
"sst",
"chst",
"ast",
"pwt",
"mht",
"chut",
"nst"
],
"type": "string"
},
"tokenPostRequest": {
"title": "tokenPostRequest",
"required": [
"customer",
"payment",
"status",
"inactive",
"frozen"
],
"type": "object",
"properties": {
"customer": {
"allOf": [
{
"$ref": "#/$defs/tokensPostRequestModelCustomer"
},
{
"description": "The Customer that this Token is associated with."
}
]
},
"payment": {
"allOf": [
{
"$ref": "#/$defs/tokensPostRequestModelPayment"
},
{
"description": "The payment method that is associated with this Token."
}
]
},
"expiration": {
"type": "string",
"description": "The expiry month for the payment method associated with this Token.In This field is stored as a text string in 'MMYY' format, where 'MM' is the number of a month and 'YY' is the last two digits of a year. For example, '0623' for June 2023. The value must reflect a future date."
},
"name": {
"type": "string",
"description": "The name of this Token. This field is stored as a text string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A description of this Token. This field is stored as a text string and must be between 0 and 100 characters long."
},
"custom": {
"type": "string",
"description": "Custom, free-form field for client-supplied text, must be between 0 and 1000 characters long."
},
"authTokenCustomer": {
"type": "string",
"description": "The customer reference from the authToken used for user authentication"
},
"origin": {
"type": "integer",
"description": "The origin of the token.",
"contentEncoding": "int32"
},
"entryMode": {
"type": "integer",
"description": "Entry mode set to the token.",
"contentEncoding": "int32"
},
"omnitoken": {
"type": "string",
"description": "The omnitoken value. If this field has a value, the whole record is treated as an omnitoken."
},
"status": {
"allOf": [
{
"$ref": "#/$defs/tokenStatus"
},
{
"description": "Indicates if this token is ready for use in transactions and subscriptions or not. \nA token without complete payment details will be marked as 'pending'.\n\n\nValid Values
\n\n- `pending` - **The payment data is not yet available, Token is not ready for use.**\n\n- `ready` - **The payment data is available, Token is ready for use.**\n\n "
}
]
},
"accountUpdaterEligible": {
"allOf": [
{
"$ref": "#/$defs/accountUpdaterEligible"
},
{
"description": "Indicates whether this resource is eligible to be sent for updates to wordpay as part of the account updater process.\n\n\nValid Values
\n\n- `1` - **Eligible**\n- `0` - **Not Eligible**\n\n "
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
},
"subscriptionTokens": {
"type": "array",
"items": {
"$ref": "#/$defs/subscriptionTokensPostRequest"
},
"description": ""
},
"txns": {
"type": "array",
"items": {
"$ref": "#/$defs/txnsPostRequest"
},
"description": ""
}
}
},
"tokenStatus": {
"title": "tokenStatus",
"enum": [
"pending",
"ready"
],
"type": "string"
},
"tokensPostRequestModelCustomer": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/customersPostRequest"
},
{}
]
}
],
"description": "The Customer that this Token is associated with."
},
"tokensPostRequestModelPayment": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/paymentPostRequest"
}
],
"description": "The payment method that is associated with this Token."
},
"txnOrigin": {
"title": "txnOrigin",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"type": "integer"
},
"txnPaymentMethod": {
"title": "txnPaymentMethod",
"enum": [
0,
1,
2,
3,
4,
5,
7,
8,
9,
10,
11,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26
],
"type": "integer"
},
"txnType": {
"title": "txnType",
"enum": [
1,
2,
3,
4,
5,
7,
8,
11,
12,
14
],
"type": "integer"
},
"txnsAllowPartial": {
"title": "txnsAllowPartial",
"enum": [
0,
1
],
"type": "integer"
},
"txnsCofType": {
"title": "txnsCofType",
"enum": [
"single",
"scheduled",
"unscheduled",
"installment"
],
"type": "string"
},
"txnsCopyReasons": {
"title": "txnsCopyReasons",
"enum": [
"resubmission",
"reauthorization"
],
"type": "string"
},
"txnsDebtRepayment": {
"title": "txnsDebtRepayment",
"enum": [
0,
1
],
"type": "integer"
},
"txnsFundingEnabled": {
"title": "txnsFundingEnabled",
"enum": [
0,
1
],
"type": "integer"
},
"txnsMobile": {
"title": "txnsMobile",
"enum": [
0,
1
],
"type": "integer"
},
"txnsPayment": {
"title": "txnsPayment",
"required": [
"method",
"number"
],
"type": "object",
"properties": {
"method": {
"allOf": [
{
"$ref": "#/$defs/txnPaymentMethod"
},
{
"description": "The payment method for this Transaction."
}
]
},
"number": {
"type": "string",
"description": "For credit payment method, the card number of the credit card associated with this Transaction.\nFor eCheck payment method, the bank account number associated with this Transaction."
},
"routing": {
"type": "string",
"description": "The routing code for the eCheck or bank account payment associated with this Transaction."
},
"expiration": {
"type": "string",
"description": "The expiration date of the credit card associated with this Transaction.\nThis field is stored as a text string in 'MMYY' format, where 'MM' is the number of a month and 'YY' is the last two digits of a year. For example, '0623' for June 2023."
},
"cvv": {
"type": "string",
"description": "The Card Verification Value (CVV) number of the credit card associated with this Transaction. \nThis field is expressed as an integer.",
"default": "0"
},
"track": {
"description": "The 'Track' data (either Track 1, Track 2, or both) of the card associated with this Transaction. \nThis field is stored as a text string."
}
},
"description": "The payment method associated with this Transaction, including the card details."
},
"txnsPinEntryCapability": {
"title": "txnsPinEntryCapability",
"enum": [
"unknown",
"capable",
"notCapable",
"pinPadDown"
],
"type": "string"
},
"txnsPlatform": {
"title": "txnsPlatform",
"enum": [
"APPLE",
"ELAVON",
"FIRSTDATA",
"GOOGLE",
"VANTIV",
"VCORE",
"WELLSACH",
"WELLSFARGO",
"WFSINGLE"
],
"type": "string"
},
"txnsPostRequest": {
"title": "txnsPostRequest",
"required": [
"allowPartial",
"authentication",
"debtRepayment",
"fortxn",
"origin",
"type",
"unauthReason",
"currency",
"fundingCurrency",
"swiped",
"merchant",
"mid",
"pin",
"signature",
"total",
"unattended",
"payment"
],
"type": "object",
"properties": {
"allowPartial": {
"allOf": [
{
"$ref": "#/$defs/txnsAllowPartial"
},
{
"description": "Whether to allow partial amount authorizations of this Transaction. For example, if the transaction amount is $1000 and the processor only authorizes a smaller amount, then enabling this field lets the Transaction proceed anyway.\n\n\nValid Values
\n\n- `0` - **Partial amount authorizations are not allowed.**\n\n- `1` - **Partial amount authorizations are allowed.**\n\n "
}
]
},
"batch": {
"type": "string",
"description": "If the Transaction is linked to a Batch, this field specifies the identifier of the Batch."
},
"authentication": {
"type": "string",
"description": "Authentication token returned by the network in a 3DSecure txn."
},
"authenticationId": {
"type": "string",
"description": "Optional transaction ID returned by the network in a 3DSecure txn."
},
"cofType": {
"allOf": [
{
"$ref": "#/$defs/txnsCofType"
},
{
"description": "The type of Card On File transaction when using a token is single, scheduled, or unscheduled.\n\n\nValid Values
\n\n- `single` - **Individual Transaction.**\n- `scheduled` - **Scheduled Transaction.**\n- `unscheduled` - **Unscheduled sequential Transaction.**\n- `installment` - **Installment Transaction.**\n "
}
]
},
"currencyConversion": {
"allOf": [
{
"$ref": "#/$defs/CurrencyConversion"
},
{
"description": "The status of the currency conversion.\n\n\nValid Values
\n\n- `customerAccepted` - **The customer accepted the currency conversion rate.**\n- `customerRejected` - **The customer rejected the currency conversion rate.**\n- `notEligible` - **This transaction is not eligible for currency conversion.**\n\n "
}
]
},
"debtRepayment": {
"allOf": [
{
"$ref": "#/$defs/txnsDebtRepayment"
},
{
"description": "If this transaction is for debt repayment or not for debt repayment.\n\n\nValid Values
\n\n- `0` - **Transaction not for debt repayment.**\n\n- `1` - **Transaction for debt repayment.**\n\n "
}
]
},
"expiration": {
"type": "string",
"description": "The expiration date of this Transaction. \nThis field is stored as a text string in 'MMYY' format, where 'MM' is the number of a month and 'YY' is the last two digits of a year. For example, '0623' for June 2023. \nThe value must reflect a future date."
},
"fortxn": {
"type": "string",
"description": "If this Transaction is related to another Transaction, then this field is set to the identifier of the other Transaction. \nFor example, if this Transaction is a refund, this field could be set to the identifier of the original sale Transaction."
},
"fromtxn": {
"type": "string",
"description": "Reauthorize this referenced Transaction. For example, to process a resubmission of a declined Transaction or to reauthorize an expired Transaction."
},
"copyReason": {
"allOf": [
{
"$ref": "#/$defs/txnsCopyReasons"
},
{
"description": "Reason for copying Transaction referenced in fromtxn field, which\ncan be either resubmission or reauthorization.\n\nValid Values
\n\n - `resubmission` - **Resubmission.**\n - `reauthorization` - **Reauthorization.**\n\n "
}
]
},
"mobile": {
"allOf": [
{
"$ref": "#/$defs/txnsMobile"
},
{
"description": "Indicates if a transaction is being processed through a Mobile POS.\n\n\nValid Values
\n\n- `0` - **Non-mobile POS.**\n\n- `1` - **Mobile POS.**\n\n "
}
]
},
"origin": {
"allOf": [
{
"$ref": "#/$defs/txnOrigin"
},
{
"description": "The origin of the transaction.\n\n\nValid Values
\n\n- `0` - **Unknown.**\n\n- `1` - **Originated at a credit card terminal.**\n\n- `2` - **Originated through an eCommerce system.**\n\n- `3` - **Originated as a mail order or telephone order transaction.**\n\n- `4` - **Originated with Apple Pay.**\n\n- `5` - **Originated as a Successful 3D Secure transaction.**\n\n- `6` - **Originated as an Attempted 3D Secure transaction.**\n\n- `7` - **Deprecated. Originated as a recurring transaction on a card.**\n\n- `8` - **Originated in a PayFrame.**\n\n- `9` - **Originated in writing.**\n\n "
}
]
},
"pinEntryCapability": {
"allOf": [
{
"$ref": "#/$defs/txnsPinEntryCapability"
},
{
"description": "Indicates the PIN entry capability of the device, which can be unknown, capable, notCapable, or pinPadDown.\n\n\nValid Values
\n\n- `unknown` - **Unknown PIN Entry Capability.**\n- `capable` - **Terminal can accept PINs.**\n- `notCapable` - **Terminal cannot accept entry of PINs.**\n- `pinPadDown` - **Terminal PIN Pad is down.**\n\n "
}
]
},
"platform": {
"allOf": [
{
"$ref": "#/$defs/txnsPlatform"
},
{
"description": "The platform used to process transactions.\n\n\nValid Values
\n\n- `APPLE` - **The Apple Payment Processor (Deprecated).**\n- `ELAVON` - **The Elavon processor (Deprecated).**\n- `FIRSTDATA` - **The FirstData processor (Deprecated).**\n- `GOOGLE` - **The Google Payment Processor (Deprecated).**\n- `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n- `VCORE` - **The WorldPay (aka Vantiv) Core processor.**\n- `WELLSACH` - **The Wells Fargo ACH processor.**\n- `WELLSFARGO` - **The Wells Fargo Merchant Services processor (Deprecated).**\n- `WFSINGLE` - **The WFSINGLE processor (Deprecated).**\n\n "
}
]
},
"processedSequence": {
"type": "integer",
"description": "For entry creation and deletion job sequencing: the current processed sequence number for this transaction.",
"contentEncoding": "int32",
"default": 0
},
"funded": {
"type": "integer",
"description": "A date indicating when this Transaction was funded. \nThis field is set automatically.",
"contentEncoding": "int32"
},
"returned": {
"type": "string",
"description": "The transaction has been returned by the receiver."
},
"fundingEnabled": {
"allOf": [
{
"$ref": "#/$defs/txnsFundingEnabled"
},
{
"description": "Whether or not funding is enabled for this Transaction.\n\n\nValid Values
\n\n- `0` - **Disabled.**\n\n- `1` - **Enabled.**\n\n "
}
]
},
"fbo": {
"type": "string",
"description": "FBO (for benefit of) in which each entry origin belongs to."
},
"requestSequence": {
"type": "integer",
"description": "For entry creation and deletion job sequencing: the current processed sequence number for this transaction.",
"contentEncoding": "int32",
"default": 0
},
"statement": {
"type": "string",
"description": "The statement ID for which this transaction is being processed as payment."
},
"token": {
"type": "string",
"description": "The token of the Tokens resource this Transaction is associated with."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/txnType"
},
{
"description": "The type of Transaction.\n\n\nValid Values
\n\n- `1` - **Credit Card Only: Sale Transaction.** Processes a sale and charges the customer.\n- `2` - **Credit Card Only: Auth Transaction.** Authorizes and holds the requested total on the credit card.\n- `3` - **Credit Card Only: Capture Transaction.** Finalizes a prior Auth Transaction and charges the customer.\n- `4` - **Credit Card Only: Reverse Authorization.** Reverses a prior Auth or Sale Transaction and releases the credit hold.\n- `5` - **Credit Card Only: Refund Transaction.** Refunds a prior Capture or Sale Transaction (total may be specified for a partial refund).\n- `7` - **Echeck Only: Echeck Sale Transaction.** Sale Transaction for ECheck payment.\n- `8` - **Echeck Only: Echeck Refund Transaction.** Refund Transaction for prior ECheck Sale Transaction.\n- `11` - **Echeck Only: Echeck Redeposit Transaction.** Attempt to redeposit a prior failed eCheck Sale Transaction.\n- `12` - **Echeck Only: Echeck Account Verification Transaction.** Attempt to verify eCheck payment details.\n- `14` - **Incremental Authorization.**\n\n "
}
]
},
"unauthReason": {
"allOf": [
{
"$ref": "#/$defs/unauthReason"
},
{
"description": "The reason for the auth reversal. \nThis field is set to 'customerCancelled' by default.\n\n\nValid Values
\n\n- `incomplete` - **Transaction Incomplete.** \n\n- `timeout` - **Transaction Timeout.**\n\n- `clerkCancelled` - **Transaction Cancelled by Clerk.**\n\n- `customerCancelled` - **Transaction Cancelled by Customer.**\n\n- `misdispense` - **Misdispense.**\n\n- `hardwareFailure` - **Hardware Failure.**\n\n- `suspectedFraud` - **Suspected Fraud.**\n "
}
]
},
"authTokenCustomer": {
"type": "string",
"description": "The customer identifier from the AuthToken used during authentication."
},
"channel": {
"type": "string",
"description": "This field is stored as a text string and must be between 0 and 1000 characters long."
},
"cashback": {
"type": "integer",
"description": "The amount of the total sum of this Transaction that is given as cash back. \nThis field is specified as an integer in cents.",
"contentEncoding": "int64"
},
"clientIp": {
"type": "string",
"description": "The client ip address from which the Transaction was created. \nValid values are any Ipv4 or Ipv6 address."
},
"company": {
"type": "string",
"description": "The name of the company associated with this Transaction. \nSetting this field is especially important when processing an eCheck from a company."
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency for this transaction. See Currency codes for all valid values."
}
]
},
"fundingCurrency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency for which transaction was funded on. See Currency codes for all valid values."
}
]
},
"cvvStatus": {
"allOf": [
{
"$ref": "#/$defs/terminalTxnsCvvStatus"
},
{
"description": "The status of the CVV on the card.\n\n\nValid Values
\n\n- `notPresent` - **CVV is not present.**\n- `illegible` - **CVV is illegible.**\n- `notProvided` - **CVV was not provided.**\n\n "
}
]
},
"description": {
"type": "string",
"description": "A description of this Transaction. \nThis field is stored as a text string and must be between 0 and 1000 characters long."
},
"discount": {
"type": "integer",
"description": "The customer discount, in cents, already applied to the total for this transaction.",
"contentEncoding": "int64"
},
"duty": {
"type": "integer",
"description": "The amount of the total, in cents, that represents the duties charged to the customer",
"contentEncoding": "int64"
},
"email": {
"type": "string",
"description": "The email associated with this Transaction."
},
"swiped": {
"allOf": [
{
"$ref": "#/$defs/terminalTxnsSwiped"
},
{
"description": "Whether the card was swiped during this Transaction.\nThis field is set to '1' automatically if 'track' data was received. \n\n\nValid Values
\n\n- `0` - **Not Swiped.**\n- `1` - **Swiped.**\n\n "
}
]
},
"entryMode": {
"allOf": [
{
"$ref": "#/$defs/entryMode"
},
{
"description": "How payment information has been entered, including manually keyed entries, card swipes with track 1 or 2 data received, card dips with EMV chip data received, contactless card reads with track or EMV data received, and ApplePay read with cryptogram data received.\n\n\nValid Values
\n\n- `1` - **Manually keyed entry.**\n- `2` - **Card swiped. Track 1 received.**\n- `3` - **Card swiped. Track 2 received.**\n- `4` - **Card swiped. Track 1 & 2 received.**\n- `5` - **Card dipped. EMV chip received.**\n- `6` - **Contactless card read. Track or EMV data received.**\n- `7` - **Track Data from Card Swipe after EMV chip failure.**\n- `8` - **Track Data from Manually keyed entry after EMV chip failure.**\n- `9` - **ApplePay**\n- `10` - **Google Pay.**\n- `11` - **Merchant created transaction.**\n- `12` - **Invoice payment.**\n- `13` - **Merchant created transaction in payrix portal.**\n- `14` - **Invoice payment from payrix portal.**\n\n "
}
]
},
"fee": {
"type": "number",
"description": "Optional calculated fee amount indicator. This should be used in conjunction with txnFee setting on Fees resource, \nThis field is specified in cents(up to three decimal points)"
},
"first": {
"type": "string",
"description": "The first name associated with this Transaction. For eCheck transactions, either first or last is required."
},
"last": {
"type": "string",
"description": "The last name associated with this Transaction. For eCheck transactions, either first or last is required."
},
"merchant": {
"type": "string",
"description": "The identifier of the Merchant associated with this Transaction."
},
"mid": {
"type": "string",
"description": "The Merchant ID as set by the processor. \nThis field is stored as a text string and must be between 0 and 50 characters long."
},
"middle": {
"type": "string",
"description": "The middle name associated with this Transaction."
},
"order": {
"type": "string",
"description": "The identifier of the Order associated with this Transaction. \nThis field is stored as a text string and must be between 0 and 1000 characters long."
},
"pin": {
"allOf": [
{
"$ref": "#/$defs/terminalTxnsPin"
},
{
"description": "Whether this Transaction was verified with a PIN.\n\n\nValid Values
\n\n- `0` - **No PIN verification.**\n\n- `1` - **PIN verification.**\n\n "
}
]
},
"shipping": {
"type": "integer",
"description": "The amount of the total, in cents, that represents the shipping cost charged to the customer",
"contentEncoding": "int64"
},
"signature": {
"allOf": [
{
"$ref": "#/$defs/terminalTxnsSignature"
},
{
"description": "Whether a signature should be captured during this Transaction.\n\n* You can set this field if you want the terminal to take a signature for the Transaction.\n* The API also sets this field automatically if you associate a signature to the Transaction by creating a 'terminalTxnDatas' resource.\n\n\nValid Values
\n\n- `0` - **Not captured.**\n- `1` - **Captured.**\n\n "
}
]
},
"tax": {
"type": "integer",
"description": "The amount of the total sum of this Transaction that is made up of tax. \nThis field is specified as an integer in cents.",
"contentEncoding": "int64"
},
"surcharge": {
"type": "integer",
"description": "The amount of the total sum of this Transaction that is made up of surcharge. \nThis field is specified as an integer in cents.",
"contentEncoding": "int64"
},
"terminal": {
"type": "string",
"description": "The identifier of the terminal that processed this Transaction. \nThe identifier is taken from the terminal system and varies in format according to the type of terminal. \nThis field is stored as a text string and must be between 0 and 50 characters long."
},
"terminalCapability": {
"allOf": [
{
"$ref": "#/$defs/terminalTxnsTerminalCapability"
},
{
"description": "Capabilities of the terminal device.\n\n\nValid Values
\n\n- `1` - **Key entry only terminal.**\n- `2` - **Can read magnetic stripe.**\n- `3` - **Integrated circuit reader.**\n- `4` - **Can detect contactless payment.**\n\n "
}
]
},
"total": {
"type": "integer",
"description": "The total amount of this Transaction. \nThis field is specified as an integer in cents.For example, $10.15 would be entered as 1015.",
"contentEncoding": "int64"
},
"unattended": {
"allOf": [
{
"$ref": "#/$defs/terminalTxnsUnattended"
},
{
"description": "Whether the card was swiped at an unattended terminal during this Transaction.\nThis field is set to '0' by default.\n\nValid Values
\n\n- `0` - **Attended terminal.**\n- `1` - **Unattended terminal.**\n\n "
}
]
},
"address1": {
"type": "string",
"description": "The first line of the address associated with this Transaction. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"address2": {
"type": "string",
"description": "The second line of the address associated with this Transaction. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"city": {
"type": "string",
"description": "The name of the city in the address associated with this Transaction. \nThis field is stored as a text string and must be between 1 and 500 characters long."
},
"state": {
"type": "string",
"description": "The U.S. state or Canadian province relevant to the address provided here. If the location is within the U.S. and Canada, specify the 2-character postal abbreviation for the state. If the location is outside of the U.S. and Canada, provide the full state name. This field is stored as a text string and must be between 2 and 100 characters long.\n\n \n\nU.S. States
\n \n - `AK` - **Alaska (US)**\n \n - `AR` - **Arkansas (US)**\n \n - `AL` - **Alabama (US)**\n \n - `AZ` - **Arizona (US)**\n \n - `CA` - **California (US)**\n \n - `CO` - **Colorado (US)**\n \n - `CT` - **Connecticut (US)**\n \n - `DE` - **Delaware (US)**\n \n - `FL` - **Florida (US)**\n \n - `GA` - **Georgia (US)**\n \n - `HI` - **Hawaii (US)**\n \n - `IA` - **Iowa (US)**\n \n - `ID` - **Idaho (US)**\n \n - `IL` - **Illinois (US)**\n \n - `IN` - **Indiana (US)**\n \n - `KY` - **Kentucky (US)**\n \n - `KS` - **Kansas (US)**\n \n - `LA` - **Louisiana (US)**\n \n - `MA` - **Massachusetts (US)**\n \n - `MD` - **Maryland (US)**\n \n - `ME` - **Maine (US)**\n \n - `MI` - **Michigan (US)**\n \n - `MN` - **Minnesota (US)**\n \n - `MO` - **Missouri (US)**\n \n - `MS` - **Mississippi (US)**\n \n - `MT` - **Montana (US)**\n \n - `NC` - **North Carolina (US)**\n \n - `ND` - **North Dakota (US)**\n \n - `NE` - **Nebraska (US)**\n \n - `NH` - **New Hampshire (US)**\n \n - `NJ` - **New Jersey (US)**\n \n - `NM` - **New Mexico (US)**\n \n - `NV` - **Nevada (US)**\n \n - `NY` - **New York (US)**\n \n - `OH` - **Ohio (US)**\n \n - `OK`- **Oklahoma (US)**\n \n - `OR` - **Oregon (US)**\n \n - `PA` - **Pennsylvania (US)**\n \n - `RI` - **Rhode Island (US)**\n \n - `SC`- **South Carolina (US)**\n \n - `SD` - **South Dakota (US)**\n \n - `TN` - **Tennessee (US)**\n \n - `TX` - **Texas (US)**\n \n - `UT` - **Utah (US)**\n \n - `VA` - **Virginia (US)**\n \n - `VT` - **Vermont (US)**\n \n - `WA` - **Washington (US)**\n \n - `WI` - **Wisconsin (US)**\n \n - `WV` - **West Virginia (US)**\n \n - `WY` - **Wyoming (US)**\n \n\n\n\n \nCanada Provinces and Territories
\n \n - `AB` - **Alberta (CAN)**\n \n - `BC` - **British Columbia (CAN)**\n \n - `MB` - **Manitoba (CAN)**\n \n - `ON` - **Ontario (CAN)**\n \n - `NS` - **Nova Scotia (CAN)**\n \n - `NB` - **New Brunswick (CAN)**\n \n - `NL` - **Newfoundland and Labrador (CAN)**\n \n - `NT` - **Northwest Territories (CAN)**\n \n - `NU` - **Nunavut (CAN)**\n \n - `PE` - **Prince Edward Island (CAN)**\n \n - `QC` - **Quebec (CAN)**\n \n - `SK` - **Saskatchewan (CAN)**\n \n - `YT` - **Yukon (CAN)**\n "
},
"zip": {
"type": "string",
"description": "The ZIP code in the address associated with this Transaction. \nThis field is stored as a text string and must be between 1 and 20 characters long."
},
"country": {
"allOf": [
{
"$ref": "#/$defs/country"
},
{
"description": "The country associated with this transaction, valid values for this field are the 3-letter ISO code for the country."
}
]
},
"phone": {
"type": "string",
"description": "The phone number associated with this Transaction. \nThis field is stored as a text string and must be between 10 and 15 characters long."
},
"tmxSessionId": {
"type": "string",
"description": "Threatmetrix session ID. Not for partner/referrer use."
},
"firstTxn": {
"type": "string",
"description": "For external recurring systems, this is the first transaction ID related to this recurring payment."
},
"payment": {
"allOf": [
{
"$ref": "#/$defs/txnsPayment"
},
{
"description": "The payment method associated with this Transaction, including the card details."
}
]
}
}
},
"unauthReason": {
"title": "unauthReason",
"enum": [
"incomplete",
"timeout",
"clerkCancelled",
"customerCancelled",
"misdispense",
"hardwareFailure",
"suspectedFraud"
],
"type": "string"
},
"vendorsPostRequest": {
"title": "vendorsPostRequest",
"required": [
"entity",
"inactive",
"frozen"
],
"type": "object",
"properties": {
"entity": {
"allOf": [
{
"$ref": "#/$defs/vendorsPostRequestModelEntity"
},
{
"description": "The identifier of the Entity associated with this Vendor resource."
}
]
},
"division": {
"allOf": [
{
"$ref": "#/$defs/vendorsPostRequestModelDivision"
},
{
"description": "ID of the division associated with this vendor."
}
]
},
"onboardingContactEmails": {
"type": "string",
"description": "This holds the different emails the partners will want to be reached for onboarding related queries/concerns, this is a way of allowing the risk team to manage contacts more efficiently."
},
"riskContactEmails": {
"type": "string",
"description": "This holds the different emails the partners will want to be reached for risk related queries/concerns, this is a way of allowing the risk team to manage contacts more efficiently."
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n\nValid Values
\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n "
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n\nValid Values
\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n "
}
]
}
}
},
"vendorsPostRequestModelDivision": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/divisionsPostRequest"
},
{}
]
}
],
"description": "ID of the division associated with this vendor."
},
"vendorsPostRequestModelEntity": {
"anyOf": [
{
"type": "string"
},
{
"allOf": [
{
"$ref": "#/$defs/entitiesPostRequest"
},
{}
]
}
],
"description": "The identifier of the Entity associated with this Vendor resource."
}
}
}