{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/payrix/main/json-schema/payrix-billing-events-response-result-schema.json", "title": "billingEventsResponseResult", "x-generated": "2026-09-21", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/payrix-billing-events-api-openapi.yml#/components/schemas/billingEventsResponseResult", "type": "object", "properties": { "response": { "$ref": "#/$defs/billingEventsResponseItem" } }, "$defs": { "CurrencyConversion": { "title": "CurrencyConversion", "enum": [ "customerAccepted", "customerRejected", "notEligible" ], "type": "string" }, "CurrencyRatesFromCurrency": { "title": "CurrencyRatesFromCurrency", "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" }, "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" }, "accountCheckStage": { "title": "accountCheckStage", "const": "createAccount", "type": "string" }, "accountMethod": { "title": "accountMethod", "enum": [ 8, 9, 10, 11 ], "type": "integer" }, "accountPayment": { "title": "accountPayment", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "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": "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" }, "lastChecked": { "type": [ "integer", "null" ], "description": "Times timestamp with last time payment was checked.", "contentEncoding": "int32" }, "mask": { "type": "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
" } ] } } }, "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" }, "accountsModelAccount": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/accountPayment" } ], "description": "The identifier of the Payment associated with this Account." }, "accountsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this Account." }, "accountsReserved": { "title": "accountsReserved", "enum": [ 0, 1, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer" }, "accountsResponse": { "title": "accountsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/accountsModelEntity" }, { "description": "The identifier of the Entity associated with this Account." } ] }, "account": { "allOf": [ { "$ref": "#/$defs/accountsModelAccount" }, { "description": "The identifier of the Payment associated with this Account." } ] }, "token": { "type": "string", "description": "A unique token that can be used to refer to this Account in other parts of the API." }, "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
" } ] }, "reserved": { "allOf": [ { "$ref": "#/$defs/accountsReserved" }, { "description": "Indicates whether the Account is reserved and the action that will be taken as a result.\n\n
\nValid Values\n\n- `0` - **No reserve.**\n- `1` - **Block transaction, will never be processed. The Entity is sent to the manual review queue..**\n- `3` - **Hold transaction, will not be captured.**\n- `4` - **Reserve transaction, funds should be reserved.**\n- `5` - **Block current activity, no change for merchant.**\n- `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**\n- `7` - **We did not have policies to process.**\n- `8` - **We onboard the merchant and wait for manual check later.**\n- `9` - **Schedule the automatic release of the reserve.**\n- `10` - **Hold transaction, will not be captured. Automatic release when the associated sale is done.**\n\n
" } ] }, "checkStage": { "allOf": [ { "$ref": "#/$defs/accountCheckStage" }, { "description": "The last stage completed for risk.\n\n
\nValid Values\n\n- `createAccount` - **Create Account**\n\n
" } ] }, "expiration": { "type": "string", "description": "The expiration date of the related debit account. \nThe 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
" } ] }, "plaidAccountId": { "type": "string", "description": "The account identifier that is returned by the Plaid flow." }, "updateMethod": { "allOf": [ { "$ref": "#/$defs/accountsUpdateMethod" }, { "description": "The method used to update the account.\n\n
\nValid Values\n\n- `NOC` - **Notification of change**\n- `PLAID` - **Plaid.**\n- `MANUAL` - **Manual**\n\n
" } ] }, "changeRequests": { "type": "array", "items": { "$ref": "#/$defs/changeRequest" }, "description": "" }, "paymentUpdates": { "type": "array", "items": { "$ref": "#/$defs/paymentUpdatesResponse" }, "description": "" }, "payouts": { "type": "array", "items": { "$ref": "#/$defs/payoutsResponse" }, "description": "" } } }, "accountsUpdateMethod": { "title": "accountsUpdateMethod", "enum": [ "NOC", "PLAID", "MANUAL" ], "type": "string" }, "adjustmentsModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "The identifier of the Disbursement associated with this Adjustment." }, "adjustmentsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this Account." }, "adjustmentsModelFromentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The applicable Entity for this Adjustment. \nThis field is an optional field." }, "adjustmentsModelFunding": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entityRefsResponse" } ], "description": "The ID of the fund which the disbursement’s movement applies." }, "adjustmentsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that created this resource." }, "adjustmentsModelOnentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this Adjustment." }, "adjustmentsResponse": { "title": "adjustmentsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/adjustmentsModelLogin" }, { "description": "The identifier of the Login that created this resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/adjustmentsModelEntity" }, { "description": "The identifier of the Entity associated with this Account." } ] }, "fromentity": { "allOf": [ { "$ref": "#/$defs/adjustmentsModelFromentity" }, { "description": "The applicable Entity for this Adjustment. \nThis field is an optional field." } ] }, "onentity": { "allOf": [ { "$ref": "#/$defs/adjustmentsModelOnentity" }, { "description": "The identifier of the Entity associated with this Adjustment." } ] }, "disbursement": { "allOf": [ { "$ref": "#/$defs/adjustmentsModelDisbursement" }, { "description": "The identifier of the Disbursement associated with this Adjustment." } ] }, "description": { "type": "string", "description": "The description of this Decision Rule. \nThis field is stored as a text string and must be between 0 and 100 characters long." }, "amount": { "type": "number", "description": "The amount of the Adjustment, This field is specified in cents(up to three decimal points)." }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency for the amount of this resource. See Currency codes for all valid values." } ] }, "funding": { "allOf": [ { "$ref": "#/$defs/adjustmentsModelFunding" }, { "description": "The ID of the fund which the disbursement’s movement applies." } ] }, "platform": { "type": "string", "description": "The processor that issued this terminalTxnRef.\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
" }, "fbo": { "type": "string", "description": "FBO account (For-Benefit-Of account) identifier." }, "entry": { "$ref": "#/$defs/entriesResponse" }, "entryOrigins": { "type": "array", "items": { "$ref": "#/$defs/entryOriginsResponse" }, "description": "" }, "pendingEntry": { "$ref": "#/$defs/pendingEntriesResponse" } } }, "aggregationDefault": { "title": "aggregationDefault", "enum": [ 0, 1 ], "type": "integer" }, "aggregationResultGroupsModelAggregation": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/aggregationsResponse" } ], "description": "The identifier of the Aggregation that this AggregationResult refers to." }, "aggregationResultGroupsResponse": { "title": "aggregationResultGroupsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "aggregation": { "allOf": [ { "$ref": "#/$defs/aggregationResultGroupsModelAggregation" }, { "description": "The identifier of the Aggregation that this AggregationResult refers to." } ] }, "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
" } ] }, "search": { "type": "string", "description": "The search query used to find records and apply the desired calculation. This field is stored as a text string, must be between 0 and 1000 characters long, and is copied from the aggregation." }, "totals": { "type": "string", "description": "The especification of the desired aggregation functions including count, sum, min and max. This field is stored as a text string, must be between 1 and 100 characters long, and is copied from the aggregation." }, "degrouping": { "type": "string", "description": "Degrouping is the reverse process of grouping, where progressively smaller groups are removed to provide aggregated results at higher levels. This is useful when you want to see overall totals without the detailed breakdowns. For example, degrouping can be used to sum up all transactions across all merchants and payment methods, providing a total approval count without needing to look at individual merchant or payment method details." }, "lastModified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "The last modified date and time. The format should be YYYY-MM-DD HH:MM:SS" }, "effective": { "type": "integer", "description": "Effective date time of aggregation.", "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
" } ] }, "type": { "type": "string", "description": "The type of aggregation which auto-sets the search and total values." }, "level": { "type": "string", "description": "The level of user the aggregation should be processed for (similar to Decisions.level)." }, "aggregationResults": { "type": "array", "items": { "$ref": "#/$defs/aggregationResultsResponse" }, "description": "" } } }, "aggregationResultsModelAggregationResultGroup": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/aggregationResultGroupsResponse" } ], "description": "The identifier of the AggregationResultGroup that this AggregationResult refers to." }, "aggregationResultsResponse": { "title": "aggregationResultsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "aggregationResultGroup": { "allOf": [ { "$ref": "#/$defs/aggregationResultsModelAggregationResultGroup" }, { "description": "The identifier of the AggregationResultGroup that this AggregationResult refers to." } ] }, "grouping": { "type": "string", "description": "Grouping is a process used in data aggregation to organize data into specific categories or groups based on certain attributes. This allows for detailed analysis and reporting on subsets of data. For example, grouping transactions by merchant and payment method enables you to see the breakdown of transactions for each merchant and payment method combination." }, "field": { "type": "string", "description": "The field of the resource where calculations were made based on. \nThis field is stored as a text string and must be between 1 and 100 characters long." }, "count": { "type": "integer", "description": "The value calculated by the count aggregation function. \nThis field is specified as an integer.", "contentEncoding": "int64" }, "sum": { "type": "number", "description": "The value calculated by the sum aggregation function. \nThis field is specified in cents(up to three decimal points)." }, "min": { "type": "number", "description": "The value calculated by the min aggregation function. \nThis field is specified in cents(up to three decimal points)." }, "max": { "type": "number", "description": "The value calculated by the max aggregation function. \nThis field is specified in cents(up to three decimal points)." } } }, "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" }, "aggregationsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division that this Aggregation applies to." }, "aggregationsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this Account." }, "aggregationsModelForlogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that this Aggregation applies to." }, "aggregationsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that created this resource." }, "aggregationsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org that this Aggregation applies to." }, "aggregationsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition that this Aggregation applies to." }, "aggregationsModelTeam": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/teamsResponse" } ], "description": "The identifier of the Team that this Aggregation applies to." }, "aggregationsResponse": { "title": "aggregationsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/aggregationsModelLogin" }, { "description": "The identifier of the Login that created this resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/aggregationsModelEntity" }, { "description": "The identifier of the Entity associated with this Account." } ] }, "forlogin": { "allOf": [ { "$ref": "#/$defs/aggregationsModelForlogin" }, { "description": "The identifier of the Login that this Aggregation applies to." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/aggregationsModelOrg" }, { "description": "The identifier of the Org that this Aggregation applies to." } ] }, "team": { "allOf": [ { "$ref": "#/$defs/aggregationsModelTeam" }, { "description": "The identifier of the Team that this Aggregation applies to." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/aggregationsModelDivision" }, { "description": "The identifier of the Division that this Aggregation applies to." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/aggregationsModelPartition" }, { "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
" } ] }, "search": { "type": "string", "description": "The search query used to find records and apply the desired calculation. This field is stored as a text string and must be between 0 and 1000 characters long." }, "totals": { "type": "string", "description": "The specification of the desired aggregation functions including count, sum, min and max. This field is stored as a text string and must be between 1 and 100 characters long." }, "degrouping": { "type": "string", "description": "Degrouping is the reverse process of grouping, where progressively smaller groups are removed to provide aggregated results at higher levels. This is useful when you want to see overall totals without the detailed breakdowns. For example, degrouping can be used to sum up all transactions across all merchants and payment methods, providing a total approval count without needing to look at individual merchant or payment method details." }, "status": { "allOf": [ { "$ref": "#/$defs/aggregationStatus" }, { "description": "The current status of the aggregation process.\n\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" }, "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
" } ] }, "aggregationResultGroups": { "type": "array", "items": { "$ref": "#/$defs/aggregationResultGroupsResponse" }, "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
" } ] } } }, "alertActionType": { "title": "alertActionType", "enum": [ "email", "web", "app", "sms" ], "type": "string" }, "alertActionsMaxAttemptsTempDisabled": { "title": "alertActionsMaxAttemptsTempDisabled", "enum": [ 0, 1 ], "type": "integer" }, "alertActionsModelAlert": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/alertsResponse" } ], "description": "The identifier of the Alert resource that defines this alertAction." }, "alertActionsResponse": { "title": "alertActionsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "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. The field should be set to an email address if the type is email, an endpoint if the type is web, etc." }, "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." }, "retries": { "type": "integer", "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
" } ] }, "alert": { "allOf": [ { "$ref": "#/$defs/alertActionsModelAlert" }, { "description": "The identifier of the Alert resource that defines this alertAction." } ] }, "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
" } ] } } }, "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" }, "alertTriggersModelAlert": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/alertsResponse" } ], "description": "The identifier of the Alert resource that you want to invoke with this trigger." }, "alertTriggersResponse": { "title": "alertTriggersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "alert": { "allOf": [ { "$ref": "#/$defs/alertTriggersModelAlert" }, { "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
" } ] }, "name": { "type": "string", "description": "The name of this alertTrigger. \nThis field is stored as a text string and must be between 0 and 100 characters long." }, "description": { "type": "string", "description": "Description of Alert Triggers." }, "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
" } ] } } }, "alertsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division that this Alert applies to." }, "alertsModelForlogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that this Alert applies to." }, "alertsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that created this resource." }, "alertsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The partition for which this Alerts applies." }, "alertsModelTeam": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/teamsResponse" } ], "description": "The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team." }, "alertsResponse": { "title": "alertsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/alertsModelLogin" }, { "description": "The identifier of the Login that created this resource." } ] }, "forlogin": { "allOf": [ { "$ref": "#/$defs/alertsModelForlogin" }, { "description": "The identifier of the Login that this Alert applies to." } ] }, "team": { "allOf": [ { "$ref": "#/$defs/alertsModelTeam" }, { "description": "The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/alertsModelDivision" }, { "description": "The identifier of the Division that this Alert applies to." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/alertsModelPartition" }, { "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/alertActionsResponse" }, "description": "" }, "alertTriggers": { "type": "array", "items": { "$ref": "#/$defs/alertTriggersResponse" }, "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
" } ] } } }, "appleDomainStatus": { "title": "appleDomainStatus", "enum": [ "registration_requested", "registering", "registered", "failed_registration", "unregistration_requested", "unregistering", "unregistered" ], "type": "string" }, "appleDomainsModelOwnerEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that controls this domain. This is to identify the Vendor or Facilitator hosting the Apple Pay domain for the merchant. If this domain is controlled by the actual registered Merchant, the Entity field will be the Merchant's Entity." }, "appleDomainsModelRegisteredMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant registered with Apple Pay for this domain." }, "appleDomainsResponse": { "title": "appleDomainsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "registeredMerchant": { "allOf": [ { "$ref": "#/$defs/appleDomainsModelRegisteredMerchant" }, { "description": "The identifier of the Merchant registered with Apple Pay for this domain." } ] }, "ownerEntity": { "allOf": [ { "$ref": "#/$defs/appleDomainsModelOwnerEntity" }, { "description": "The identifier of the Entity that controls this domain. This is to identify the Vendor or Facilitator hosting the Apple Pay domain for the merchant. If this domain is controlled by the actual registered Merchant, the Entity field will be the Merchant's Entity." } ] }, "status": { "allOf": [ { "$ref": "#/$defs/appleDomainStatus" }, { "description": "The registration status of this domain for the given Registered Merchant.\n
\nValid Values\n\n- `registration_requested` **The domains that have been requested to be registered.**\n- `registering` **In the process of being registered with Apple.**\n- `registered` **Successfully Registered with Apple.**\n- `failed_registration` **A Failure occurred Registering.**\n- `unregistration_requested` **Unregistration requested.**\n- `unregistering` **In the process of being un-registered from Apple.**\n- `unregistered` **Successfully Unregistered with Apple.**\n
" } ] }, "domain": { "type": "string", "description": "The domain(FQDN) associated with the Registered Merchant." }, "errorNote": { "type": "string", "description": "For a failed Registration or Un-Registration, will contain the reason for the failure." } } }, "assessmentEvent": { "title": "assessmentEvent", "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, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 101, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 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 ], "type": "integer" }, "assessmentsModelChargeback": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebacksResponse" } ], "description": "The identifier of the Chargeback that this assessment resource refers to." }, "assessmentsModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "The identifier of the Disbursement that this assessment resource refers to." }, "assessmentsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this assessment." }, "assessmentsModelEventId": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the record that is associated with this assessments resource." }, "assessmentsModelFee": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/feesResponse" } ], "description": "The identifier of the Fee that this assessment resource refers to." }, "assessmentsModelForentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this assessment applies to. \nAn opposing assessment is associated with this entity." }, "assessmentsModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant that this assessment resource refers to." }, "assessmentsModelOnentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this assessment refers to. This is the owner of the record that triggered the charge." }, "assessmentsModelOpposingAssessment": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/assessmentsResponse" } ], "description": "The identifier of the Assessment of the `forentity` assessment." }, "assessmentsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition that this assessment resource refers to." }, "assessmentsModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the Txn that this assessment resource refers to." }, "assessmentsResponse": { "title": "assessmentsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/assessmentsModelEntity" }, { "description": "The identifier of the Entity associated with this assessment." } ] }, "onentity": { "allOf": [ { "$ref": "#/$defs/assessmentsModelOnentity" }, { "description": "The identifier of the Entity that this assessment refers to. This is the owner of the record that triggered the charge." } ] }, "forentity": { "allOf": [ { "$ref": "#/$defs/assessmentsModelForentity" }, { "description": "The identifier of the Entity that this assessment applies to. \nAn opposing assessment is associated with this entity." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/assessmentsModelPartition" }, { "description": "The identifier of the Partition that this assessment resource refers to." } ] }, "opposingAssessment": { "allOf": [ { "$ref": "#/$defs/assessmentsModelOpposingAssessment" }, { "description": "The identifier of the Assessment of the `forentity` assessment." } ] }, "fee": { "allOf": [ { "$ref": "#/$defs/assessmentsModelFee" }, { "description": "The identifier of the Fee that this assessment resource refers to." } ] }, "disbursement": { "allOf": [ { "$ref": "#/$defs/assessmentsModelDisbursement" }, { "description": "The identifier of the Disbursement that this assessment resource refers to." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/assessmentsModelTxn" }, { "description": "The identifier of the Txn that this assessment resource refers to." } ] }, "chargeback": { "allOf": [ { "$ref": "#/$defs/assessmentsModelChargeback" }, { "description": "The identifier of the Chargeback that this assessment resource refers to." } ] }, "merchant": { "allOf": [ { "$ref": "#/$defs/assessmentsModelMerchant" }, { "description": "The identifier of the Merchant that this assessment resource refers to." } ] }, "event": { "allOf": [ { "$ref": "#/$defs/assessmentEvent" }, { "description": "The type of event that triggered this assessments resource.\n\n
\nValid Values\n\n- `1` - **DAYS**. This assessment triggers every day.\n- `2` - **WEEKS**. This assessment triggers every week.\n- `3` - **MONTHS**. This assessment triggers every month.\n- `4` - **YEARS**. This assessment triggers every year.\n- `5` - **SINGLE**. This assessment is a one-off event.\n- `6` - **AUTH**. This assessment triggers at the time of authorization of a transaction.\n- `7` - **CAPTURE**. This assessment triggers at the capture time of a Transaction.\n- `8` - **REFUND**. This assessment triggers when Refund transaction is processed.\n- `9` - **BOARD**. This assessment triggers when the Merchant is boarded.\n- `10` - **PAYOUT**. This assessment triggers when a payout is processed.\n- `11` - **CHARGEBACK**. This assessment triggers when a card chargeback occurs.\n- `12` - **OVERDRAFT**. This assessment triggers when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE**. This assessment triggers when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR**. This assessment triggers when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL**. This assessment triggers when an automated clearing house failure occurs.\n- `16` - **ACCOUNT**. This assessment triggers when a bank account is verified.\n- `17` - **SIFT**. This assessment triggers on the Transaction fraud score.\n- `18` - **ADJUSTMENT**. This assessment triggers when the transaction is adjusted.\n- `19` - **RETRIEVAL**. This assessment triggers on Retrieval Request Chargeback.\n- `20` - **ARBITRATION**. This assessment triggers on an Arbitration Chargeback.\n- `21` - **ECSALE**. This assessment triggers on an eCheck Sale transaction.\n- `22` - **ECREFUND**. This assessment triggers on an eCheck Refund transaction.\n- `23` - **ECRETURN**. This assessment triggers on an eCheck Return transaction.\n- `24` - **SETTLEMENT**. This assessment triggers on a transaction settlement.\n- `25` - **MISUSE**. This assessment triggers on a Misuse of authorization.\n- `26` - **PROFIT_SHARE**. This assessment triggers on a Profit Sharing entry event.\n- `27` - **UNAUTH**. This assessment triggers at the time of an unauthorized entry.\n- `28` - **ACHNOC**. This assessment triggers at the time of an ACH Notification Change.\n- `29` - **ECNOC**. This assessment triggers at the time of an eCheck Notification Change.\n- `30` - **ECFAIL**. This assessment triggers at the time of an eCheck Fail.\n- `31` - **ECNSF**. This assessment triggers an the time of an eCheck non-disbursed funds.\n- `32` - **CURRENCY_CONVERSION**. This assessment triggers at the time of a currency conversion.\n- `33` - **TERMINAL_TXN**. This assessment triggers at the time of a terminal transaction.\n- `34` - **REVERSE_PAYOUT**. This assessment triggers when a payout has been partially reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT**. This assessment triggers when a payout is partially reversed.\n- `43` - **PAYMENT_CHECK** Single payment check (deprecated).\n- `44` - **PAYMENT_UPDATE**. This assessment triggers on a payment update for Account Updater.\n- `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).\n- `46` - **PAYMENT_GROUP_UPDATE**. This assessment triggers on a payment group update for Account Updater.\n- `47` - **ENTRY_REFUND**. This assessment triggers on an entry refund.\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through Risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees\n- `701` - **NYCE_ANNUAL_FEE**\n- `702` - **PULSE_ANNUAL_FEE**\n- `703` - **CU24_ANNUAL_FEE**\n- `704` - **STAR_ANNUAL_FEE**\n- `705` - **ACCEL_ANNUAL_FEE**\n- `801` - **INGENICO_LINK_2500**, Canada (inactive)\n- `802` - **INGENICO_LANE_3600_STD**, Canada\n- `803` - **INGENICO_LANE_3600_DLX**, Canada (inactive)\n- `804` - **INGENICO_LANE_7000_STD**, Canada\n- `805` - **INGENICO_LANE_7000_DLX**, Canada (inactive)\n- `806` - **INGENICO_MOVE_5000**, Canada (inactive) \n
" } ] }, "eventId": { "allOf": [ { "$ref": "#/$defs/assessmentsModelEventId" }, { "description": "The identifier of the record that is associated with this assessments resource." } ] }, "description": { "type": "string", "description": "A description of this assessments resource." }, "amount": { "type": "number", "description": "The amount involved in this assessments resource. It refers to the amount charged, transferred, or disbursed. \nThis field is specified in cents(up to three decimal points)" }, "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
" } ] }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency of the amount in this assessments resource. See Currency codes for all valid values." } ] }, "opposingAssessments": { "$ref": "#/$defs/assessmentsResponse" } } }, "bankAccountUpdateStopEmail": { "title": "bankAccountUpdateStopEmail", "enum": [ 0, 1 ], "type": "integer" }, "batchStatus": { "title": "batchStatus", "enum": [ "open", "closed" ], "type": "string" }, "batchesModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant that is associated with this Batch." }, "batchesResponse": { "title": "batchesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "merchant": { "allOf": [ { "$ref": "#/$defs/batchesModelMerchant" }, { "description": "The identifier of the Merchant that is associated with this Batch." } ] }, "date": { "type": "string", "description": "The date the batch was first opened.", "contentEncoding": "date" }, "processingDate": { "type": "string", "description": "The date the batch was sent to the processor for processing.", "contentEncoding": "date" }, "processingId": { "type": "string", "description": "Internal ID set for processing." }, "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." }, "closeTime": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "The default batches close time. The format should be YYYY-MM-DD HH:MM:SS" }, "batchRefs": { "type": "array", "items": {}, "description": "" }, "txns": { "type": "array", "items": { "$ref": "#/$defs/txnsResponse" }, "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
" } ] } } }, "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" }, "billingEventsModelBilling": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/billingsResponse" } ], "description": "The identifier of the Billing that this billingEvent applies to." }, "billingEventsResponse": { "title": "billingEventsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "billing": { "allOf": [ { "$ref": "#/$defs/billingEventsModelBilling" }, { "description": "The identifier of the Billing that this billingEvent applies to." } ] }, "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
" } ] } } }, "billingEventsResponseItem": { "title": "billingEventsResponseItem", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/$defs/billingEventsResponse" }, "description": "The data object that the API returns for this request." }, "details": { "allOf": [ { "$ref": "#/$defs/details" }, { "description": "An object describing the response, including the request ID and pagination indicators." } ] }, "errors": { "type": "array", "items": { "$ref": "#/$defs/errorItem" }, "description": "An array of zero or more errors that occurred when the API processed the request." } } }, "billingModifiersModelBilling": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/billingsResponse" } ], "description": "The identifier of the Billing that this Billing Modifier applies to." }, "billingModifiersModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division that this Billing Modifier applies to." }, "billingModifiersModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this Billing Modifier applies to." }, "billingModifiersModelFromentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that is responsible for paying this Bill on behalf of the Entity specified in the 'entity' field." }, "billingModifiersModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org that this Billing Modifier applies to." }, "billingModifiersModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition that this Billing Modifier applies to." }, "billingModifiersResponse": { "title": "billingModifiersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "billing": { "allOf": [ { "$ref": "#/$defs/billingModifiersModelBilling" }, { "description": "The identifier of the Billing that this Billing Modifier applies to." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/billingModifiersModelEntity" }, { "description": "The identifier of the Entity that this Billing Modifier applies to." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/billingModifiersModelOrg" }, { "description": "The identifier of the Org that this Billing Modifier applies to." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/billingModifiersModelDivision" }, { "description": "The identifier of the Division that this Billing Modifier applies to." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/billingModifiersModelPartition" }, { "description": "The identifier of the Partition that this Billing Modifier applies to." } ] }, "fromentity": { "allOf": [ { "$ref": "#/$defs/billingModifiersModelFromentity" }, { "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" }, "billingsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division associated with this vendor." }, "billingsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The alphanumeric identifier of the Entity associated with this Account." }, "billingsModelForentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The alphanumeric identifier of the Entity associated with this Account." }, "billingsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "billingsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org associated with this invoiceParameter." }, "billingsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition associated with this invoiceParameter." }, "billingsResponse": { "title": "billingsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/billingsModelLogin" }, { "description": "The Login that owns this resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/billingsModelEntity" }, { "description": "The alphanumeric identifier of the Entity associated with this Account." } ] }, "forentity": { "allOf": [ { "$ref": "#/$defs/billingsModelForentity" }, { "description": "The alphanumeric identifier of the Entity associated with this Account." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/billingsModelOrg" }, { "description": "The identifier of the Org associated with this invoiceParameter." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/billingsModelDivision" }, { "description": "The identifier of the Division associated with this vendor." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/billingsModelPartition" }, { "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" }, "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" }, "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" }, "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
" } ] }, "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
" } ] }, "billingEvents": { "type": "array", "items": { "$ref": "#/$defs/billingEventsResponse" }, "description": "" }, "billingModifiers": { "type": "array", "items": { "$ref": "#/$defs/billingModifiersResponse" }, "description": "" }, "payoutFlows": { "type": "array", "items": { "$ref": "#/$defs/payoutFlowsResponse" }, "description": "" }, "payouts": { "type": "array", "items": { "$ref": "#/$defs/payoutsResponse" }, "description": "" }, "plans": { "type": "array", "items": { "$ref": "#/$defs/plansResponse" }, "description": "" }, "statementEntries": { "type": "array", "items": { "$ref": "#/$defs/statementEntriesResponse" }, "description": "" }, "statements": { "type": "array", "items": { "$ref": "#/$defs/statementsResponse" }, "description": "" } } }, "binLocationType": { "title": "binLocationType", "enum": [ "branch", "main" ], "type": "string" }, "binMethod": { "title": "binMethod", "enum": [ 0, 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 ], "type": "integer" }, "binsBillPayEnabled": { "title": "binsBillPayEnabled", "enum": [ 0, 1 ], "type": "integer" }, "binsCategory": { "title": "binsCategory", "enum": [ "classic", "business", "corporate", "fleet", "hsaFsa", "platinum", "prepaid", "coreCard", "personal", "standard", "other", "international" ], "type": "string" }, "binsDebitOverCreditEnabled": { "title": "binsDebitOverCreditEnabled", "enum": [ 0, 1 ], "type": "integer" }, "binsModelBilling": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/billingsResponse" } ], "description": "The identifier of the Billing that this Bin is associated with." }, "binsModelEventSchedule": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/feesResponse" } ], "description": "The identifier of the EventSchedule that this Bin is associated with." }, "binsPinlessSupport": { "title": "binsPinlessSupport", "enum": [ "none", "restricted", "full" ], "type": "string" }, "binsResponse": { "title": "binsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "bin": { "type": "string", "description": "The first 6 digits of the card used in a Transaction." }, "method": { "allOf": [ { "$ref": "#/$defs/binMethod" }, { "description": "The type of payment method used for this transaction.\n\n
\nValid Values\n\n- `0` - **Unknown Payment Method**\n- `1` - **American Express**\n- `2` - **Visa**\n- `3` - **MasterCard**\n- `4` - **Diners Club**\n- `5` - **Discover**\n- `6` - **PayPal**\n- `7` - **Debit Card**\n- `8` - **Checking Account**\n- `9` - **Savings Account**\n- `10` - **Corporate Checking Account**\n- `11` - **Corporate Savings Account**\n- `12` - **Gift Card**\n- `13` - **EBT (Electronic Benefits Transfer) Card**\n- `14` - **WIC (Women, Infants and Children) Card**\n- `15` - **Accel**\n- `16` - **ATH**\n- `17` - **AFFN**\n- `18` - **Culiance**\n- `19` - **Interlink**\n- `20` - **Jeanie**\n- `21` - **Maestro**\n- `22` - **NYCE**\n- `23` - **Pulse**\n- `24` - **Shazam**\n- `25` - **Star**\n- `26` - **Interac**\n- `27` - **OmniToken**\n\n
" } ] }, "type": { "allOf": [ { "$ref": "#/$defs/binsType" }, { "description": "The type of the card used in the Transaction.\n\n
\nValid Values\n\n- `credit` - **Credit Card**\n- `debit` - **Debit Card**\n- `debitCredit` - **Debit or Credit Card**\n- `charge` - **Charge Card**\n- `prepaid` - **Prepaid Debit Card**\n- `bankAccount` - **Bank Account Card**\n\n
" } ] }, "category": { "allOf": [ { "$ref": "#/$defs/binsCategory" }, { "description": "The category of the account product.\n\n
\nValid Values\n\n- `classic` - **Classic credit or debit card.**\n- `business` - **Business credit or debit card.**\n- `corporate` - **Corporate credit or debit card.**\n- `fleet` - **Fleet card for transportation-related expenses.**\n- `hsaFsa` - **HSA (Health Savings Account) or FSA (Flexible Spending Account) card.**\n- `platinum` - **Platinum credit card.**\n- `prepaid` - **Prepaid card.**\n- `coreCard` - **Core card.**\n- `personal` - **Personal account.**\n- `standard` - **Standard account.**\n- `other` - **Other type of account.**\n- `international` - **International account.**\n\n
" } ] }, "name": { "type": "string", "description": "The name of the bank that issued the card used in the Transaction." }, "address": { "type": "string", "description": "Street address of the bank." }, "city": { "type": "string", "description": "City of the bank." }, "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
" }, "country": { "allOf": [ { "$ref": "#/$defs/country" }, { "description": "The country of the bank that issued the card used in the Transaction." } ] }, "zip": { "type": "string", "description": "Zip code of the banking institution." }, "locationType": { "allOf": [ { "$ref": "#/$defs/binLocationType" }, { "description": "The type of location of this banking institution. Used in `bankAccount` type bins.\n\n
\nValid Values\n\n - `branch` - **Branch location.**\n - `main` - **Main headquarters.**\n\n
" } ] }, "newBin": { "type": "string", "description": "The BIN (Bank Issuer Number) or routing number that replaces or supersedes this bin." }, "website": { "type": "string", "description": "The website of the bank that issued the card used in the Transaction." }, "phone": { "type": "string", "description": "The phone of the bank that issued the card used in the Transaction." }, "transferEnabled": { "allOf": [ { "$ref": "#/$defs/binsTransferEnabled" }, { "description": "Whether funds may be “pushed” to this debit card (with push-to-card).\n\n
\nValid Values\n\n- `0` - **Push-to-card transfer disabled.**\n- `1` - **Push-to-card transfer enabled.**\n\n
" } ] }, "numberLength": { "type": "integer", "description": "The amount of digits expected for account numbers with this bin.", "contentEncoding": "int32" }, "debitOverCreditEnabled": { "allOf": [ { "$ref": "#/$defs/binsDebitOverCreditEnabled" }, { "description": "Whether this debit card may be charged as credit over the credit networks.\n\n
\nValid Values\n\n- `0` - **Debit charge as 'credit' disabled.**\n- `1` - **Debit charge as 'credit' enabled.**\n\n
" } ] }, "billPayEnabled": { "allOf": [ { "$ref": "#/$defs/binsBillPayEnabled" }, { "description": "Whether this card may be used for bill pay features.\n\n
\nValid Values\n\n- `0` - **Bill pay capability disabled.**\n- `1` - **Bill pay capability enabled.**\n\n
" } ] }, "pinlessSupport": { "allOf": [ { "$ref": "#/$defs/binsPinlessSupport" }, { "description": "What type of pinless charging is allowed on this debit card.\n\n
\nValid Values\n\n- `none` - **No pinless support, PIN (Personal Identification Number) must always be provided.**\n- `restricted` - **Some pinless support, PIN (Personal Identification Number) may not always be necessary.**\n- `full` - **Full pinless support, PIN (Personal Identification Number) may be omitted for pinless payments.**\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
" } ] }, "billing": { "allOf": [ { "$ref": "#/$defs/binsModelBilling" }, { "description": "The identifier of the Billing that this Bin is associated with." } ] }, "eventSchedule": { "allOf": [ { "$ref": "#/$defs/binsModelEventSchedule" }, { "description": "The identifier of the EventSchedule that this Bin is associated with." } ] } } }, "binsTransferEnabled": { "title": "binsTransferEnabled", "enum": [ 0, 1 ], "type": "integer" }, "binsType": { "title": "binsType", "enum": [ "credit", "debit", "debitCredit", "charge", "prepaid", "bankAccount" ], "type": "string" }, "changeManagementEnabled": { "title": "changeManagementEnabled", "enum": [ 0, 1 ], "type": "integer" }, "changeRequest": { "title": "changeRequest", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "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. The format should be YYYY-MM-DD HH:MM:SS" }, "login": { "allOf": [ { "$ref": "#/$defs/changeRequestModelLogin" }, { "description": "The identifier of the Login associated with this ChangeRequest." } ] }, "authType": { "type": "integer", "description": "Auth Type that originate the request.", "contentEncoding": "int32" }, "operation": { "allOf": [ { "$ref": "#/$defs/changeRequestOperation" }, { "description": "The operation being performed on the resource.\n\n
\nValid Values\n\n- `create` - **When creating a model.**\n- `update` - **When updating a model.**\n\n
" } ] }, "status": { "allOf": [ { "$ref": "#/$defs/changeRequestStatus" }, { "description": "The status of the requested change.\n\n
\nValid Values\n\n- `pending` - **The Change Request has a pending status.**\n- `manualReview` - **The Change Request was escalated to be manually reviewed.**\n- `approved` - **The Change Request has been approved.**\n- `declined` - **The Change Request was declined.**\n\n
" } ] }, "reasonType": { "type": "string", "description": "A type which categorizes the reason, in case the change was declined." }, "reason": { "type": "string", "description": "The reason in case the change was declined." }, "changes": { "type": "string", "description": "A JSON encoded string with the request payload" }, "model": { "type": "string", "description": "The model being changed." }, "recordId": { "allOf": [ { "$ref": "#/$defs/changeRequestModelRecordId" }, { "description": "The id of the model, only set when operation is update." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/changeRequestModelEntity" }, { "description": "The identifier of the Entity associated with this Account." } ] }, "analyst": { "allOf": [ { "$ref": "#/$defs/changeRequestModelAnalyst" }, { "description": "The person who review the request." } ] }, "reviewed": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "If this change request was reviewed. The format should be YYYY-MM-DD HH:MM:SS" }, "verificationRef": { "$ref": "#/$defs/verificationRefsResponse" } } }, "changeRequestModelAnalyst": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The person who review the request." }, "changeRequestModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this Account." }, "changeRequestModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login associated with this ChangeRequest." }, "changeRequestModelRecordId": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/accountsResponse" } ], "description": "The id of the model, only set when operation is update." }, "changeRequestOperation": { "title": "changeRequestOperation", "enum": [ "create", "update" ], "type": "string" }, "changeRequestStatus": { "title": "changeRequestStatus", "enum": [ "pending", "manualReview", "approved", "declined" ], "type": "string" }, "chargebackDocumentStatus": { "title": "chargebackDocumentStatus", "enum": [ "created", "processed", "failed" ], "type": "string" }, "chargebackDocumentType": { "title": "chargebackDocumentType", "enum": [ "jpg", "jpeg", "gif", "png", "pdf", "tiff", "tif" ], "type": "string" }, "chargebackDocumentsDocumentSource": { "title": "chargebackDocumentsDocumentSource", "enum": [ "merchant", "issuer" ], "type": "string" }, "chargebackDocumentsModelChargeback": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebacksResponse" } ], "description": "The identifier of the Chargeback resource that this chargebackDocument relates to." }, "chargebackDocumentsResponse": { "title": "chargebackDocumentsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "chargeback": { "allOf": [ { "$ref": "#/$defs/chargebackDocumentsModelChargeback" }, { "description": "The identifier of the Chargeback resource that this chargebackDocument relates to." } ] }, "ref": { "type": "string", "description": "The reference for this chargebackDocument. \nThis field is stored as a text string and must be between 1 and 100 characters long. \n The value is set when the file is properly integrated, otherwise will be null." }, "type": { "allOf": [ { "$ref": "#/$defs/chargebackDocumentType" }, { "description": "The type of the file that holds this chargebackDocument. \nThe value is set when the file is properly integrated, otherwise will be null.\n\n
\nValid Values\n\n- `jpg` - **JPG file**\n- `jpeg` - **JPEG file**\n- `gif` - **GIF file**\n- `png` - **PNG file**\n- `pdf` - **PDF file**\n- `tiff` - **TIFF file**\n- `tif` - **TIF file**\n\n
" } ] }, "name": { "type": "string", "description": "The name of this chargebackDocument. \nThis field is stored as a text string and must be between 1 and 100 characters long. \n The value is set when the file is created and properly integrated. It holds the real file name used by the user." }, "description": { "type": "string", "description": "The description of this chargebackDocument. \nThis field is stored as a text string and must be between 1 and 100 characters long." }, "status": { "allOf": [ { "$ref": "#/$defs/chargebackDocumentStatus" }, { "description": "The current status of the chargebackDocument. \n\n
\nValid Values\n\n- `created` - **The ChargebackDocument has been created.** \n\n- `processed` - **The ChargebackDocument integration has been successful.** \n\n- `failed` - **The ChargebackDocument integration has failed.** \n\n
" } ] }, "documentSource": { "allOf": [ { "$ref": "#/$defs/chargebackDocumentsDocumentSource" }, { "description": "The source of the document.\n
\nValid Values\n- `merchant` - **Merchant.** \n- `issuer` - **Issuer.** \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
" } ] } } }, "chargebackMessageImported": { "title": "chargebackMessageImported", "enum": [ 0, 1 ], "type": "integer" }, "chargebackMessageModelChargeback": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebacksResponse" } ], "description": "The identifier of the Chargeback resource that this chargebackMessage relates to." }, "chargebackMessageResponse": { "title": "chargebackMessageResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "chargeback": { "allOf": [ { "$ref": "#/$defs/chargebackMessageModelChargeback" }, { "description": "The identifier of the Chargeback resource that this chargebackMessage relates to." } ] }, "date": { "type": "string", "description": "The date of this chargebackMessage. \nThe date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016." }, "type": { "allOf": [ { "$ref": "#/$defs/chargebackMessageType" }, { "description": "The type of this chargebackMessage.\n\n
\nValid Values\n\n- `assign` - **Assign the chargeback.**\n- `notate` - **Add a note to the chargeback.**\n- `acceptLiability` - **Accept Liability for the Chargeback amount.**\n- `createPreArbitration` - **Create a pre-arbitration case.**\n- `represent` - **Represent the chargeback.**\n- `respond` - **Respond to the chargeback.**\n- `requestArbitration` - **Request Arbitration. The Merchant wishes to enter arbitration to determine the outcome of the Chargeback.**\n- `createArbitration` - **Create an arbitration case.**\n- `requestPreArbitration` - **Request a pre-arbitration case.**\n- `requestResolutionToPreArbitration` - **Request resolution to a pre-arbitration case.**\n- `respondToDispute` - **Respond to a dispute.**\n- `respondToPreArbitration` - **Respond to a pre-arbitration case.**\n- `unaccept` - **Unaccept the chargeback.**\n\n
" } ] }, "fromQueue": { "type": "string", "description": "The fromQueue element that specifies the queue in which the chargeback resided prior to the performance of the specified activity." }, "toQueue": { "type": "string", "description": "The toQueue element that specifies queue to which the chargeback moved after the performance of the specified activity." }, "contact": { "type": "string", "description": "The identifier of the Contact for this chargebackMessage." }, "amount": { "type": "integer", "description": "The amount that this chargebackMessage corresponds to. \nFor example, if the 'type' is set to '3' (Accept Liability), then this amount indicates that the liability should be for this amount. \nThis field is specified as an integer in cents.", "contentEncoding": "int64" }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency of the amount. See Currency codes for all valid values." } ] }, "note": { "type": "string", "description": "A free-text note relating to this chargebackMessage." }, "status": { "allOf": [ { "$ref": "#/$defs/chargebackMessageStatus" }, { "description": "The current status of the Chargeback.\n\n
\nValid Values\n\n- `requested` - **The chargeback has been requested.**\n- `processing` - **The chargeback is currently being processed.**\n- `failed` - **The chargeback process has failed.**\n- `denied` - **The chargeback has been denied.**\n- `processed` - **The chargeback has been successfully processed.**\n\n
" } ] }, "imported": { "allOf": [ { "$ref": "#/$defs/chargebackMessageImported" }, { "description": "Whether the chargeback message was imported.\n\n
\nValid Values\n\n- `0` - **Not imported.**\n- `1` - **Imported.**\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
" } ] }, "chargebackMessageResults": { "type": "array", "items": { "$ref": "#/$defs/chargebackMessageResultResponse" }, "description": "" } } }, "chargebackMessageResultModelChargebackMessage": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebackMessageResponse" } ], "description": "The identifier of the chargebackMessage resource that this chargebackMessageResult relates to." }, "chargebackMessageResultResponse": { "title": "chargebackMessageResultResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "chargebackMessage": { "allOf": [ { "$ref": "#/$defs/chargebackMessageResultModelChargebackMessage" }, { "description": "The identifier of the chargebackMessage resource that this chargebackMessageResult relates to." } ] }, "type": { "allOf": [ { "$ref": "#/$defs/chargebackMessageResultType" }, { "description": "The type of this chargebackMessageResult.\n\n
\nValid Values\n\n- `general` - **A general type of result.**\n- `platform` - **Platform message.**\n\n
" } ] }, "message": { "type": "string", "description": "The Chargeback message itself." } } }, "chargebackMessageResultType": { "title": "chargebackMessageResultType", "enum": [ "general", "platform" ], "type": "string" }, "chargebackMessageStatus": { "title": "chargebackMessageStatus", "enum": [ "requested", "processing", "failed", "denied", "processed" ], "type": "string" }, "chargebackMessageType": { "title": "chargebackMessageType", "enum": [ "assign", "notate", "acceptLiability", "createPreArbitration", "represent", "respond", "requestArbitration", "createArbitration", "requestPreArbitration", "requestResolutionToPreArbitration", "respondToDispute", "respondToPreArbitration", "unaccept" ], "type": "string" }, "chargebackPaymentMethod": { "title": "chargebackPaymentMethod", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 ], "type": "integer" }, "chargebackPlatform": { "title": "chargebackPlatform", "enum": [ "APPLE", "ELAVON", "FIRSTDATA", "GOOGLE", "VANTIV", "VCORE", "WELLSACH", "WELLSFARGO", "WFSINGLE" ], "type": "string" }, "chargebackStatus": { "title": "chargebackStatus", "enum": [ "open", "closed", "won", "lost" ], "type": "string" }, "chargebackStatusesModelChargeback": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebacksResponse" } ], "description": "ID of the related chargeback." }, "chargebackStatusesModelChargebackMessage": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebackMessageResponse" } ], "description": "ID of the chargeback message associated with this chargeback." }, "chargebackStatusesResponse": { "title": "chargebackStatusesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "chargeback": { "allOf": [ { "$ref": "#/$defs/chargebackStatusesModelChargeback" }, { "description": "ID of the related chargeback." } ] }, "chargebackMessage": { "allOf": [ { "$ref": "#/$defs/chargebackStatusesModelChargebackMessage" }, { "description": "ID of the chargeback message associated with this chargeback." } ] }, "status": { "allOf": [ { "$ref": "#/$defs/chargebackStatusesStatus" }, { "description": "The Chargeback's status.
Valid Values\n\n - `open` - **Chargeback is open, responses may be submitted.**\n\n - `closed` - **Chargeback is closed, responses may no longer be submitted.**\n\n - `won` - **Chargeback won.** \n - `lost` - **Chargeback lost.**\n\n
" } ] } } }, "chargebackStatusesStatus": { "title": "chargebackStatusesStatus", "enum": [ "open", "closed", "won", "lost" ], "type": "string" }, "chargebacksActionable": { "title": "chargebacksActionable", "enum": [ 0, 1 ], "type": "integer" }, "chargebacksModelLastStatusChange": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebackStatusesResponse" } ], "description": "The ChargebackStatus representing the latest status change for this Chargeback." }, "chargebacksModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The ID of the merchant associated with the Chargeback." }, "chargebacksModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The ID of the Transaction associated with the Chargeback." }, "chargebacksResponse": { "title": "chargebacksResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "merchant": { "allOf": [ { "$ref": "#/$defs/chargebacksModelMerchant" }, { "description": "The ID of the merchant associated with the Chargeback." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/chargebacksModelTxn" }, { "description": "The ID of the Transaction associated with the Chargeback." } ] }, "mid": { "type": "string", "description": "The Merchant's processing MID." }, "description": { "type": "string", "description": "Description of the chargeback." }, "total": { "type": "integer", "description": "The total amount of the Chargeback.", "contentEncoding": "int64" }, "representedTotal": { "type": "integer", "description": "The representedTotal for this Chargeback if it has been represented.", "contentEncoding": "int64" }, "cycle": { "allOf": [ { "$ref": "#/$defs/cycle" }, { "description": "
Valid Values\n\n - `retrieval` - **Initial request from the issuer for more information on this Transaction.**\n \n - `first` - **First Chargeback from issuer for this Transaction.**\n \n - `arbitration` - **Arbitration is being sought for this Chargeback.**\n \n - `reversal` - **Chargeback was reversed.**\n \n - `representment` - **Merchant is being represented to the issuer with the Chargeback response posted.**\n\n \n - `preArbitration` - **Chargeback is no longer representable. Merchant must choose to accept or arbitrate with the card brand.**\n \n - `arbitrationLost` - **Arbitration lost.**\n \n - `arbitrationSplit` - **Arbitration split.**\n \n - `arbitrationWon` - **Arbitration won.**\n \n - `issuerAcceptPreArbitration` - **Issuer accepted the pre-arbitration response.**\n \n - `issuerDeclinedPreArbitration` - **Issuer declined pre-arbitration.**\n \n - `responseToIssuerPreArbitration` - **Response to issuer pre-arbitration.**\n \n - `merchantAcceptedPreArbitration` - **Merchant accepted the pre-arbitration response.**\n \n - `merchantDeclinedPreArbitration` - **Merchant declined the pre-arbitration response.**\n \n - `preCompliance` - **Pre-compliance.**\n \n - `compliance` - **Compliance.**
" } ] }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency for this statement. See Currency codes for all valid values." } ] }, "platform": { "allOf": [ { "$ref": "#/$defs/chargebackPlatform" }, { "description": "The platform used for the adjustment. This field is required if the adjustment is not between entities." } ] }, "paymentMethod": { "allOf": [ { "$ref": "#/$defs/chargebackPaymentMethod" }, { "description": "The type of payment method used for the transaction.\n\n
\nValid Values\n\n- `0` - **No payment method specified.**\n- `1` - **American Express.**\n- `2` - **Visa.**\n- `3` - **MasterCard.**\n- `4` - **Diners Club.**\n- `5` - **Discover.**\n- `6` - **PayPal.**\n- `7` - **Debit card.**\n- `8` - **Checking account.**\n- `9` - **Savings account.**\n- `10` - **Corporate checking account.**\n- `11` - **Corporate savings account.**\n- `12` - **Gift card.**\n- `13` - **EBT card.**\n- `14` - **WIC card.**\n\n
" } ] }, "ref": { "type": "string", "description": "The processing reference number for this Chargeback." }, "reason": { "type": "string", "description": "The reason description for this Chargeback." }, "reasonCode": { "type": "string", "description": "The reason code for this Chargeback." }, "issued": { "type": "integer", "description": "The date when the Chargeback was issued.", "contentEncoding": "int32" }, "received": { "type": "integer", "description": "The date when the Chargeback was received.", "contentEncoding": "int32" }, "reply": { "type": "integer", "description": "The deadline to submit a reply for the Chargeback.", "contentEncoding": "int32" }, "bankRef": { "type": "string", "description": "The issuing bank's reference number for this Chargeback." }, "chargebackRef": { "type": "string", "description": "Chargeback reference number." }, "status": { "allOf": [ { "$ref": "#/$defs/chargebackStatus" }, { "description": "The Chargeback's status.\n\n
\nValid Values\n\n- `open` - **Chargeback is open, responses may be submitted.**\n- `closed` - **Chargeback is closed, responses may no longer be submitted.**\n- `won` - **Chargeback won.**\n- `lost` - **Chargeback lost.**\n\n
" } ] }, "lastStatusChange": { "allOf": [ { "$ref": "#/$defs/chargebacksModelLastStatusChange" }, { "description": "The ChargebackStatus representing the latest status change for this Chargeback." } ] }, "actionable": { "allOf": [ { "$ref": "#/$defs/chargebacksActionable" }, { "description": "Whether the Chargeback is actionable and can be responded to. \n\n
\nValid Values\n\n- `0` - **Not actionable** \n\n- `1` - **Actionable**\n
" } ] }, "shadow": { "allOf": [ { "$ref": "#/$defs/chargebacksShadow" }, { "description": "
\nValid Values\n\n- `0` - **Not shadowed.** \n\n- `1` - **Shadowed.**\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
" } ] }, "assessments": { "type": "array", "items": { "$ref": "#/$defs/assessmentsResponse" }, "description": "" }, "chargebackDocuments": { "type": "array", "items": { "$ref": "#/$defs/chargebackDocumentsResponse" }, "description": "" }, "chargebackMessages": { "type": "array", "items": { "$ref": "#/$defs/chargebackMessageResponse" }, "description": "" }, "chargebackStatuses": { "type": "array", "items": { "$ref": "#/$defs/chargebackStatusesResponse" }, "description": "" }, "entries": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" }, "pendingEntry": { "$ref": "#/$defs/pendingEntriesResponse" } } }, "chargebacksShadow": { "title": "chargebacksShadow", "enum": [ 0, 1 ], "type": "integer" }, "configurationIntegration": { "title": "configurationIntegration", "enum": [ "ACH", "APPLE", "ELAVON", "FEDACH", "FIRSTDATA", "LEGITSCRIPT", "NEUTRINO", "OFAC", "OMNITOKEN", "PAYRIX", "PLAID", "PUSHY", "SAFERPAYMENT", "SIFT", "SOCURE", "SOUNDPAYMENTS", "TDBANK", "TDBANKCA", "VANTIV", "VCORE", "WEBSHIELD", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY" ], "type": "string" }, "configurationStageCredentials": { "title": "configurationStageCredentials", "enum": [ "transaction", "batch", "boarding", "paymentUpdates", "payout", "payoutCredit", "payoutDebit", "chargeback", "txnReport", "account", "entityDecision", "txnCheck", "payoutReport", "feeReport", "chargebackReport", "binReport", "watchlist", "encryption", "changeRequest" ], "type": "string" }, "configurationStageExtension": { "title": "configurationStageExtension", "enum": [ "jpg", "jpeg", "gif", "png", "pdf", "tif", "tiff", "txt", "xml", "asc", "rtf", "csv", "xls", "doc", "odt", "ods", "json", "soap" ], "type": "string" }, "configurationStageInput": { "title": "configurationStageInput", "enum": [ "APPLE_PAYMENTSESSION_REQUEST_JSON", "APPLE_REGISTER_MERCHANT_REQUEST_JSON", "APPLE_UNREGISTER_MERCHANT_REQUEST_JSON", "EFT", "ELAVON_BATCH_FLAT", "ELAVON_BATCH_READ_FLAT", "ELAVON_BOARD_JSON", "ELAVON_REPORTS_CSV", "ELAVON_TXN_XML", "FEDACH_REPORT_FLAT", "FIRSTDATA_BATCH_FLAT", "FIRSTDATA_BATCH_READ_FLAT", "FIRSTDATA_BOARD_JSON", "FIRSTDATA_REPORTS_FLAT", "FIRSTDATA_SRS_XML", "FIRSTDATA_TXN_XML", "FIRSTDATA_SINGLE_BATCH_FLAT", "FIRSTDATA_SINGLE_TXN_XML", "NACHA", "NEUTRINO_CSV", "NEUTRINO_FORM", "NEUTRINO_JSON", "OFAC_XML", "PAYRIX_CHARGEBACK_JSON", "PAYRIX_DECISION_JSON", "PAYRIX_ENCRYPTION_JSON", "PAYRIX_GOOGLEPAY_DECRYPTION_JSON", "PAYRIX_TXN_JSON", "PUSHY_TXN_JSON", "SIFT_JSON", "SOCURE_ALLOY_JSON", "SOCURE_FORM", "SOCURE_JSON", "SOUNDPAYMENTS_TXN_FORM", "SOUNDPAYMENTS_TXN_XML", "VANTIV_BATCH_XML", "VANTIV_BOARD_XML", "VANTIV_CHARGEBACK_XML", "VANTIV_PAYMENT_UPDATES_XML", "VANTIV_PAYOUT_CSV", "VANTIV_PAYOUT_XML", "VANTIV_PAYOUT_XML_V9", "VANTIV_REPORTS_CSV", "VANTIV_TXN_CSV", "VANTIV_TXN_XML", "VCORE_BATCH_FLAT", "VCORE_BATCH_READ_FLAT", "VCORE_BINREPORT_FLAT", "VCORE_BOARD_API", "VCORE_BOARD_FLAT", "VCORE_CHARGEBACK_FLAT", "VCORE_OMNITOKEN_JSON", "VCORE_REPORTS_FLAT", "VCORE_SAFERPAYMENT_JSON", "VCORE_TXN_ISO8583", "VCORE_UPDATE_FLAT", "VCORE_VARSHEET_JSON", "WEBSHIELD_FORM", "WEBSHIELD_JSON", "WELLSACH_BATCH_FLAT", "WELLSACH_PAYOUT_FLAT", "WELLSACH_TXN_FLAT", "WELLSFARGO_BOARD_XML", "WELLSFARGO_REPORT_CSV", "WELLSFARGO_REPORT_FLAT", "WFSINGLE_REPORT_FLAT", "WFSINGLE_BOARD_XML" ], "type": "string" }, "configurationStageMethod": { "title": "configurationStageMethod", "enum": [ "sftpUpload", "sftpDownload", "post", "get", "put", "delete", "tcp" ], "type": "string" }, "configurationStageName": { "title": "configurationStageName", "enum": [ "blank", "acceptedCards", "ack", "activateSrs", "alert", "amexUpdate", "applepay", "balance", "batch", "chargeback", "chargebackList", "confirmDisbursement", "contactUpdate", "createMerchant", "credit", "decrypt", "debit", "debitPinEnable", "debitPinlessEnable", "discoverUrl", "discoverUpdate", "document", "documentList", "interchange", "encrypt", "entity", "entityAddressUpdate", "entityRetrieval", "entityUpdate", "expressSubAccountUpdate", "return", "feeList", "googlepay", "memberCreate", "memberDelete", "members", "memberUpdate", "merchant", "merchantCardPresent", "merchantCardNotPresent", "merchantUpdate", "merchantRetrieval", "noc", "nocReturns", "omniTokenEnable", "passTokenEnable", "payment", "paymentConfirmation", "paymentUpdate", "payout", "primaryMemberUpdate", "registerSrs", "returnCredit", "returnDebit", "returns", "saferPaymentEnable", "terminalCreate", "terminalList", "terminalsSupported", "txn", "txnList", "varsheet" ], "type": "string" }, "configurationStageOutput": { "title": "configurationStageOutput", "enum": [ "APPLE_PAYMENTSESSION_REQUEST_JSON", "APPLE_REGISTER_MERCHANT_REQUEST_JSON", "APPLE_UNREGISTER_MERCHANT_REQUEST_JSON", "EFT", "ELAVON_BATCH_FLAT", "ELAVON_BATCH_READ_FLAT", "ELAVON_BOARD_JSON", "ELAVON_REPORTS_CSV", "ELAVON_TXN_XML", "FEDACH_REPORT_FLAT", "FIRSTDATA_BATCH_FLAT", "FIRSTDATA_BATCH_READ_FLAT", "FIRSTDATA_BOARD_JSON", "FIRSTDATA_REPORTS_FLAT", "FIRSTDATA_SRS_XML", "FIRSTDATA_TXN_XML", "FIRSTDATA_SINGLE_BATCH_FLAT", "FIRSTDATA_SINGLE_TXN_XML", "NACHA", "NEUTRINO_CSV", "NEUTRINO_FORM", "NEUTRINO_JSON", "OFAC_XML", "PAYRIX_CHARGEBACK_JSON", "PAYRIX_DECISION_JSON", "PAYRIX_ENCRYPTION_JSON", "PAYRIX_GOOGLEPAY_DECRYPTION_JSON", "PAYRIX_TXN_JSON", "PUSHY_TXN_JSON", "SIFT_JSON", "SOCURE_ALLOY_JSON", "SOCURE_FORM", "SOCURE_JSON", "SOUNDPAYMENTS_TXN_FORM", "SOUNDPAYMENTS_TXN_XML", "VANTIV_BATCH_XML", "VANTIV_BOARD_XML", "VANTIV_CHARGEBACK_XML", "VANTIV_PAYMENT_UPDATES_XML", "VANTIV_PAYOUT_CSV", "VANTIV_PAYOUT_XML", "VANTIV_PAYOUT_XML_V9", "VANTIV_REPORTS_CSV", "VANTIV_TXN_CSV", "VANTIV_TXN_XML", "VCORE_BATCH_FLAT", "VCORE_BATCH_READ_FLAT", "VCORE_BINREPORT_FLAT", "VCORE_BOARD_API", "VCORE_BOARD_FLAT", "VCORE_CHARGEBACK_FLAT", "VCORE_OMNITOKEN_JSON", "VCORE_REPORTS_FLAT", "VCORE_SAFERPAYMENT_JSON", "VCORE_TXN_ISO8583", "VCORE_UPDATE_FLAT", "VCORE_VARSHEET_JSON", "WEBSHIELD_FORM", "WEBSHIELD_JSON", "WELLSACH_BATCH_FLAT", "WELLSACH_PAYOUT_FLAT", "WELLSACH_TXN_FLAT", "WELLSFARGO_BOARD_XML", "WELLSFARGO_REPORT_CSV", "WELLSFARGO_REPORT_FLAT", "WFSINGLE_REPORT_FLAT", "WFSINGLE_BOARD_XML" ], "type": "string" }, "configurationStagesModelConfiguration": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/configurationsResponse" } ], "description": "The identifier of the Configuration that owns this configurationStage resource." }, "configurationStagesResponse": { "title": "configurationStagesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "configuration": { "allOf": [ { "$ref": "#/$defs/configurationStagesModelConfiguration" }, { "description": "The identifier of the Configuration that owns this configurationStage resource." } ] }, "name": { "allOf": [ { "$ref": "#/$defs/configurationStageName" }, { "description": "The name of this configurationStage resource. \n\n
\nValid Values \n\n - `blank` - **Blank. Used for a stage with no name.**\n\n - `acceptedCards` - **Set card types accepted by the merchant.**\n\n - `ack` - **''**\n\n - `activateSrs` - **First Data merchant SRS activation.**\n\n - `alert` - **''**\n\n - `acceptedCards` - **'This holds the parameter to pull the accepted cards for a merchant, this is specific to VCORE'**\n\n - `amexUpdate` - **Update merchant card enablement for American Express.**\n\n - `applepay` - **''**\n\n - `balance` - **Bank account balance request for decisions and verifications processes.**\n\n - `batch` - **Send batch command to terminal.**\n\n - `chargeback` - **Chargeback. The standard name used for chargeback related stages.**\n\n - `chargebackList` - **ChargebackList. The specific name to get chargeback reports.**\n\n - `confirmDisbursement` - **Disbursement confirmation report retrieval.**\n\n - `contactUpdate` - **Update merchant contacts.**\n\n - `createMerchant` - **Send merchant details for merchant boarding.**\n\n - `credit` - **''**\n\n - `decrypt` - **Set card types accepted by the merchant.**\n\n - `debit` - **Set card types accepted by the merchant.**\n\n - `debitPinEnable` - **Set merchant Pin Debit enablement.**\n\n - `debitPinlessEnable` - **Set merchant Pinless Debit enablement.**\n\n - `discoverUrl` - **Retrieve merchant transaction processing url.**\n\n - `discoverUpdate` - **Update merchant card enablement for Discover.**\n\n - `document` - **Document. The standard name for chargeback related documentation such as uploading a document or updating a document.**\n\n - `documentList` - **DocumentList. Used for receiving documents related to a chargeback.**\n\n - `interchange` - **''**\n\n - `encrypt` - **''**\n\n - `entity` - **Entity. The standard name used when it comes to entity related stages such as retrieving an entity or updating.**\n\n - `entityAddressUpdate` - **Update merchant legal entity address.**\n\n - `entityRetrieval` - **EntityRetrieval. Used when entity stage name is already being used in that crud configuration.**\n\n - `entityUpdate` - **EntityUpdate. Used when entity stage name is already being used in that crud configuration.**\n\n - `expressSubAccountUpdate` - **'This holds the parameter for updating express subaccount'**\n\n - `return` - **Return. Used for return stage name.**\n\n - `feeList` - **FeeList. The specific name to get fees reports.**\n\n - `googlepay` - **''**\n\n - `memberCreate` - **MemberCreate. Stage name used to indicate creating a merchant member.**\n\n - `memberDelete` - **MemberDelete. Stage name used to indicate deleting a merchant member.**\n\n - `members` - **Members. Stage name used for creating several members for the merchant.**\n\n - `memberUpdate` - **Update merchant member.**\n\n - `merchant` - **Merchant. The standard name used for merchant related stages such retrieving a merchant or updating a merchant.**\n\n - `merchantCardPresent` - **'This holds the parameter for creating merchants with card present options, this is specific for WF and WFSingle platform'**\n\n - `merchantCardNotPresent` - **'This holds the parameter for creating merchants with card not present options, this is specific for WF and WFSingle platform'**\n\n - `merchantUpdate` - **Update merchant details.**\n\n - `merchantRetrieval` - **MerchantRetrieval. Used when merchant stage name is already being used in that crud configuration.**\n\n - `noc` - **Noc. Stage name used for notification of change for disbursement related integrations.**\n\n - `nocReturns` - **''**\n\n - `omniTokenEnable` - **'This holds the parameters for omni token enablement'**\n\n - `passTokenEnable` - **'This holds the parameters for pass token enablement'**\n\n - `payment` - **Send payment details for Account Updater request.**\n\n - `paymentConfirmation` - **Retrieve Account Updater request echo confirmation.**\n\n - `paymentUpdate` - **Retrieve Account Updater updates.**\n\n - `payout` - **Payout. Stage name used for payouts.**\n\n - `primaryMemberUpdate` - **Update merchant primary member.**\n\n - `registerSrs` - **First Data merchant SRS registration.**\n\n - `returnCredit` - **''**\n\n - `returnDebit` - **''**\n\n - `returns` - **''**\n\n - `saferPaymentEnable` - **'This holds the parameters for safer payment enablement'**\n\n - `terminalCreate` - **Send terminal details for terminal boarding.**\n\n - `terminalList` - **Retrieve list of terminals for a merchant.**\n\n - `terminalsSupported` - **Retrieve list of supported terminals for a merchant.**\n\n - `txn` - **Txn. The standard name used for transaction related stages.**\n\n - `txnList` - **TxnList. The specific name to get transaction reports.**\n\n - `varsheet` - **'This hold the parameter for accessing the terminal VARSHEET retrieval'**\n\n
" } ] }, "method": { "allOf": [ { "$ref": "#/$defs/configurationStageMethod" }, { "description": "The method used for configurationStage resource.\n\n
\nValid Values\n\n- `sftpUpload` - **SFtpUpload. Use sftp to Upload**\n- `sftpDownload` - **sftpDownload. Use sftp to Download**\n- `post` - **POST. Use a post request**\n- `get` - **GET. Use a get request**\n- `put` - **PUT. Use a put request**\n- `delete` - **DELETE. Use a delete request**\n- `tcp` - **TCP. Use tcp protocol**\n\n
" } ] }, "sequence": { "type": "integer", "description": "A free-form sequence identifier to order the execution of stages for a configuration.", "contentEncoding": "int32" }, "input": { "allOf": [ { "$ref": "#/$defs/configurationStageInput" }, { "description": "The input used for configurationStage resource.
Valid Values\n\n - `APPLE_PAYMENTSESSION_REQUEST_JSON` - **APPLE_PAYMENTSESSION_REQUEST_JSON input file.**\n\n - `APPLE_REGISTER_MERCHANT_REQUEST_JSON` - **APPLE_REGISTER_MERCHANT_REQUEST_JSON input file.**\n\n - `APPLE_UNREGISTER_MERCHANT_REQUEST_JSON` - **APPLE_UNREGISTER_MERCHANT_REQUEST_JSON input file.**\n\n - `EFT` - **EFT input file.**\n\n - `ELAVON_BATCH_FLAT` - **ELAVON_BATCH_FLAT input file. Batch file upload format and structure for the Elavon processor.**\n\n - `ELAVON_BATCH_READ_FLAT` - **ELAVON_BATCH_READ_FLAT input file. Batch file download format and structure for the Elavon processor.**\n\n - `ELAVON_BOARD_JSON` - **ELAVON_BOARD_JSON input file. Merchant boarding format and structure for the Elavon processor.**\n\n - `ELAVON_REPORTS_CSV` - **ELAVON_REPORTS_CSV input file. Settlement report format and structure for the Elavon processor.**\n\n - `ELAVON_TXN_XML` - **ELAVON_TXN_XML input file. Transaction authorization processing format and structure for the Elavon processor.**\n\n - `FEDACH_REPORT_FLAT` - **FEDACH_REPORT_FLAT input file. Fed ACH routing number file format and structure.**\n\n - `FIRSTDATA_BATCH_FLAT` - **FIRSTDATA_BATCH_FLAT input file. Batch file format and structure for the First Data processor.**\n\n - `FIRSTDATA_BATCH_READ_FLAT` - **FIRSTDATA_BATCH_READ_FLAT input file.**\n\n - `FIRSTDATA_BOARD_JSON` - **FIRSTDATA_BOARD_JSON input file. Merchant boarding format and structure for the First Data processor.**\n\n - `FIRSTDATA_REPORTS_FLAT` - **FIRSTDATA_REPORTS_FLAT input file. Settlement report format and structure for the First Data processor.**\n\n - `FIRSTDATA_SRS_XML` - **FIRSTDATA_SRS_XML input file. SRS registration and activation format and structure for the First Data Processor.**\n\n - `FIRSTDATA_TXN_XML` - **FIRSTDATA_TXN_XML input file. Transaction authorization processing format and structure for the First Data processor.**\n\n - `FIRSTDATA_SINGLE_BATCH_FLAT` - **FIRSTDATA_SINGLE_BATCH_FLAT input file.**\n\n - `FIRSTDATA_SINGLE_TXN_XML` - **FIRSTDATA_SINGLE_TXN_XML input file.**\n\n - `NACHA` - **NACHA input file. Disbursement file format and structure for the NACHA funding platform.**\n\n - `NEUTRINO_CSV` - **NEUTRINO_CSV input file. BIN (Bank Issuer Number) file download format and structure for the Neutrino API service.**\n\n - `NEUTRINO_FORM` - **NEUTRINO_FORM input file. BIN (Bank Issuer Number) file request format and structure for the Neutrino API service.**\n\n - `NEUTRINO_JSON` - **NEUTRINO_JSON input file. BIN (Bank Issuer Number) file format and structure for the Neutrino API service.**\n\n - `OFAC_XML` - **OFAC_XML input file. Entity and member watchlist file download for the OFAC SDN list.**\n\n - `PAYRIX_CHARGEBACK_JSON` - **PAYRIX_CHARGEBACK_JSON input file.**\n\n - `PAYRIX_DECISION_JSON` - **PAYRIX_DECISION_JSON input file. Risk decision integration format and structure for the Payrix integration service.**\n\n - `PAYRIX_ENCRYPTION_JSON` - **PAYRIX_ENCRYPTION_JSON input file.**\n\n - `PAYRIX_GOOGLEPAY_DECRYPTION_JSON` - **PAYRIX_GOOGLEPAY_DECRYPTION_JSON Blank.**\n\n - `PAYRIX_TXN_JSON` - **PAYRIX_TXN_JSON input file. Terminal activation response format and structure for the Payrix terminal app.**\n\n - `PUSHY_TXN_JSON` - **PUSHY_TXN_JSON input file. Terminal activation request format and structure for the Pushy app messaging service.**\n\n - `SIFT_JSON` - **SIFT_JSON input file. Risk decision integration format and structure for the SIFT transaction monitoring service.**\n\n - `SOCURE_ALLOY_JSON` - **SOCURE_ALLOY_JSON input file. Risk decision integration format and structure for the Alloy integrator to Socure.**\n\n - `SOCURE_FORM` - **SOCURE_FORM input file. Risk decision integration request format and structure for the Socure member underwriting service.**\n\n - `SOCURE_JSON` - **SOCURE_JSON input file. Risk decision integration response format and structure for the Socure member underwriting service.**\n\n - `SOUNDPAYMENTS_TXN_FORM` - **SOUNDPAYMENTS_TXN_FORM input file. Terminal activation request format and structure for the Sound Payments cloud activation service.**\n\n - `SOUNDPAYMENTS_TXN_XML` - **SOUNDPAYMENTS_TXN_XML input file. Terminal activation response format and structure for the Sound Payments cloud activation service.**\n\n - `VANTIV_BATCH_XML` - **VANTIV_BATCH_XML input file. Batch file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_BOARD_XML` - **VANTIV_BOARD_XML input file. Merchant boarding format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_CHARGEBACK_XML` - **VANTIV_CHARGEBACK_XML input file. Chargeback API format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYMENT_UPDATES_XML` - **VANTIV_PAYMENT_UPDATES_XML input file. Account Updater format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_CSV` - **VANTIV_PAYOUT_CSV input file. Payout reports format and structure for the WoldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_XML` - **VANTIV_PAYOUT_XML input file. Disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_XML_V9` - **VANTIV_PAYOUT_XML_V9 input file. Old version 9 disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_REPORTS_CSV` - **VANTIV_REPORTS_CSV input file. Settlement report format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_TXN_CSV` - **VANTIV_TXN_CSV input file. Echeck reports format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_TXN_XML` - **VANTIV_TXN_XML input file. Transaction authorization processing format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VCORE_BATCH_FLAT` - **VCORE_BATCH_FLAT input file. Batch file upload format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BATCH_READ_FLAT` - **VCORE_BATCH_READ_FLAT input file. Batch file download format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BINREPORT_FLAT` - **VCORE_BINREPORT_FLAT input file. BIN (Bank Issuer Number) file download format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BOARD_API` - **VCORE_BOARD_API input file. New merchant boarding API format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BOARD_FLAT` - **VCORE_BOARD_FLAT input file. Old merchant boarding creation file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_CHARGEBACK_FLAT` - **VCORE_CHARGEBACK_FLAT input file. Chargeback file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_OMNITOKEN_JSON` - **VCORE_OMNITOKEN_JSON input file.**\n\n - `VCORE_REPORTS_FLAT` - **VCORE_REPORTS_FLAT input file. Settlement report format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_SAFERPAYMENT_JSON` - **VCORE_SAFERPAYMENT_JSON input file.**\n\n - `VCORE_TXN_ISO8583` - **VCORE_TXN_ISO8583 input file. Transaction authorization processing for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_UPDATE_FLAT` - **VCORE_UPDATE_FLAT input file. Old merchant boarding update file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_VARSHEET_JSON` - **VCORE_VARSHEET_JSON input file.**\n\n - `WEBSHIELD_FORM` - **WEBSHIELD_FORM input file. Risk decision integration request format and structure for the Webshield entity underwriting service.**\n\n - `WEBSHIELD_JSON` - **WEBSHIELD_JSON input file. Risk decision integration response format and structure for the Webshield entity underwriting service.**\n\n - `WELLSACH_BATCH_FLAT` - **WELLSACH_BATCH_FLAT output file.**\n\n - `WELLSACH_PAYOUT_FLAT` - **WELLSACH_PAYOUT_FLAT output file.**\n\n - `WELLSACH_TXN_FLAT` - **WELLSACH_TXN_FLAT output file.**\n\n - `WELLSFARGO_BOARD_XML` - **WELLSFARGO_BOARD_XML output file. Merchant boarding format and structure for the Wells Fargo Merchant Services processor.**\n\n - `WELLSFARGO_REPORT_CSV` - **WELLSFARGO_REPORT_CSV output file.**\n\n - `WELLSFARGO_REPORT_FLAT` - **WELLSFARGO_REPORT_FLAT output file.**\n\n - `WFSINGLE_REPORT_FLAT` - **WFSINGLE_REPORT_FLAT output file.**\n\n - `WFSINGLE_BOARD_XML` - **WFSINGLE_BOARD_XML output file.**\n\n
" } ] }, "output": { "allOf": [ { "$ref": "#/$defs/configurationStageOutput" }, { "description": "The output used for configurationStage resource.
Valid Values\n\n - `APPLE_PAYMENTSESSION_REQUEST_JSON` - **APPLE_PAYMENTSESSION_REQUEST_JSON output file.**\n\n - `APPLE_REGISTER_MERCHANT_REQUEST_JSON` - **APPLE_REGISTER_MERCHANT_REQUEST_JSON output file.**\n\n - `APPLE_UNREGISTER_MERCHANT_REQUEST_JSON` - **APPLE_UNREGISTER_MERCHANT_REQUEST_JSON output file.**\n\n - `EFT` - **EFT output file.**\n\n - `ELAVON_BATCH_FLAT` - **ELAVON_BATCH_FLAT output file. Batch file upload format and structure for the Elavon processor.**\n\n - `ELAVON_BATCH_READ_FLAT` - **ELAVON_BATCH_READ_FLAT output file. Batch file download format and structure for the Elavon processor.**\n\n - `ELAVON_BOARD_JSON` - **ELAVON_BOARD_JSON output file. Merchant boarding format and structure for the Elavon processor.**\n\n - `ELAVON_REPORTS_CSV` - **ELAVON_REPORTS_CSV output file. Settlement report format and structure for the Elavon processor.**\n\n - `ELAVON_TXN_XML` - **ELAVON_TXN_XML output file. Transaction authorization processing format and structure for the Elavon processor.**\n\n - `FEDACH_REPORT_FLAT` - **FEDACH_REPORT_FLAT output file. Fed ACH routing number file format and structure.**\n\n - `FIRSTDATA_BATCH_FLAT` - **FIRSTDATA_BATCH_FLAT output file. Batch file format and structure for the First Data processor.**\n\n - `FIRSTDATA_BATCH_READ_FLAT` - **FIRSTDATA_BATCH_READ_FLAT output file.**\n\n - `FIRSTDATA_BOARD_JSON` - **FIRSTDATA_BOARD_JSON output file. Merchant boarding format and structure for the First Data processor.**\n\n - `FIRSTDATA_REPORTS_FLAT` - **FIRSTDATA_REPORTS_FLAT output file. Settlement report format and structure for the First Data processor.**\n\n - `FIRSTDATA_SRS_XML` - **FIRSTDATA_SRS_XML output file. SRS registration and activation format and structure for the First Data Processor.**\n\n - `FIRSTDATA_TXN_XML` - **FIRSTDATA_TXN_XML output file. Transaction authorization processing format and structure for the First Data processor.**\n\n - `FIRSTDATA_SINGLE_BATCH_FLAT` - **FIRSTDATA_SINGLE_BATCH_FLAT output file.**\n\n - `FIRSTDATA_SINGLE_TXN_XML` - **FIRSTDATA_SINGLE_TXN_XML output file.**\n\n - `NACHA` - **NACHA output file. Disbursement file format and structure for the NACHA funding platform.**\n\n - `NEUTRINO_CSV` - **NEUTRINO_CSV output file. BIN (Bank Issuer Number) file download format and structure for the Neutrino API service.**\n\n - `NEUTRINO_FORM` - **NEUTRINO_FORM output file. BIN (Bank Issuer Number) file request format and structure for the Neutrino API service.**\n\n - `NEUTRINO_JSON` - **NEUTRINO_JSON output file. BIN (Bank Issuer Number) file format and structure for the Neutrino API service.**\n\n - `OFAC_XML` - **OFAC_XML output file. Entity and member watchlist file download for the OFAC SDN list.**\n\n - `PAYRIX_CHARGEBACK_JSON` - **PAYRIX_CHARGEBACK_JSON output file.**\n\n - `PAYRIX_DECISION_JSON` - **PAYRIX_DECISION_JSON output file. Risk decision integration format and structure for the Payrix integration service.**\n\n - `PAYRIX_ENCRYPTION_JSON` - **PAYRIX_ENCRYPTION_JSON output file.**\n\n - `PAYRIX_GOOGLEPAY_DECRYPTION_JSON` - **PAYRIX_GOOGLEPAY_DECRYPTION_JSON output file.**\n\n - `PAYRIX_TXN_JSON` - **PAYRIX_TXN_JSON output file. Terminal activation response format and structure for the Payrix terminal app.**\n\n - `PUSHY_TXN_JSON` - **PUSHY_TXN_JSON output file. Terminal activation request format and structure for the Pushy app messaging service.**\n\n - `SIFT_JSON` - **SIFT_JSON output file. Risk decision integration format and structure for the SIFT transaction monitoring service.**\n\n - `SOCURE_ALLOY_JSON` - **SOCURE_ALLOY_JSON output file. Risk decision integration format and structure for the Alloy integrator to Socure.**\n\n - `SOCURE_FORM` - **SOCURE_FORM output file. Risk decision integration request format and structure for the Socure member underwriting service.**\n\n - `SOCURE_JSON` - **SOCURE_JSON output file. Risk decision integration response format and structure for the Socure member underwriting service.**\n\n - `SOUNDPAYMENTS_TXN_FORM` - **SOUNDPAYMENTS_TXN_FORM output file. Terminal activation request format and structure for the Sound Payments cloud activation service.**\n\n - `SOUNDPAYMENTS_TXN_XML` - **SOUNDPAYMENTS_TXN_XML output file. Terminal activation response format and structure for the Sound Payments cloud activation service.**\n\n - `VANTIV_BATCH_XML` - **VANTIV_BATCH_XML output file. Batch file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_BOARD_XML` - **VANTIV_BOARD_XML output file. Merchant boarding format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_CHARGEBACK_XML` - **VANTIV_CHARGEBACK_XML output file. Chargeback API format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYMENT_UPDATES_XML` - **VANTIV_PAYMENT_UPDATES_XML output file. Account Updater format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_CSV` - **VANTIV_PAYOUT_CSV output file. Payout reports format and structure for the WoldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_XML` - **VANTIV_PAYOUT_XML output file. Disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_PAYOUT_XML_V9` - **VANTIV_PAYOUT_XML_V9 output file. Old version 9 disbursement file format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_REPORTS_CSV` - **VANTIV_REPORTS_CSV output file. Settlement report format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_TXN_CSV` - **VANTIV_TXN_CSV output file. Echeck reports format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VANTIV_TXN_XML` - **VANTIV_TXN_XML output file. Transaction authorization processing format and structure for the WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n - `VCORE_BATCH_FLAT` - **VCORE_BATCH_FLAT output file. Batch file upload format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BATCH_READ_FLAT` - **VCORE_BATCH_READ_FLAT output file. Batch file download format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BINREPORT_FLAT` - **VCORE_BINREPORT_FLAT output file. BIN (Bank Issuer Number) file download format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BOARD_API` - **VCORE_BOARD_API output file. New merchant boarding API format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_BOARD_FLAT` - **VCORE_BOARD_FLAT output file. Old merchant boarding creation file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_CHARGEBACK_FLAT` - **VCORE_CHARGEBACK_FLAT output file. Chargeback file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_OMNITOKEN_JSON` - **VCORE_OMNITOKEN_JSON output file.**\n\n - `VCORE_REPORTS_FLAT` - **VCORE_REPORTS_FLAT output file. Settlement report format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_SAFERPAYMENT_JSON` - **VCORE_SAFERPAYMENT_JSON output file.**\n\n - `VCORE_TXN_ISO8583` - **VCORE_TXN_ISO8583 output file. Transaction authorization processing for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_UPDATE_FLAT` - **VCORE_UPDATE_FLAT output file. Old merchant boarding update file format and structure for the WorldPay (aka Vantiv) Core processor.**\n\n - `VCORE_VARSHEET_JSON` - **VCORE_VARSHEET_JSON output file.**\n\n - `WEBSHIELD_FORM` - **WEBSHIELD_FORM output file. Risk decision integration request format and structure for the Webshield entity underwriting service.**\n\n - `WEBSHIELD_JSON` - **WEBSHIELD_JSON output file. Risk decision integration response format and structure for the Webshield entity underwriting service.**\n\n - `WELLSACH_BATCH_FLAT` - **WELLSACH_BATCH_FLAT output file.**\n\n - `WELLSACH_PAYOUT_FLAT` - **WELLSACH_PAYOUT_FLAT output file.**\n\n - `WELLSACH_TXN_FLAT` - **WELLSACH_TXN_FLAT output file.**\n\n - `WELLSFARGO_BOARD_XML` - **WELLSFARGO_BOARD_XML output file. Merchant boarding format and structure for the Wells Fargo Merchant Services processor.**\n\n - `WELLSFARGO_REPORT_CSV` - **WELLSFARGO_REPORT_CSV output file.**\n\n - `WELLSFARGO_REPORT_FLAT` - **WELLSFARGO_REPORT_FLAT output file.**\n\n - `WFSINGLE_REPORT_FLAT` - **WFSINGLE_REPORT_FLAT output file.**\n\n - `WFSINGLE_BOARD_XML` - **WFSINGLE_BOARD_XML output file.**\n\n
" } ] }, "credential": { "allOf": [ { "$ref": "#/$defs/configurationStageCredentials" }, { "description": "The credential used for configurationStage resource. \n\n
\nValid Values \n\n - `transaction` - **Credential used for transaction processing.**\n\n - `batch` - **Credential used for transaction batches.**\n\n - `boarding` - **Credential used merchant boarding.**\n\n - `paymentUpdates` - **Account updater (the process through which old/expired credit cards are automatically updated).**\n\n - `payout` - **Credential used for payouts.**\n\n - `payoutCredit` - **Credential used for transaction batches.**\n\n - `payoutDebit` - **Credential used for transaction batches.**\n\n - `chargeback` - **Credential used for chargeback processing and updating.**\n\n - `txnReport` - **Credential used for transaction reports.**\n\n - `account` - **Credential used for account integrations.**\n\n - `entityDecision` - **Credential used for entity decisions.**\n\n - `txnCheck` - **Credential used for transaction verifications.**\n\n - `payoutReport` - **Credential used for payout reports.**\n\n - `feeReport` - **Credential used for fee reports.**\n\n - `chargebackReport` - **Credential used for chargeback reports.**\n\n - `binReport` - **Credential used for binReports.**\n\n - `watchlist` - **Third party watchlist download .**\n\n - `encryption` - **Credential used for encryption.**\n\n - `changeRequest` - **Credential used for changeRequest.**\n\n
" } ] }, "url": { "type": "string", "description": "The url used for configurationStage resource. It will consist of a combination of at least one path, and restful id. Placeholders can be used for the restful ids such as https://sample.com/:placeholder:. Valid placeholders are: entity, merchant, member, chargeback, and document. The field is stored as a text string and must be between 1 and 500 characters long." }, "dir": { "type": "string", "description": "The directory used once connected. \nThis field is stored as a text string and must be between 1 and 500 characters long." }, "restId": { "type": "string", "description": "The indicator of the field when ref Id is found. \nThis field is stored as a text string and must be between 0 and 100 characters long." }, "mapToData": { "type": "string", "description": "A string-JSON representing the data injection mapping between the third party’s response and our internal data array." }, "file": { "type": "string", "description": "The specification on how the file will be named on write. \nThis field is stored as a JSON string and must be between 0 and 5000 characters long." }, "filter": { "type": "string", "description": "The filter applied when successful on data read. \nThis field is stored as a JSON string and must be between 0 and 5000 characters long." }, "extension": { "allOf": [ { "$ref": "#/$defs/configurationStageExtension" }, { "description": "The extension of the file." } ] }, "namespace": { "type": [ "string", "null" ], "description": "The namespace used for the configurationStage resource. \nThis field is stored as a text string and must be between 0 and 500 characters long." }, "dynamicStage": { "type": [ "string", "null" ], "description": "Only used in case the it is dynamic stage. \nThis field is stored as a JSON string, must be between 0 and 5000 characters long, and have a property key name with value of stage name and id key." }, "curlOptions": { "type": [ "string", "null" ], "description": "With the specificity of the configuration stages, it holds different integration methods, part of it is holding specific connection details that is needed to consume the service. The curlOptions is used to hold those specifics, things like SSLCERT, SSLKEY etc" }, "headers": { "type": "string", "description": "The headers used for the configurationStage resource. \nThis field is stored as a JSON string and must be between 0 and 5000 characters long." }, "callDelay": { "type": "integer", "description": "Delay to be applied before calling the resource in microseconds. \nRange allowed between 0 and 10 secs (10000) miliseconds.", "contentEncoding": "int32" }, "connectTimeout": { "type": "integer", "description": "The connection timeout duration (in seconds) for API calls.", "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
" } ] }, "fileConfigFilter": { "type": [ "string", "null" ] } } }, "configurationType": { "title": "configurationType", "enum": [ "create", "read", "update", "delete" ], "type": "string" }, "configurationsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division associated with this configuration resource." }, "configurationsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this configuration resource." }, "configurationsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this configuration resource." }, "configurationsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org associated with this configuration resource." }, "configurationsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition associated with this configuration resource." }, "configurationsName": { "title": "configurationsName", "enum": [ "account", "batchTxn", "binReport", "board", "chargeback", "decision", "decisionBoard", "decisionTxn", "echeckTxn", "encryption", "omnitoken", "onlineTxn", "onlineTxnSocket", "paymentUpdates", "payout", "payoutCredit", "payoutDebit", "plaid", "reports", "register", "saferPayment", "unregister", "varsheetRetrieval", "watchlist" ], "type": "string" }, "configurationsResponse": { "title": "configurationsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/configurationsModelLogin" }, { "description": "The identifier of the Login that owns this configuration resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/configurationsModelEntity" }, { "description": "The identifier of the Entity associated with this configuration resource." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/configurationsModelOrg" }, { "description": "The identifier of the Org associated with this configuration resource." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/configurationsModelDivision" }, { "description": "The identifier of the Division associated with this configuration resource." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/configurationsModelPartition" }, { "description": "The identifier of the Partition associated with this configuration resource." } ] }, "integration": { "allOf": [ { "$ref": "#/$defs/configurationIntegration" }, { "description": "The integration associated with this configuration resource.\n\n
\nValid Values\n\n- `ACH` - **ACH integration.**\n- `APPLE` - **APPLE integration.**\n- `ELAVON` - **ELAVON integration.**\n- `FEDACH` - **FEDACH integration.**\n- `FIRSTDATA` - **FIRSTDATA integration.**\n- `LEGITSCRIPT` - **LEGITSCRIPT integration.**\n- `NEUTRINO` - **NEUTRINO integration.**\n- `OFAC` - **OFAC integration.**\n- `OMNITOKEN` - **OMNITOKEN integration.**\n- `PAYRIX` - **PAYRIX integration.**\n- `PLAID` - **PLAID integration.**\n- `PUSHY` - **PUSHY integration.**\n- `SAFERPAYMENT` - **SAFERPAYMENT integration.**\n- `SIFT` - **SIFT integration.**\n- `SOCURE` - **SOCURE integration.**\n- `SOUNDPAYMENTS` - **SOUNDPAYMENTS integration.**\n- `TDBANK` - **TDBANK integration.**\n- `TDBANKCA` - **TDBANKCA integration.**\n- `VANTIV` - **VANTIV integration.**\n- `VCORE` - **VCORE integration.**\n- `WEBSHIELD` - **WEBSHIELD integration.**\n- `WELLSACH` - **WELLSACH integration.**\n- `WELLSFARGO` - **WELLSFARGO integration.**\n- `WFSINGLE` - **WFSINGLE integration.**\n- `WORLDPAY` - **WORLDPAY integration.**\n\n
" } ] }, "name": { "allOf": [ { "$ref": "#/$defs/configurationsName" }, { "description": "The name of this configuration resource.\n\n
\nValid Values\n\n- `account` - **Account. The specified configuration will be used for bank accounts integrations.**\n- `batchTxn` - **BatchTxn. The specified configuration will be used for processing transaction batches.**\n- `binReport` - **BinReport. The specified configuration will be used for bin reports integrations.**\n- `board` - **Board. The specified configuration will be used for boarding merchants.**\n- `chargeback` - **Chargeback. The specified configuration will be used for everything related to chargebacks.**\n- `decision` - **Decision. The specified configuration will be used for everything related to decisions.**\n- `decisionBoard` - **This holds configuration for running boarding decision policy on entity through Risk MS.**\n- `decisionTxn` - **DecisionTxn is used for running transaction decision policy through the Risk MS.**\n- `echeckTxn` - **EcheckTxn. The specified configuration will be used to get reports of echeck transactions as well as getting additional information about those transactions.**\n- `encryption` - **Holds the configuration for running Google and Apple Pay encryption/decryption through the Payrix Encryption Service.**\n- `omnitoken` - **Holds the configuration parameters for omnitoken services.**\n- `onlineTxn` - **OnlineTxn. The specified configuration will be used to process transactions online without a batch.**\n- `onlineTxnSocket` - **OnlineTxnSocket.**\n- `paymentUpdates` - **PaymentUpdates.**\n- `payout` - **Payout. The specified configuration will be used for everything related to payouts.**\n- `payoutCredit` - **Holds the configuration for processing payout credit through the integration service.**\n- `payoutDebit` - **Holds the configuration for processing payouts debit through the integration service.**\n- `plaid` - **Holds the configuration parameters for Plaid services (connecting accounts, getting identity, etc.).**\n- `reports` - **Reports. The specified configuration will be used to import processed transactions.**\n- `register` - **Register.**\n- `saferPayment` - **Holds the configuration parameters for safer payment VAS.**\n- `unregister` - **Unregister.**\n- `varsheetRetrieval` - **Holds the configuration parameters for varsheet retrieval.**\n- `watchlist` - **Watchlist. The specified configuration will be used to receive a watch list by the OFAC.**\n\n
" } ] }, "type": { "allOf": [ { "$ref": "#/$defs/configurationType" }, { "description": "The type of configuration resource.\n\n
\nValid Values\n\n- `create` - **Create type of configuration.**\n- `read` - **Read type of configuration.**\n- `update` - **Update type of configuration.**\n- `delete` - **Delete type of configuration.**\n\n
" } ] }, "options": { "type": "string", "description": "The options used for this configuration 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
" } ] }, "configurationStages": { "type": "array", "items": { "$ref": "#/$defs/configurationStagesResponse" }, "description": "" } } }, "confirmCodeType": { "title": "confirmCodeType", "enum": [ "password", "email" ], "type": "string" }, "confirmCodesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login associated with this confirmation code." }, "confirmCodesResponse": { "title": "confirmCodesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/confirmCodesModelLogin" }, { "description": "The identifier of the Login associated with this confirmation code." } ] }, "type": { "allOf": [ { "$ref": "#/$defs/confirmCodeType" }, { "description": "The type of this confirmCode.\n\n
\nValid Values\n\n- `password` - **Forgot Password**\n- `email` - **Verify Email**\n\n
" } ] }, "key": { "type": "string", "description": "The cryptographically secure, randomly generated key to be used for verification." }, "email": { "type": "string", "description": "If the 'type' of this confirmation code is '2' (email), then this field represents the email address that requires verification." }, "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
" } ] } } }, "contactsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this Contact relates to." }, "contactsResponse": { "title": "contactsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/contactsModelEntity" }, { "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." }, "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." }, "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." }, "country": { "allOf": [ { "$ref": "#/$defs/country" }, { "description": "The country being used for a request. DEFAULT VALUE: `USA`" } ] }, "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." }, "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
" }, "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." }, "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." }, "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." }, "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" }, "creator": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that created this resource." }, "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" }, "credentialsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this Credential resource belongs to." }, "credentialsModelSecret": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/secretsResponse" } ], "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." }, "credentialsResponse": { "title": "credentialsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/credentialsModelEntity" }, { "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": { "allOf": [ { "$ref": "#/$defs/credentialsModelSecret" }, { "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" }, "currencyRatesModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "If this currency rate relates to a division, then this field stores the identifier of the Division." }, "currencyRatesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "If this currency rate relates to an entity, then this field stores the identifier of the Entity." }, "currencyRatesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this resource." }, "currencyRatesModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "If this currency rate relates to an org, then this field stores the identifier of the Org." }, "currencyRatesModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "If this currency rate relates to a partition, then this field stores the identifier of the Partition." }, "currencyRatesResponse": { "title": "currencyRatesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/currencyRatesModelLogin" }, { "description": "The identifier of the Login that owns this resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/currencyRatesModelEntity" }, { "description": "If this currency rate relates to an entity, then this field stores the identifier of the Entity." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/currencyRatesModelOrg" }, { "description": "If this currency rate relates to an org, then this field stores the identifier of the Org." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/currencyRatesModelDivision" }, { "description": "If this currency rate relates to a division, then this field stores the identifier of the Division." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/currencyRatesModelPartition" }, { "description": "If this currency rate relates to a partition, then this field stores the identifier of the Partition." } ] }, "fromCurrency": { "allOf": [ { "$ref": "#/$defs/CurrencyRatesFromCurrency" }, { "description": "The currency that will serve as base for this rate." } ] }, "toCurrency": { "allOf": [ { "$ref": "#/$defs/currencyRatesToCurrency" }, { "description": "The currency that the fromCurrency will be converting to." } ] }, "rate": { "type": "number", "description": "The rate of this currency in cents(up to three decimal points)." }, "start": { "type": "integer", "description": "The start date that this rate will start to be effective.", "contentEncoding": "int64" }, "finish": { "type": "integer", "description": "The finish date that this rate will stop being effective.", "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
" } ] } } }, "currencyRatesToCurrency": { "title": "currencyRatesToCurrency", "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" }, "customersModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The ID of the Entity that owns this resource." }, "customersModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The ID of the Login that owns this resource." }, "customersModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The ID of the Merchant associated with this Customer." }, "customersResponse": { "title": "customersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/customersModelLogin" }, { "description": "The ID of the Login that owns this resource." } ] }, "merchant": { "allOf": [ { "$ref": "#/$defs/customersModelMerchant" }, { "description": "The ID of the Merchant associated with this Customer." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/customersModelEntity" }, { "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." }, "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." }, "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." }, "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." } ] }, "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." }, "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
" }, "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." }, "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." }, "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." }, "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." }, "authTokenCustomer": { "type": "string", "description": "The customer reference from the authToken used for user authentication, if available." }, "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/invoicesResponse" }, "description": "" }, "tokens": { "type": "array", "items": { "$ref": "#/$defs/tokensResponse" }, "description": "" } } }, "cycle": { "title": "cycle", "enum": [ "retrieval", "first", "arbitration", "reversal", "representment", "preArbitration", "arbitrationLost", "arbitrationSplit", "arbitrationWon", "issuerAcceptPreArbitration", "issuerDeclinedPreArbitration", "responseToIssuerPreArbitration", "merchantAcceptedPreArbitration", "merchantDeclinedPreArbitration", "preCompliance", "compliance" ], "type": "string" }, "decisionActionType": { "title": "decisionActionType", "enum": [ "equal", "notEqual", "contains", "greater", "less" ], "type": "string" }, "decisionActionsApplication": { "title": "decisionActionsApplication", "enum": [ "account", "txn", "entity" ], "type": "string" }, "decisionActionsResponse": { "title": "decisionActionsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "decision": { "type": "string", "description": "The identifier of the Decision to which this resource applies." }, "action": { "allOf": [ { "$ref": "#/$defs/descisionActionsAction" }, { "description": "The action to take when this check fails.\n\n
\nValid Values\n\n- `1` - **Block txn, will never be processed. The Entity is sent to the manual review queue.**\n- `3` - **Hold txn, will not be captured.**\n- `4` - **Reserve txn, funds should be reserved.**\n- `5` - **Block current activity, no change for merchant.**\n- `8` - **We onboard the merchant and wait for manual check later.**\n\n
" } ] }, "application": { "allOf": [ { "$ref": "#/$defs/decisionActionsApplication" }, { "description": "Where the action defined by this DecisionAction should apply.\n\n
\nValid Values\n\n- `account` - **Account type Decision.**\n- `txn` - **Txn type Decision.**\n- `entity` - **Entity type Decision.**\n\n
" } ] }, "scoreType": { "allOf": [ { "$ref": "#/$defs/decisionActionsScoreType" }, { "description": "The type of score result on the related Decision.\n\n
\nValid Values\n\n- `low` - **Only applies if the check hit the low of the parent decision.**\n- `high` - **Only applies if the check hit the high of the parent decision.**\n- `none` - **Only applies if the check did not hit the high or low of the parent decision.**\n\n
" } ] }, "type": { "allOf": [ { "$ref": "#/$defs/decisionActionType" }, { "description": "The type of DecisionAction.\n\n
\nValid Values\n\n- `equal` - **Equal.**\n- `notEqual` - **Not Equal.**\n- `contains` - **Contains.**\n- `greater` - **Greater.**\n- `less` - **Less.**\n\n
" } ] }, "field": { "type": "string", "description": "The result field to check." }, "score": { "type": "string", "description": "The score to check." }, "data": { "type": "string", "description": "The decisionAction data will be matched with verificationReuslts data." }, "message": { "type": "string", "description": "The decisionAction message will be matched with verificationReuslts message." }, "code": { "type": "string", "description": "The decisionAction code will be matched with verificationReuslts code." }, "grouping": { "type": "string", "description": "A name for a group of decisionActions to be applied in conjunction when evaluating this DecisionAction; when grouping is used, the DecisionActions will not apply unless they all match." }, "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
" } ] } } }, "decisionActionsScoreType": { "title": "decisionActionsScoreType", "enum": [ "low", "high", "none" ], "type": "string" }, "decisionRuleType": { "title": "decisionRuleType", "enum": [ "less", "equal", "notEqual", "greater", "swiped", "signed", "type", "origin", "method", "cvvResult", "avsResult", "3dsResult", "related", "relatedDelay", "relatedFloor", "relatedCeil", "mcc", "merchantCountry", "issuerCountry", "international", "platform", "methodType", "emv", "misuse", "bin", "primary", "fundingCurrencyEqual", "fundingCurrencyNotEqual", "fundingCurrencyMismatch", "settledCurrencyMismatch", "imported", "subscription", "publicAuth", "clientIp", "debtRepayment", "cofType", "entryMode" ], "type": "string" }, "decisionRulesResponse": { "title": "decisionRulesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "decision": { "type": "string", "description": "The identifier of the Decision that this Decision Rule applies." }, "name": { "type": "string", "description": "The name of this Decision Rule. This field is stored as a text string and must be between 0 and 100 characters long." }, "description": { "type": "string", "description": "Description of the Decision Rules." }, "type": { "allOf": [ { "$ref": "#/$defs/decisionRuleType" }, { "description": "The type of logic to apply with this Decision Rule.\n\n
\nValid Values\n\n- `less` - **Less.**\n- `equal` - **Equal.**\n- `notEqual` - **Not Equal.**\n- `greater` - **Greater.**\n- `swiped` - **Swiped.**\n- `signed` - **Signed.**\n- `type` - **Type.**\n- `origin` - **Origin.**\n- `method` - **Method.**\n- `cvvResult` - **CVV Result.**\n- `avsResult` - **AVS Result.**\n- `3dsResult` - **3DS Result. The Decision applies based on the results of a 3DS check.**\n- `related` - **Related.**\n- `relatedDelay` - **Related Delay.**\n- `relatedFloor` - **Related Floor.**\n- `relatedCeil` - **Related Ceil.**\n- `mcc` - **MCC.**\n- `merchantCountry` - **Merchant Country.**\n- `issuerCountry` - **Issuer Country.**\n- `international` - **International.**\n- `platform` - **Platform.**\n- `methodType` - **Method Type.**\n- `emv` - **EMV.**\n- `misuse` - **Misuse.**\n- `bin` - **BIN.**\n- `primary` - **Primary.**\n- `fundingCurrencyEqual` - **Funding Currency Equal.**\n- `fundingCurrencyNotEqual` - **Funding Currency Not Equal.**\n- `fundingCurrencyMismatch` - **Funding Currency Mismatch.**\n- `settledCurrencyMismatch` - **Settled Currency Mismatch.**\n- `imported` - **Imported.**\n- `subscription` - **Subscription.**\n- `publicAuth` - **Public Auth.**\n- `clientIp` - **Client IP.**\n- `debtRepayment` - **Debt Repayment.**\n- `cofType` - **COF Type.**\n- `entryMode` - **Entry Mode.**\n\n
" } ] }, "value": { "type": "integer", "description": "The value to compare against when evaluating this Decision Rule.", "contentEncoding": "int32" }, "grouping": { "type": "string", "description": "A name for a group of rules to be applied in conjunction when evaluating this Decision Rule; When grouping is used, the Decision 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
" } ] } } }, "decisionType": { "title": "decisionType", "enum": [ "merchantFailureLimit", "merchantFailureRatio", "saleTotalLimit", "refundTotalLimit", "averageSaleCountLimit", "merchantRefundSaleRatio", "merchantPaymentSuccessLimit", "ipFailureLimit", "ipFailureRatio", "inactiveMerchant", "merchantPaymentFailureLimit", "merchantCaptureWithoutAuthLimit", "refundWithoutSale", "refundWithoutSaleLimit", "captureAboveAuthLimit", "fraudScore", "cvv", "avs", "aavs", "duplicateTxn", "merchantMatch", "currencyConversion", "settledCurrencyMismatch", "initialTxn", "similarTotalLimit", "similarTotalRatio", "saleTotalMinimum", "limit", "ratio", "txnWatchlist", "balanceRefundLimit" ], "type": "string" }, "decisionsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division that this decision resource belongs to." }, "decisionsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "If this decision resource relates to an Entity, then this field stores the identifier of the Entity." }, "decisionsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "If this decision resource relates to an Org, then this field stores the identifier of the Org." }, "decisionsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition that this decision resource belongs to." }, "decisionsPeriod": { "title": "decisionsPeriod", "enum": [ "days", "weeks", "months", "years", "seconds", "minutes", "hours" ], "type": "string" }, "decisionsResponse": { "title": "decisionsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "type": "string", "description": "The identifier of the Login that owns this decisions resource." }, "org": { "allOf": [ { "$ref": "#/$defs/decisionsModelOrg" }, { "description": "If this decision resource relates to an Org, then this field stores the identifier of the Org." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/decisionsModelDivision" }, { "description": "The identifier of the Division that this decision resource belongs to." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/decisionsModelPartition" }, { "description": "The identifier of the Partition that this decision resource belongs to." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/decisionsModelEntity" }, { "description": "If this decision resource relates to an Entity, then this field stores the identifier of the Entity." } ] }, "decision": { "type": "string", "description": "The identifier of a linked decision resource that acts in coordination with this decision. When you define a decision attribute here, the referenced decision becomes the 'parent' resource. The action field set on the 'parent' resource determines the action that occurs if all of the linked decisions fail." }, "type": { "allOf": [ { "$ref": "#/$defs/decisionType" }, { "description": "The type of check to perform.\n\n
\nValid Values\n\n- `merchantFailureLimit` - **Exceeded the maximum number of allowed failed authorizations.**\n- `merchantFailureRatio` - **Exceeded the maximum ratio of allowed failed authorizations.**\n- `saleTotalLimit` - **Exceeded the maximum allowed sale total value.**\n- `refundTotalLimit` - **Exceeded the maximum allowed refund total value.**\n- `averageSaleCountLimit` - **Exceeded the allowed maximum payment size (individual transaction amount).**\n- `merchantRefundSaleRatio` - **Exceeded the maximum allowed ratio of refunds to sales.**\n- `merchantPaymentSuccessLimit` - **This is used to check if the merchant has charged the same payment more than X times on a given period of time.**\n- `ipFailureLimit` - **Exceeded the maximum allowed number of failed authorizations for a particular IP address.**\n- `ipFailureRatio` - **Exceeded the maximum allowed ratio of failed authorizations for a particular IP address.**\n- `inactiveMerchant` - **The Merchant is not active.**\n- `merchantPaymentFailureLimit` - **Exceeded the maximum allowed number of failed transactions.**\n- `merchantCaptureWithoutAuthLimit` - **Exceeded the maximum allowed number of transactions without authorizations.**\n- `refundWithoutSale` - **Refund transaction does not have an associated sale transaction.**\n- `refundWithoutSaleLimit` - **Exceeded the maximum number of refund transactions that do not have associated sale transactions.**\n- `captureAboveAuthLimit` - **Exceeded the maximum authorized value for transactions with failed authorizations.**\n- `fraudScore` - **Transaction fraud score.**\n- `cvv` - **CVV.**\n- `avs` - **AVS.**\n- `aavs` - **AAVS.**\n- `duplicateTxn` - **Duplicate transaction.**\n- `merchantMatch` - **Transaction matches merchant details.**\n- `currencyConversion` - **Transaction triggers currency conversion.**\n- `settledCurrencyMismatch` - **Transaction settled currency mismatch.**\n- `initialTxn` - **Initial transaction of this type.**\n- `similarTotalLimit` - **Exceeded the limit of transactions with equal totals.**\n- `similarTotalRatio` - **Exceeded the ratio of transactions with equal totals.**\n- `saleTotalMinimum` - **Minimum transaction amount.**\n- `limit` - **Exceeded the maximum allowed number of authorizations.**\n- `ratio` - **This is used to check if similar transactions have reached the ratio of auth transactions in a given period of time.**\n- `txnWatchlist` - **Check the transaction data against a custom watchlist.**\n- `balanceRefundLimit` - **This is used to check if a merchant has enough balance to process a REFUND transaction and it is within the scope of the threshold.**\n\n
" } ] }, "application": { "allOf": [ { "$ref": "#/$defs/decisionActionsApplication" }, { "description": "Where the action defined by this DecisionAction should apply.\n\n
\nValid Values\n\n- `account` - **Account type Decision.**\n- `txn` - **Txn type Decision.**\n- `entity` - **Entity type Decision.**\n\n
" } ] }, "target": { "allOf": [ { "$ref": "#/$defs/decisionsTarget" }, { "description": "The target that this decision should apply at.\n\n
\nValid Values\n\n- `activation` - **Terminal activation.**\n- `auth` - **Apply this decision during transaction authorization.**\n- `postauth` - **Immediately after authorization.**\n- `capture` - **Apply this decision during transaction capture.**\n- `refund` - **Apply this decision when processing a refund.**\n- `createEntity` - **createEntity. Process decisions during entity creation.**\n- `underwriting` - **Underwriting. Check the members before they are boarded.**\n- `preboard` - **Preboard. Check the Merchant before they are boarded.**\n- `postboard` - **Check the Merchant after they are boarded.**\n- `txn` - **Check the Merchant when they process a Transaction.**\n- `txnVolume` - **Check the Merchant when their transaction volume hits a certain amount.**\n- `payout` - **Check the Merchant when a Payout occurs.**\n- `payoutVolume` - **Check the Merchant when the volume of Payouts to the Merchant hits a certain amount.**\n\n
" } ] }, "options": { "type": "integer", "description": "The options for the Verification are specified as a sum of the desired options.", "contentEncoding": "int32" }, "additionalOptions": { "type": "integer", "description": "The additionalOptions for the Verification are specified as a sum of the desired options.", "contentEncoding": "int32" }, "level": { "type": "string", "description": "The levels of decision admin, merchant, division, partition." }, "errorMessage": { "type": "string", "description": "The error message for the decision: If the field is null the error message will be a generic failure message, if the field is empty the error message will be a specific error message, if the field is set to a string the error message will be that string." }, "reason": { "type": "string", "description": "The reason for the decision. If the field is null the error message will be a generic message, if the field is set to a string the reason message will be that string." }, "action": { "allOf": [ { "$ref": "#/$defs/descisionAction" }, { "description": "The action to take when this check fails.\n\n
\nValid Values\n\n- `0` - **No action.**\n- `1` - **Block txn, will never be processed. The Entity is sent to the manual review queue.**\n- `3` - **Hold txn, will not be captured.**\n- `4` - **Reserve txn, funds should be reserved.**\n- `5` - **Block current activity, no change for merchant.**\n- `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**\n- `7` - **We did not have policies to process.**\n- `8` - **We onboard the merchant and wait for manual check later.**\n- `9` - **Schedule the automatic release of the reserve.**\n- `10` - **Hold txn, will not be captured. Automatic release when the associated sale is done.**\n\n
" } ] }, "sequence": { "type": "integer", "description": "A sequence number to use when applying multiple linked decisions: When two or more decisions are linked using their 'decision' fields, the checks with lower 'sequence' numbers are applied first; this field is specified as an integer.", "contentEncoding": "int32" }, "amount": { "type": "integer", "description": "The minimum value that the Transaction must be to target this decision, The unit of measure is determined by the type of check.", "contentEncoding": "int64" }, "value": { "type": "string", "description": "The amount that the associated Transaction should be compared against. The units for this field depend on the type of check: for checks that are based on a ratio, specify the amount as a percentage in basis points; for checks that are based on a dollar amount, specify the amount in cents; for checks that are based on a count, specify the exact value as an integer." }, "period": { "allOf": [ { "$ref": "#/$defs/decisionsPeriod" }, { "description": "A date indicator that determines how far back in time time-based checks should be checked. This field works in conjunction with the 'periodFactor' field, which multiplies this basic period.\n\n
\nValid Values\n\n- `days` - **Days. The basic value for the date range is set in days.**\n- `weeks` - **Weeks. The basic value for the date range is set in weeks.**\n- `months` - **Months. The basic value for the date range is set in months.**\n- `years` - **Years. The basic value for the date range is set in years.**\n- `seconds` - **Seconds. The basic value for the date range is set in seconds.**\n- `minutes` - **Minutes. The basic value for the date range is set in minutes.**\n- `hours` - **Hours. The basic value for the date range is set in hours.**\n\n
" } ] }, "periodFactor": { "type": "integer", "description": "A multiplier that you can use to adjust the basic date range set in the 'period' field, such as daily, weekly, monthly, or annually; this field is specified as an integer and its value determines how the interval is multiplied.", "contentEncoding": "int32" }, "schedule": { "type": "string", "description": "The schedule that determines when this Decision is triggered to check entities." }, "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 field is specified as an integer and its value determines how the interval is multiplied.", "contentEncoding": "int32" }, "start": { "type": "integer", "description": "The date on which checking of the Decision should start 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, or the present date.", "contentEncoding": "int32" }, "finish": { "type": "integer", "description": "The date on which checking of the Decision should end. 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" }, "low": { "type": "integer", "description": "A lower cut-off value for the score in this decision; the check fails if the score is equal to or below this value.", "contentEncoding": "int32" }, "high": { "type": "integer", "description": "An upper cut-off value for the score in this decision; the check fails if the score is equal to or above this value.", "contentEncoding": "int32" }, "useCache": { "allOf": [ { "$ref": "#/$defs/decisionsUseCache" }, { "description": "Whether to check for and use existing Verifications and Verification Results for this decision.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "cacheTime": { "type": "integer", "description": "The time caching limit to check for existing verification.", "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
" } ] }, "decisionActions": { "type": "array", "items": { "$ref": "#/$defs/decisionActionsResponse" }, "description": "" }, "decisionRules": { "type": "array", "items": { "$ref": "#/$defs/decisionRulesResponse" }, "description": "" }, "decisions": { "type": "array", "items": { "$ref": "#/$defs/decisionsResponse" }, "description": "" }, "watchlist": { "type": "array", "items": { "$ref": "#/$defs/watchlistsResponse" }, "description": "" } } }, "decisionsTarget": { "title": "decisionsTarget", "enum": [ "activation", "auth", "postauth", "capture", "refund", "createEntity", "underwriting", "preboard", "postboard", "txn", "txnVolume", "payout", "payoutVolume" ], "type": "string" }, "decisionsUseCache": { "title": "decisionsUseCache", "enum": [ 0, 1 ], "type": "integer" }, "descisionAction": { "title": "descisionAction", "enum": [ 0, 1, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer" }, "descisionActionsAction": { "title": "descisionActionsAction", "enum": [ 1, 3, 4, 5, 8 ], "type": "integer" }, "details": { "title": "details", "type": "object", "properties": { "requestId": { "type": "integer", "description": "A unique identifier set by the API client, that is echoed by the response. \nThe request ID can be useful in troubleshooting and monitoring.", "contentEncoding": "int32" }, "totals": { "description": "Returns an empty array if we don't pass totals header." }, "page": { "allOf": [ { "$ref": "#/$defs/detailsProperties" }, { "description": "Where the response lists multiple resources, the API splits the response into several 'pages'. \nThis object indicates the current and last available pages in the list." } ] } }, "description": "An object describing the response, including the request ID and pagination indicators." }, "detailsProperties": { "title": "detailsProperties", "type": "object", "properties": { "current": { "type": "integer", "description": "The current page in the paginated resource list.", "contentEncoding": "int32" }, "last": { "type": "integer", "description": "The last available page in the paginated resource list.", "contentEncoding": "int32" }, "hasMore": { "type": "boolean", "description": "Indicates if another page of results is available." } }, "description": "Where the response lists multiple resources, the API splits the response into several 'pages'. \nThis object indicates the current and last available pages in the list." }, "disbursementEntriesModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "The identifier of the Disbursement that this DisbursementEntry resource refers to." }, "disbursementEntriesModelEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The identifier of the Entry that this DisbursementEntry resource refers to." }, "disbursementEntriesModelEventId": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the record that is associated with this DisbursementEntry resource." }, "disbursementEntriesModelPendingEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/pendingEntriesResponse" } ], "description": "The identifier of the PendingEntry that this DisbursementEntry resource refers to." }, "disbursementEntriesModelReserveEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/reserveEntriesResponse" } ], "description": "The identifier of the ReserveEntry that this DisbursementEntry resource refers to." }, "disbursementEntriesResponse": { "title": "disbursementEntriesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "disbursement": { "allOf": [ { "$ref": "#/$defs/disbursementEntriesModelDisbursement" }, { "description": "The identifier of the Disbursement that this DisbursementEntry resource refers to." } ] }, "entry": { "allOf": [ { "$ref": "#/$defs/disbursementEntriesModelEntry" }, { "description": "The identifier of the Entry that this DisbursementEntry resource refers to." } ] }, "pendingEntry": { "allOf": [ { "$ref": "#/$defs/disbursementEntriesModelPendingEntry" }, { "description": "The identifier of the PendingEntry that this DisbursementEntry resource refers to." } ] }, "reserveEntry": { "allOf": [ { "$ref": "#/$defs/disbursementEntriesModelReserveEntry" }, { "description": "The identifier of the ReserveEntry that this DisbursementEntry resource refers to." } ] }, "event": { "allOf": [ { "$ref": "#/$defs/disbursementEntryEvent" }, { "description": "The event that triggered the funding activity\n\n
\nValid Values\n\n- `1` - **DAYS** DisbursementEntry for an Entry that triggers every day.\n- `2` - **WEEKS** DisbursementEntry for an Entry that triggers every week.\n- `3` - **MONTHS** DisbursementEntry for an Entry that triggers every month.\n- `4` - **YEARS** DisbursementEntry for an Entry that triggers every year.\n- `5` - **SINGLE** DisbursementEntry for an Entry related to a one-off event.\n- `6` - **AUTH** DisbursementEntry for an Entry related to the time of authorization of a transaction.\n- `7` - **CAPTURE** DisbursementEntry for an Entry related to the capture time of a Transaction.\n- `8` - **REFUND** DisbursementEntry for an Entry related to when a refund transaction is processed.\n- `9` - **BOARD** DisbursementEntry for an Entry related to when the Merchant is boarded.\n- `10` - **PAYOUT** DisbursementEntry for an Entry related to when a payout is processed.\n- `11` - **CHARGEBACK** DisbursementEntry for an Entry related to when a card chargeback occurs.\n- `12` - **OVERDRAFT** DisbursementEntry for an Entry related to when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE** DisbursementEntry for an Entry related to when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR** DisbursementEntry for an Entry related to when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL** DisbursementEntry for an Entry related to when an automated clearing house failure occurs.\n- `16` - **ACCOUNT** DisbursementEntry for an Entry related to when a bank account is verified.\n- `17` - **SIFT** DisbursementEntry for an Entry related to Transaction fraud score.\n- `18` - **ADJUSTMENT** DisbursementEntry for an Entry related to adjusted funds.\n- `19` - **RETRIEVAL** DisbursementEntry for an Entry related to Retrieval Request Chargeback.\n- `20` - **ARBITRATION** DisbursementEntry for an Entry related to Arbitration Chargeback.\n- `21` - **ECSALE** DisbursementEntry for an Entry related to an eCheck Sale.\n- `22` - **ECREFUND** DisbursementEntry for an Entry related to an eCheck Refund.\n- `23` - **ECRETURN** DisbursementEntry for an Entry related to an eCheck Return.\n- `24` - **SETTLEMENT** DisbursementEntry for an Entry related to transaction settlement.\n- `25` - **MISUSE** DisbursementEntry for an Entry related to Misuse of authorization.\n- `26` - **PROFIT_SHARE** DisbursementEntry for an Entry related to a profit sharing entry.\n- `27` - **UNAUTH** DisbursementEntry for an Entry related to an unauthorized entry.\n- `28` - **ACHNOC** DisbursementEntry for an Entry related to an ACH Notification of Change.\n- `29` - **ECNOC** DisbursementEntry for an Entry related to an eCheck Notifications of Change.\n- `30` - **ECFAIL** DisbursementEntry for an Entry related to an eCheck Fail.\n- `31` - **ECNSF** DisbursementEntry for an Entry related to an eCheck Non-Sufficient Funds.\n- `32` - **CURRENCY_CONVERSION** DisbursementEntry for an Entry related to a currency conversion.\n- `33` - **TERMINAL_TXN** DisbursementEntry for an Entry related to a terminal transaction.\n- `34` - **REVERSE_PAYOUT** DisbursementEntry for an Entry related to a payout that's been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT** DisbursementEntry for an Entry related to a payout that's been partially reversed.\n- `36` - **RESERVE_ENTRY** DisbursementEntry for an Entry related to reserved funds.\n- `37` - **RESERVE_ENTRY_RELEASE** DisbursementEntry for an Entry related to released reserves.\n- `38` - **PENDING_ENTRY** DisbursementEntry for an Entry related to pending funds.\n- `39` - **PENDING_PAID** DisbursementEntry for an Entry related to paid pending funds.\n- `40` - **REMAINDER** DisbursementEntry for an Entry on the remaining, non-disbursed funds.\n- `41` - **REMAINDER_USED** DisbursementEntry for an Entry related to previously non-disbursed funds.\n- `42` - **PENDING_REFUND_CANCELLED** DisbursementEntry for an Entry related to a pending refund that was cancelled.\n- `43` - **PAYMENT_CHECK** Single payment check (deprecated).\n- `44` - **PAYMENT_UPDATE** Single payment update.\n- `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).\n- `46` - **PAYMENT_GROUP_UPDATE** Group payment update.\n- `47` - **ENTRY_REFUND** Entry refunds.\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through a risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees.\n\n
" } ] }, "eventId": { "allOf": [ { "$ref": "#/$defs/disbursementEntriesModelEventId" }, { "description": "The identifier of the record that is associated with this DisbursementEntry resource." } ] }, "amount": { "type": "number", "description": "The total amount of this DisbursementEntry, This field is specified in cents(up to three decimal points)." }, "amountUsed": { "type": "number", "description": "The total amount used of this DisbursementEntry, This field is specified in cents(up to three decimal points)." }, "description": { "type": "string", "description": "A description of this DisbursementEntry." } } }, "disbursementEntryEvent": { "title": "disbursementEntryEvent", "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, 36, 37, 38, 39, 40, 41, 42, 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, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 101, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 601, 602, 603, 604, 605, 606, 607, 608 ], "type": "integer" }, "disbursementRefPlatform": { "title": "disbursementRefPlatform", "enum": [ "ELAVON", "VANTIV", "VCORE", "TDBANK", "TDBANKCA", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY" ], "type": "string" }, "disbursementRefStage": { "title": "disbursementRefStage", "enum": [ "create", "approve", "split", "failed" ], "type": "string" }, "disbursementRefsModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "The identifier of the Disbursement that this disbursementRef resource refers to." }, "disbursementRefsModelDisbursementRef": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementRefsResponse" } ], "description": "The identifier of the DisbursementRef that this disbursementRef resource refers to." }, "disbursementRefsResponse": { "title": "disbursementRefsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "disbursement": { "allOf": [ { "$ref": "#/$defs/disbursementRefsModelDisbursement" }, { "description": "The identifier of the Disbursement that this disbursementRef resource refers to." } ] }, "disbursementRef": { "allOf": [ { "$ref": "#/$defs/disbursementRefsModelDisbursementRef" }, { "description": "The identifier of the DisbursementRef that this disbursementRef resource refers to." } ] }, "platform": { "allOf": [ { "$ref": "#/$defs/disbursementRefPlatform" }, { "description": "The platform used to process this Transaction. \n\n
\nValid Values\n\n- `ELAVON` - The Elavon processor.\n\n- `VANTIV` - The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.\n\n- `VCORE` - The WorldPay (aka Vantiv) Core processor.\n\n- `TDBANK` - External funding with TD Bank via the Operating Account.\n\n- `TDBANKCA` - External funding with TD Bank Canada via the Operating Account.\n\n- `WELLSACH` - The Wells Fargo ACH processor.\n\n- `WELLSFARGO` - The Wells Fargo Merchant Services processor.\n\n- `WFSINGLE` - The WFSINGLE processor.\n\n- `WORLDPAY` - The WORLDPAY processor.\n\n
" } ] }, "companyId": { "type": "string", "description": "An identification document for a company." }, "ref": { "type": "string", "description": "The Disbursement reference code itself. This field is stored as a text string and must be between 1 and 50 characters long." }, "fileRef": { "type": "string", "description": "A file reference code that is stored as a text string and must be between 1 and 50 characters long." }, "stage": { "allOf": [ { "$ref": "#/$defs/disbursementRefStage" }, { "description": "The stage of the Disbursement reference. \n\n
\nValid Values\n\n- `create` - Funding is sent to the processor (based on prior split setup).\n\n- `approve` - Funding approved by the processor.\n\n- `split` - Disbursement amount is split for processing.\n\n- `failed` - Funding failed.\n\n
" } ] }, "amount": { "type": "integer", "description": "The amount of the disbursement related to this disbursementRef.", "contentEncoding": "int64" }, "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
" } ] }, "disbursementRefs": { "type": "array", "items": { "$ref": "#/$defs/disbursementRefsResponse" }, "description": "" }, "disbursementResults": { "type": "array", "items": { "$ref": "#/$defs/disbursementResultsResponse" }, "description": "" } } }, "disbursementResultCode": { "title": "disbursementResultCode", "enum": [ "pending", "internal", "nsf", "badAccount", "unauthorized", "general", "noc", "parameter", "sameDay", "transferDetails", "platform" ], "type": "string" }, "disbursementResultsModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "The identifier of the Disbursement that this disbursementResult resource refers to." }, "disbursementResultsModelDisbursementRef": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementRefsResponse" } ], "description": "The ID of the disbursementRef for which this result is recorded." }, "disbursementResultsPlatform": { "title": "disbursementResultsPlatform", "enum": [ "ELAVON", "VANTIV", "VCORE", "TDBANK", "TDBANKCA", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY" ], "type": "string" }, "disbursementResultsResponse": { "title": "disbursementResultsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "disbursement": { "allOf": [ { "$ref": "#/$defs/disbursementResultsModelDisbursement" }, { "description": "The identifier of the Disbursement that this disbursementResult resource refers to." } ] }, "disbursementRef": { "allOf": [ { "$ref": "#/$defs/disbursementResultsModelDisbursementRef" }, { "description": "The ID of the disbursementRef for which this result is recorded." } ] }, "code": { "allOf": [ { "$ref": "#/$defs/disbursementResultCode" }, { "description": "The code identifying the disbursement result.\n\n
\nValid Values \n\n- `pending` - **Disbursement processing is pending account verification.**\n\n- `internal` - **Failed. Internal note and/or failure.**\n\n- `nsf` - **Failed. Disbursement return due to insufficient funds.**\n\n- `badAccount` - **Failed. Disbursement return due to incorrect payment account information.**\n\n- `unauthorized` - **Failed. Disbursement return due to customer dispute of authorization.**\n\n- `general` - **General note and/or failure.**\n\n- `noc` - **Notice of change.**\n\n- `parameter` - **Disbursement processing withheld due to parameter configuration.**\n\n- `sameDay` - **Failed. Same-day processing note and/or failure.**\n\n- `transferDetails` - **Trace number note and/or data.**\n\n- `platform` - **Failed. Processor note and/or failure.**\n\n
" } ] }, "originalCode": { "type": "string", "description": "The original, unmapped code as received from the processor for this result." }, "platform": { "allOf": [ { "$ref": "#/$defs/disbursementResultsPlatform" }, { "description": "The platform used to process this Disbursement. \n\n
\nValid Values\n\n- `ELAVON` - **The Elavon processor.**\n\n- `VANTIV` - **The Worldpay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n\n- `VCORE` - **The Worldpay (aka Vantiv) Core processor.**\n\n- `TDBANK` - **External funding with TD Bank via the Operating Account.**\n\n- `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**\n\n- `WELLSACH` - **The Wells Fargo ACH processor.**\n\n- `WELLSFARGO` - **The Wells Fargo Merchant Services processor.**\n\n- `WFSINGLE` - **The WFSINGLE processor.**\n\n- `WORLDPAY` - **The WORLDPAY processor.**\n\n
" } ] }, "message": { "type": "string", "description": "The message string for this result." }, "amount": { "type": "integer", "description": "The amount of the disbursement relevant for this result.", "contentEncoding": "int64" }, "data": { "type": "string", "description": "Data (the trace number, if applicable)." } } }, "disbursementStatus": { "title": "disbursementStatus", "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer" }, "disbursementsDisbursementEntriesStatus": { "title": "disbursementsDisbursementEntriesStatus", "enum": [ "pending", "processing", "processed" ], "type": "string" }, "disbursementsFundingStatus": { "title": "disbursementsFundingStatus", "enum": [ "pending", "processed" ], "type": "string" }, "disbursementsModelAccount": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/accountsResponse" } ], "description": "The token of the accounts resource used for this Disbursement." }, "disbursementsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that owns this Disbursement." }, "disbursementsModelLastNegativeEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The last negative Entry processed included in the disbursement." }, "disbursementsModelLastNegativePendingEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/pendingEntriesResponse" } ], "description": "The last negative PendingEntry processed included in the disbursement." }, "disbursementsModelLastNegativeReserveEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/reserveEntriesResponse" } ], "description": "The last negative ReserveEntry processed included in the disbursement." }, "disbursementsModelLastPositiveEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The last positive Entry processed included in the disbursement." }, "disbursementsModelLastPositivePendingEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/pendingEntriesResponse" } ], "description": "The last positive PendingEntry processed included in the disbursement." }, "disbursementsModelLastPositiveReserveEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/reserveEntriesResponse" } ], "description": "The last positive ReserveEntry processed included in the disbursement." }, "disbursementsModelPayout": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/payoutsResponse" } ], "description": "The identifier of the Payout that represents the schedule for this Disbursement." }, "disbursementsModelSettlement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/settlementsResponse" } ], "description": "The settlement record for this disbursement." }, "disbursementsModelStatement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/statementsResponse" } ], "description": "The identifier of the Statement being paid by this Disbursement." }, "disbursementsResponse": { "title": "disbursementsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/disbursementsModelEntity" }, { "description": "The identifier of the Entity that owns this Disbursement." } ] }, "account": { "allOf": [ { "$ref": "#/$defs/disbursementsModelAccount" }, { "description": "The token of the accounts resource used for this Disbursement." } ] }, "payment": { "type": "string", "description": "A reference to the actual account or card data used for this disbursement. If someone changes the details in their bank account within Payrix Pro, the account token will point to a new account but the payment will always point to the data used for this disbursement." }, "payout": { "allOf": [ { "$ref": "#/$defs/disbursementsModelPayout" }, { "description": "The identifier of the Payout that represents the schedule for this Disbursement." } ] }, "settlement": { "allOf": [ { "$ref": "#/$defs/disbursementsModelSettlement" }, { "description": "The settlement record for this disbursement." } ] }, "statement": { "allOf": [ { "$ref": "#/$defs/disbursementsModelStatement" }, { "description": "The identifier of the Statement being paid by this Disbursement." } ] }, "description": { "type": "string", "description": "A description of this Disbursement." }, "secondaryDescriptor": { "type": "string", "description": "A secondary descriptor for the ACH transaction sent to the receiving bank." }, "amount": { "type": "integer", "description": "The total amount of this Disbursement.", "contentEncoding": "int64" }, "returnedAmount": { "type": "integer", "description": "The amount that has been returned within the disbursement.", "contentEncoding": "int64" }, "status": { "allOf": [ { "$ref": "#/$defs/disbursementStatus" }, { "description": "The current status of this Disbursement\n
Valid Values\n\n - `1` - **Requested.** The request for this Disbursement has been received.\n\n - `2` - **Processing.** This Disbursement is being processed to be paid out.\n\n - `3` - **Processed.** This Disbursement has been paid by ACH to the bank account referenced in the Disbursement data.\n\n - `4` - **Failed.** A problem occurred and the payment processor has failed to process this Disbursement.\n\n - `6` - **Returned.** This Disbursement has been returned.\n\n
" } ] }, "fundingStatus": { "allOf": [ { "$ref": "#/$defs/disbursementsFundingStatus" }, { "description": "Indicates if entries were processed for this Disbursement.
Valid Values\n\n - `pending` - **Pending entry creation and processing.**\n\n - `processed` - **Entry created and processed.**\n\n
" } ] }, "processed": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "A timestamp indicating when the Disbursement was processed. The format should be YYYY-MM-DD HH:MM:SS" }, "disbursementEntriesStatus": { "allOf": [ { "$ref": "#/$defs/disbursementsDisbursementEntriesStatus" }, { "description": "The current status of disbursementEntries creation.\n\n
\nValid Values\n\n- `pending` - **Pending entry creation and processing.**\n\n- `processing` - **Entry is still processing.** \n\n- `processed` - **Entry created and processed.**\n\n
" } ] }, "lastNegativeEntry": { "allOf": [ { "$ref": "#/$defs/disbursementsModelLastNegativeEntry" }, { "description": "The last negative Entry processed included in the disbursement." } ] }, "lastNegativePendingEntry": { "allOf": [ { "$ref": "#/$defs/disbursementsModelLastNegativePendingEntry" }, { "description": "The last negative PendingEntry processed included in the disbursement." } ] }, "lastPositiveReserveEntry": { "allOf": [ { "$ref": "#/$defs/disbursementsModelLastPositiveReserveEntry" }, { "description": "The last positive ReserveEntry processed included in the disbursement." } ] }, "lastPositiveEntry": { "allOf": [ { "$ref": "#/$defs/disbursementsModelLastPositiveEntry" }, { "description": "The last positive Entry processed included in the disbursement." } ] }, "lastPositivePendingEntry": { "allOf": [ { "$ref": "#/$defs/disbursementsModelLastPositivePendingEntry" }, { "description": "The last positive PendingEntry processed included in the disbursement." } ] }, "lastNegativeReserveEntry": { "allOf": [ { "$ref": "#/$defs/disbursementsModelLastNegativeReserveEntry" }, { "description": "The last negative ReserveEntry processed included in the disbursement." } ] }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency of this Disbursement. See Currency codes for all valid values." } ] }, "expiration": { "type": "string", "description": "The expiration date of the related debit account." }, "sameDay": { "allOf": [ { "$ref": "#/$defs/disbursementsSameDay" }, { "description": "Whether sameDay funding is enabled or disabled for this disbursement. \n\n
\nValid Values\n\n- `0` - **Disabled.**\n\n- `1` - **Enabled.**\n\n
" } ] }, "adjustments": { "type": "array", "items": { "$ref": "#/$defs/adjustmentsResponse" }, "description": "" }, "disbursementEntries": { "type": "array", "items": { "$ref": "#/$defs/disbursementEntriesResponse" }, "description": "" }, "disbursementResults": { "type": "array", "items": { "$ref": "#/$defs/disbursementResultsResponse" }, "description": "" }, "entityReturns": { "type": "array", "items": { "$ref": "#/$defs/entityReturnsResponse" }, "description": "" }, "entries": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" }, "entryOrigins": { "type": "array", "items": { "$ref": "#/$defs/entryOriginsResponse" }, "description": "" }, "funding": { "type": "array", "items": { "$ref": "#/$defs/entityRefsResponse" }, "description": "" }, "pendingEntries": { "type": "array", "items": { "$ref": "#/$defs/pendingEntriesResponse" }, "description": "" } } }, "disbursementsSameDay": { "title": "disbursementsSameDay", "enum": [ 0, 1 ], "type": "integer" }, "divisionsCanUsePlaidWrapperMicroservice": { "title": "divisionsCanUsePlaidWrapperMicroservice", "enum": [ 0, 1 ], "type": "integer" }, "divisionsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The login ID of the user that owns this division record." }, "divisionsResponse": { "title": "divisionsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/divisionsModelLogin" }, { "description": "The login ID of the user that owns this division record." } ] }, "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", "description": "Minimum password 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
" } ] }, "canUsePlaidWrapperMicroservice": { "allOf": [ { "$ref": "#/$defs/divisionsCanUsePlaidWrapperMicroservice" }, { "description": "Describes if the user can use the Plaid Wrapper Microservice or not\n
\nValid Values\n\n - `0` - **No.**\n - `1` - **Yes.**\n
" } ] }, "simplifiedDepositEnabled": { "allOf": [ { "$ref": "#/$defs/simplifiedDepositEnabled" }, { "description": "Allows automatic enablement of simplified deposits for new boardings and allows enablement of existing boardings. Restricted to admin.\nValid Values : - `1` - **Enabled**" } ] }, "aggregations": { "type": "array", "items": { "$ref": "#/$defs/aggregationsResponse" }, "description": "" }, "billingModifiers": { "type": "array", "items": { "$ref": "#/$defs/billingModifiersResponse" }, "description": "" }, "billings": { "type": "array", "items": { "$ref": "#/$defs/billingsResponse" }, "description": "" }, "configurations": { "type": "array", "items": { "$ref": "#/$defs/configurationsResponse" }, "description": "" }, "currencyRates": { "type": "array", "items": { "$ref": "#/$defs/currencyRatesResponse" }, "description": "" }, "decisions": { "type": "array", "items": { "$ref": "#/$defs/decisionsResponse" }, "description": "" }, "embeddedFinance": { "type": "array", "items": { "$ref": "#/$defs/embeddedFinanceResponse" }, "description": "" }, "entityRoutes": { "type": "array", "items": { "$ref": "#/$defs/entityRoutesResponse" }, "description": "" }, "feeModifiers": { "type": "array", "items": { "$ref": "#/$defs/feeModifiersResponse" }, "description": "" }, "fundingParameters": { "type": "array", "items": { "$ref": "#/$defs/fundingParametersResponse" }, "description": "" }, "hosts": { "type": "array", "items": { "$ref": "#/$defs/hostsResponse" }, "description": "" }, "invoiceParameters": { "type": "array", "items": { "$ref": "#/$defs/invoiceParametersResponse" }, "description": "" }, "logins": { "type": "array", "items": { "$ref": "#/$defs/loginsResponse" }, "description": "" }, "mccs": { "type": "array", "items": { "$ref": "#/$defs/mccsResponse" }, "description": "" }, "orgFlows": { "type": "array", "items": { "$ref": "#/$defs/orgFlowsResponse" }, "description": "" }, "omniTokens": { "type": "array", "items": { "$ref": "#/$defs/omniTokensResponse" }, "description": "" }, "parameters": { "type": "array", "items": { "$ref": "#/$defs/parametersResponse" }, "description": "" }, "payoutFlows": { "type": "array", "items": { "$ref": "#/$defs/payoutFlowsResponse" }, "description": "" }, "pinlessDebitConversions": { "type": "array", "items": { "$ref": "#/$defs/pinlessDebitConversionsResponse" }, "description": "" }, "profitShares": { "type": "array", "items": { "$ref": "#/$defs/profitSharesResponse" }, "description": "" }, "reserves": { "type": "array", "items": { "$ref": "#/$defs/reservesResponse" }, "description": "" }, "revenueBoosts": { "type": "array", "items": { "$ref": "#/$defs/revenueBoostsResponse" }, "description": "" }, "saferPayments": { "type": "array", "items": { "$ref": "#/$defs/saferPaymentsResponse" }, "description": "" }, "secrets": { "type": "array", "items": { "$ref": "#/$defs/secretsResponse" }, "description": "" }, "vendors": { "type": "array", "items": { "$ref": "#/$defs/vendorsResponse" }, "description": "" } } }, "embeddedFinanceModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this embeddedFinance is associated to." }, "embeddedFinanceProduct": { "title": "embeddedFinanceProduct", "const": "merchantWorkingCapital", "type": "string" }, "embeddedFinanceResponse": { "title": "embeddedFinanceResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "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": { "allOf": [ { "$ref": "#/$defs/embeddedFinanceModelEntity" }, { "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
" } ] } } }, "embededFinancePlatform": { "title": "embededFinancePlatform", "enum": [ "PARAFIN", "ATELIO" ], "type": "string" }, "entitiesEinType": { "title": "entitiesEinType", "enum": [ "ssn", "tin", "other" ], "type": "string" }, "entitiesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The ID of the Login that owns this resource." }, "entitiesPublic": { "title": "entitiesPublic", "enum": [ 0, 1 ], "type": "integer" }, "entitiesReserved": { "title": "entitiesReserved", "enum": [ 0, 1, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer" }, "entitiesResponse": { "title": "entitiesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "ipCreated": { "type": "string", "description": "The incoming IP address from which this Entity was created." }, "ipModified": { "type": "string", "description": "The incoming IP address from which this Entity was last modified." }, "clientIp": { "type": "string", "description": "The client IP address from which the Entity was created. \nValid values are any IPv4 or IPv6 address." }, "login": { "allOf": [ { "$ref": "#/$defs/entitiesModelLogin" }, { "description": "The ID of the Login that owns this resource." } ] }, "parameter": { "type": "string", "description": "The parameter associated with this Entity." }, "totalCreditDisbursements": { "type": "integer", "description": "The sum of all negative disbursements, in cents, associated to this Entity.", "contentEncoding": "int32" }, "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 text 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 text 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 text 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 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 Entity. \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
" }, "website": { "type": "string", "description": "The website URL associated with this Entity. \nThis field is stored as a text string and must be between 0 and 500 characters long." }, "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." }, "ein": { "type": "string", "description": "The IRS Employer Identification Number (EIN) for the Entity. \nThis field is stored as an integer and must be 9 characters long." }, "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
" } ] }, "globalBusinessId": { "type": "string", "description": "The business registration number for the entity. \nThis field is stored as an alphanumeric and must be between 9 to 10 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
" } ] }, "irsFilingName": { "type": "string", "description": "The IRS Legal Filing Name. This must match what has been provided to the IRS when filing taxes." }, "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" }, "tcVersion": { "type": "string", "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." }, "tcDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "Date the `tcVersion` was last updated. The format should be YYYY-MM-DD HH:MM:SS." }, "tcIp": { "type": "string", "description": "IP address of client from last `tcVersion` update." }, "tcAcceptDate": { "type": "string", "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", "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." }, "tinStatus": { "allOf": [ { "$ref": "#/$defs/entitiesTinStatus" }, { "description": "The Tax Identification Number (TIN) status of the entity.\n\n
\nValid Values\n\n- `0` - **Pending**\n- `1` - **Valid**\n- `2` - **Invalid**\n- `3` - **Not required**\n\n
" } ] }, "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
" } ] }, "reserved": { "allOf": [ { "$ref": "#/$defs/entitiesReserved" }, { "description": "Indicates the reserve status of the entity.\n\n
\nValid Values\n\n- `0` - **No reserve.**\n- `1` - **Block transaction, will never be processed. The Entity is sent to the manual review queue..**\n- `3` - **Hold transaction, will not be captured.**\n- `4` - **Reserve transaction, funds should be reserved.**\n- `5` - **Block current activity, no change for merchant.**\n- `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**\n- `7` - **We did not have policies to process.**\n- `8` - **We onboard the merchant and wait for manual check later.**\n- `9` - **Schedule the automatic release of the reserve.**\n- `10` - **Hold transaction, will not be captured. Automatic release when the associated sale is done.**\n\n
" } ] }, "pendingRiskCheck": { "allOf": [ { "$ref": "#/$defs/entityPendingRiskCheck" }, { "description": "Whether it is pending a risk check.\n\n
\nValid Values\n\n- `pending` - **Pending**\n- `successful` - **Successful**\n- `failed` - **Failed**\n- `manual` - **Manual**\n\n
" } ] }, "checkStage": { "allOf": [ { "$ref": "#/$defs/entityCheckStage" }, { "description": "The last stage completed for risk underwriting review.\n\n
\nValid Values\n\n- `createEntity` - **Merchant created.** No Signup Form submitted.\n- `underwriting` - **Risk/Underwriting Review.** Merchant Signup Form submitted.\n- `preboard` - **Preboard.** Check the Merchant before they are boarded.\n- `postboard` - **Check the Merchant after they are boarded.**\n- `txn` - **Check the Merchant when they process a Transaction.**\n- `txnVolume` - **Check the Merchant when their transaction volume hits a certain amount.**\n- `payout` - **Check the Merchant when a Payout occurs.**\n- `payoutVolume` - **Check the Merchant when the volume of Payouts to the Merchant hits a certain amount.**\n\n
" } ] }, "industry": { "type": "string", "description": "This field is stored as a text string and 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." }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency of this Entity. 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
" } ] }, "accounts": { "type": "array", "items": { "$ref": "#/$defs/accountsResponse" }, "description": "" }, "adjustments": { "type": "array", "items": { "$ref": "#/$defs/adjustmentsResponse" }, "description": "" }, "adjustmentsFromentity": { "type": "array", "items": { "$ref": "#/$defs/adjustmentsResponse" }, "description": "" }, "adjustmentsOnentity": { "type": "array", "items": { "$ref": "#/$defs/adjustmentsResponse" }, "description": "" }, "aggregations": { "type": "array", "items": { "$ref": "#/$defs/aggregationsResponse" }, "description": "" }, "ownedAppleDomains": { "type": "array", "items": { "$ref": "#/$defs/appleDomainsResponse" }, "description": "" }, "assessmentsOnentity": { "type": "array", "items": { "$ref": "#/$defs/assessmentsResponse" }, "description": "" }, "billingModifiers": { "type": "array", "items": { "$ref": "#/$defs/billingModifiersResponse" }, "description": "" }, "billings": { "type": "array", "items": { "$ref": "#/$defs/billingsResponse" }, "description": "" }, "billingsForentity": { "type": "array", "items": { "$ref": "#/$defs/billingsResponse" }, "description": "" }, "changeRequests": { "type": "array", "items": { "$ref": "#/$defs/changeRequest" }, "description": "" }, "contacts": { "type": "array", "items": { "$ref": "#/$defs/contactsResponse" }, "description": "" }, "credentials": { "type": "array", "items": { "$ref": "#/$defs/credentialsResponse" }, "description": "" }, "disbursements": { "type": "array", "items": { "$ref": "#/$defs/disbursementsResponse" }, "description": "" }, "decisions": { "type": "array", "items": { "$ref": "#/$defs/decisionsResponse" }, "description": "" }, "embeddedFinance": { "type": "array", "items": { "$ref": "#/$defs/embeddedFinanceResponse" }, "description": "" }, "entityCustomFields": { "type": "array", "items": { "$ref": "#/$defs/entityCustomFieldsResponse" }, "description": "" }, "entityData": { "type": "array", "items": { "$ref": "#/$defs/entityDataResponse" }, "description": "" }, "entityDebts": { "type": "array", "items": { "$ref": "#/$defs/entityDebtsResponse" }, "description": "" }, "entityDebtsToentity": { "type": "array", "items": { "$ref": "#/$defs/entityDebtsResponse" }, "description": "" }, "entityRefs": { "type": "array", "items": { "$ref": "#/$defs/entityRefsResponse" }, "description": "" }, "entityReturns": { "type": "array", "items": { "$ref": "#/$defs/entityReturnsResponse" }, "description": "" }, "entityTerms": { "type": "array", "items": { "$ref": "#/$defs/entityTermsResponse" }, "description": "" }, "entriesOnentity": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" }, "fees": { "type": "array", "items": { "$ref": "#/$defs/feesResponse" }, "description": "" }, "forentityFees": { "type": "array", "items": { "$ref": "#/$defs/feesResponse" }, "description": "" }, "forentityProfitShares": { "type": "array", "items": { "$ref": "#/$defs/profitSharesResponse" }, "description": "" }, "funds": { "type": "array", "items": { "$ref": "#/$defs/fundsResponse" }, "description": "" }, "holds": { "type": "array", "items": { "$ref": "#/$defs/holdsResponse" }, "description": "" }, "invoiceParameters": { "type": "array", "items": { "$ref": "#/$defs/invoiceParametersResponse" }, "description": "" }, "notes": { "type": "array", "items": { "$ref": "#/$defs/notesResponse" }, "description": "" }, "orgEntities": { "type": "array", "items": { "$ref": "#/$defs/orgEntitiesResponse" }, "description": "" }, "omniTokens": { "type": "array", "items": { "$ref": "#/$defs/omniTokensResponse" }, "description": "" }, "paymentUpdateGroups": { "type": "array", "items": { "$ref": "#/$defs/paymentUpdateGroupsResponse" }, "description": "" }, "payoutFlows": { "type": "array", "items": { "$ref": "#/$defs/payoutFlowsResponse" }, "description": "" }, "payouts": { "type": "array", "items": { "$ref": "#/$defs/payoutsResponse" }, "description": "" }, "pendingEntriesOnentity": { "type": "array", "items": { "$ref": "#/$defs/pendingEntriesResponse" }, "description": "" }, "pinlessDebitConversions": { "type": "array", "items": { "$ref": "#/$defs/pinlessDebitConversionsResponse" }, "description": "" }, "profitShares": { "type": "array", "items": { "$ref": "#/$defs/profitSharesResponse" }, "description": "" }, "reserveEntriesOnentity": { "type": "array", "items": { "$ref": "#/$defs/reserveEntriesResponse" }, "description": "" }, "reserves": { "type": "array", "items": { "$ref": "#/$defs/reservesResponse" }, "description": "" }, "revenueBoosts": { "type": "array", "items": { "$ref": "#/$defs/revenueBoostsResponse" }, "description": "" }, "revShareSchedulesEntity": { "type": "array", "items": { "$ref": "#/$defs/revShareSchedulesResponse" }, "description": "" }, "revShareSchedulesForentity": { "type": "array", "items": { "$ref": "#/$defs/revShareSchedulesResponse" }, "description": "" }, "revShareStatementsEntity": { "type": "array", "items": { "$ref": "#/$defs/revShareStatmentsResponse" }, "description": "" }, "revShareStatementsForentity": { "type": "array", "items": { "$ref": "#/$defs/revShareStatmentsResponse" }, "description": "" }, "secrets": { "type": "array", "items": { "$ref": "#/$defs/secretsResponse" }, "description": "" }, "statementEntries": { "type": "array", "items": { "$ref": "#/$defs/statementEntriesResponse" }, "description": "" }, "statementEntriesOnentity": { "type": "array", "items": { "$ref": "#/$defs/statementEntriesResponse" }, "description": "" }, "statementEntriesForentity": { "type": "array", "items": { "$ref": "#/$defs/statementEntriesResponse" }, "description": "" }, "subscriptions": { "type": "array", "items": { "$ref": "#/$defs/subscriptionsResponse" }, "description": "" }, "statementsEntity": { "type": "array", "items": { "$ref": "#/$defs/statementsResponse" }, "description": "" }, "statementsForentity": { "type": "array", "items": { "$ref": "#/$defs/statementsResponse" }, "description": "" }, "saferPayments": { "type": "array", "items": { "$ref": "#/$defs/saferPaymentsResponse" }, "description": "" }, "vendor": { "type": "array", "items": { "$ref": "#/$defs/vendorsResponse" }, "description": "" }, "merchant": { "$ref": "#/$defs/merchantsResponse" } } }, "entitiesTimezone": { "title": "entitiesTimezone", "enum": [ "est", "cst", "pst", "mst", "akst", "hst", "sst", "chst", "ast", "pwt", "mht", "chut", "nst" ], "type": "string" }, "entitiesTinStatus": { "title": "entitiesTinStatus", "enum": [ 0, 1, 2, 3 ], "type": "integer" }, "entityCheckStage": { "title": "entityCheckStage", "enum": [ "createEntity", "underwriting", "preboard", "postboard", "txn", "txnVolume", "payout", "payoutVolume" ], "type": "string" }, "entityCountry": { "title": "entityCountry", "enum": [ "USA", "CAN" ], "type": "string" }, "entityCustomFieldsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "Entity for which we are creating custom field." }, "entityCustomFieldsResponse": { "title": "entityCustomFieldsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/entityCustomFieldsModelEntity" }, { "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." }, "deleted": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "Time when custom field is deleted. The format should be YYYY-MM-DD HH:MM:SS." } } }, "entityDataModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The Entity associated with this EntityData." }, "entityDataResponse": { "title": "entityDataResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/entityDataModelEntity" }, { "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." } } }, "entityDebtsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that owes money." }, "entityDebtsModelToentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that will receive the money." }, "entityDebtsResponse": { "title": "entityDebtsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/entityDebtsModelEntity" }, { "description": "The identifier of the Entity that owes money." } ] }, "toentity": { "allOf": [ { "$ref": "#/$defs/entityDebtsModelToentity" }, { "description": "The identifier of the Entity that will receive the money." } ] }, "pendingEntries": { "type": "array", "items": { "$ref": "#/$defs/pendingEntriesResponse" }, "description": "" } } }, "entityDefault": { "title": "entityDefault", "enum": [ 0, 1 ], "type": "integer" }, "entityPendingRiskCheck": { "title": "entityPendingRiskCheck", "enum": [ "pending", "successful", "failed", "manual" ], "type": "string" }, "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" }, "entityRefsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that owns this entityRefs resource." }, "entityRefsModelEntityRoute": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entityRoutesResponse" } ], "description": "The original 'entity_route' that routed the merchant onto the platform which then returned this reference information, if applicable" }, "entityRefsModelMember": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/membersResponse" } ], "description": "The identifier of the Member associated with this entityRefs resource." }, "entityRefsResponse": { "title": "entityRefsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/entityRefsModelEntity" }, { "description": "The identifier of the Entity that owns this entityRefs resource." } ] }, "member": { "allOf": [ { "$ref": "#/$defs/entityRefsModelMember" }, { "description": "The identifier of the Member associated with this entityRefs resource." } ] }, "entityRoute": { "allOf": [ { "$ref": "#/$defs/entityRefsModelEntityRoute" }, { "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." } ] }, "options": { "type": "string", "description": "A string-JSON of options for this reference value." }, "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", "description": "The FBO from which this entity refers 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
" } ] } } }, "entityReservesModelFund": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/fundsResponse" } ], "description": "The identifier of the Fund that this entityReserves resource relates to." }, "entityReservesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "entityReservesResponse": { "title": "entityReservesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/entityReservesModelLogin" }, { "description": "The Login that owns this resource." } ] }, "fund": { "allOf": [ { "$ref": "#/$defs/entityReservesModelFund" }, { "description": "The identifier of the Fund that this entityReserves resource relates to." } ] }, "total": { "type": "integer", "description": "The amount held in this entityReserve. \nThis field is specified as an integer in cents.", "contentEncoding": "int64" }, "requestSequence": { "type": "integer", "description": "The current sequentially numbered activity requested for this entityReserve.", "contentEncoding": "int64" }, "processedSequence": { "type": "integer", "description": "The current sequentially numbered activity processed for this entityReserve.", "contentEncoding": "int64" }, "name": { "type": "string", "description": "The name of this EntityReserve. \nThis field is stored as a text string and must be between 0 and 50 characters long." }, "description": { "type": "string", "description": "A description of this EntityReserve. \nThis field is stored as a text string and must be between 0 and 100 characters long." }, "reserveEntries": { "type": "array", "items": { "$ref": "#/$defs/reserveEntriesResponse" }, "description": "" } } }, "entityReturnCode": { "title": "entityReturnCode", "enum": [ "R01", "R02", "R03", "R04", "R05", "R06", "R07", "R08", "R09", "R10", "R11", "R12", "R13", "R14", "R15", "R16", "R17", "R18", "R19", "R20", "R21", "R22", "R23", "R24", "R25", "R26", "R27", "R28", "R29", "R30", "R31", "R32", "R33", "R34", "R35", "R36", "R37", "R38", "R39", "R40", "R41", "R42", "R43", "R44", "R45", "R46", "R47", "R50", "R51", "R52", "R53", "R61", "R62", "R63", "R64", "R65", "R66", "R67", "R68", "R69", "R70", "R71", "R72", "R73", "R74", "R75", "R76", "R80", "R81", "R82", "R83", "R84", "R94", "R95", "R97", "R98", "R99", "C01", "C02", "C03", "C04", "C05", "C06", "C07", "C08", "C09", "C10", "C11", "C12", "C13", "C61", "C62", "C63", "C64", "C65", "C66", "C67", "C68", "C69", "R900-07", "R900-08", "R900-16", "R900-17", "R900-D2", "R900-E1", "R900-L2", "R900-L3", "R900-M1", "R901", "R902", "R903", "R904", "R905", "R907", "R908", "R909", "R910", "R911", "R912", "R914", "R915", "R916", "R917", "R918", "R919", "R920", "R921", "R922", "R990" ], "type": "string" }, "entityReturnsActionCode": { "title": "entityReturnsActionCode", "enum": [ "unknown", "nsf", "badAccount", "unauthorized" ], "type": "string" }, "entityReturnsModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "This field indicates that this EntityReturn was triggered from a\\ \\ Disbursement. \\nThis field stores the identifier of the Disbursement." }, "entityReturnsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this EntityReturns refers to." }, "entityReturnsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "entityReturnsModelPayment": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/paymentResponse" } ], "description": "The identifier of the Payment that this EntityReturns refers to." }, "entityReturnsModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "This field indicates that this EntityReturn was triggered from a\\ \\ Transaction. \\nThis field stores the identifier of the Transaction." }, "entityReturnsResponse": { "title": "entityReturnsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/entityReturnsModelLogin" }, { "description": "The Login that owns this resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/entityReturnsModelEntity" }, { "description": "The identifier of the Entity that this EntityReturns refers to." } ] }, "payment": { "allOf": [ { "$ref": "#/$defs/entityReturnsModelPayment" }, { "description": "The identifier of the Payment that this EntityReturns refers to." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/entityReturnsModelTxn" }, { "description": "This field indicates that this EntityReturn was triggered from a\\ \\ Transaction. \\nThis field stores the identifier of the Transaction." } ] }, "disbursement": { "allOf": [ { "$ref": "#/$defs/entityReturnsModelDisbursement" }, { "description": "This field indicates that this EntityReturn was triggered from a\\ \\ Disbursement. \\nThis field stores the identifier of the Disbursement." } ] }, "actionCode": { "allOf": [ { "$ref": "#/$defs/entityReturnsActionCode" }, { "description": "Describes the action code related to the return.\n\n
\nValid Values\n\n- `unknown` - **Unknown reason**\n- `nsf` - **Non-sufficient funds**\n- `badAccount` - **Bad Account Info**\n- `unauthorized` - **Unauthorized Transaction**\n\n
" } ] }, "code": { "allOf": [ { "$ref": "#/$defs/entityReturnCode" }, { "description": "The code that is received from the platform.\n\n
\nValid Values\n\n- `R01` - **R01.** Insufficient funds in account.\n- `R02` - **R02.** Account is closed.\n- `R03` - **R03.** No account on file.\n- `R04` - **R04.** Invalid account number.\n- `R05` - **R05.** Unauthorized debit to consumer account.\n- `R06` - **R06.** Returned at request of ODFI.\n- `R07` - **R07.** Authorization revoked by customer.\n- `R08` - **R08.** Payment stopped.\n- `R09` - **R09.** Insufficient collected funds in account being charged\n- `R10` - **R10.** Customer advises not Authorized, notice not provided, improper source document, or amount of entry not accurately obtained from source document.\n- `R11` - **R11.** Check truncation return.\n- `R12` - **R12.** Account sold to another financial institution.\n- `R13` - **R13.** Invalid ACH routing number.\n- `R14` - **R14.** Representative payee is deceased or cannot continue in that capacity.\n- `R15` - **R15.** Beneficiary or account holder other than representative payee deceased.\n- `R16` - **R16.** Account funds have been frozen.\n- `R17` - **R17.** Item returned because of invalid data; refer to addenda for information.\n- `R18` - **R18.** Improper effective date.\n- `R19` - **R19.** Amount error.\n- `R20` - **R20.** Account does not allow ACH transactions or limit for transactions has been exceeded.\n- `R21` - **R21.** Invalid company identification.\n- `R22` - **R22.** Invalid individual ID.\n- `R23` - **R23.** Credit entry refused by receiver.\n- `R24` - **R24.** Duplicate entry.\n- `R25` - **R25.** Addenda record error.\n- `R26` - **R26.** Mandatory field error.\n- `R27` - **R27.** Trace number error.\n- `R28` - **R28.** Routing/transit number check digit error.\n- `R29` - **R29.** Corporate customer advised not authorized.\n- `R30` - **R30.** RDFI not participant in check truncation program.\n- `R31` - **R31.** Permissible return entry.\n- `R32` - **R32.** RDFI non-settlement.\n- `R33` - **R33.** Return of item.\n- `R34` - **R34.** Limited participation ODFI.\n- `R35` - **R35.** Return of improper debit entry.\n- `R36` - **R36.** Return of improper credit entry.\n- `R37` - **R37.** Source document presented for payment.\n- `R38` - **R38.** Stop payment on source document.\n- `R39` - **R39.** Improper source document.\n- `R40` - **R40.** Return of item by government agency.\n- `R41` - **R41.** Invalid Transaction Code.\n- `R42` - **R42.** Routing/transit number check digit error.\n- `R43` - **R43.** Invalid account number.\n- `R44` - **R44.** Invalid individual ID.\n- `R45` - **R45.** Invalid individual name or company name.\n- `R46` - **R46.** Invalid representative payee indicator code.\n- `R47` - **R47.** Duplicate enrollment.\n- `R50` - **R50.** State law affecting RCK acceptance.\n- `R51` - **R51.** Item is ineligible, notice not provided, signature not genuine, or original item altered for adjustment entry.\n- `R52` - **R52.** Stop payment on item.\n- `R53` - **R53.** Item and ACH entry presented for payment.\n- `R61` - **R61.** Misrouted return - RDFI for original entry has placed incorrect routing/transit number in RDFI identification field.\n- `R62` - **R62.** Incorrect trace number.\n- `R63` - **R63.** Incorrect dollar amount.\n- `R64` - **R64.** Incorrect individual identification.\n- `R65` - **R65.** Incorrect transaction code.\n- `R66` - **R66.** Incorrect company identification.\n- `R67` - **R67.** Duplicate return.\n- `R68` - **R68.** Untimely return - return was not sent within the established timeframe.\n- `R69` - **R69.** Field errors.\n- `R70` - **R70.** Permissible return entry not accepted.\n- `R71` - **R71.** Misrouted dishonored return -incorrect routing/transit number in RDFI identification field.\n- `R72` - **R72.** Untimely return - dishonored return was not sent within the established timeframe.\n- `R73` - **R73.** Timely original return - RDFI certifies the original return entry was sent within established timeframe for original returns.\n- `R74` - **R74.** Corrected return - RDFI is correcting a previous return entry that was dishonored because it contained incomplete or incorrect information.\n- `R75` - **R75.** Original return not a duplicate.\n- `R76` - **R76.** No errors found.\n- `R80` - **R80.** Cross-border payment coding error\n- `R81` - **R81.** Non-participant in cross-border program.\n- `R82` - **R82.** Invalid foreign RDFI identification.\n- `R83` - **R83.** Foreign RDFI unable to settle.\n- `R84` - **R84.** Cross-border entry not processed by originating gateway operator.\n- `R94` - **R94.** Administrative return item was processed and resubmitted as a photocopy.\n- `R95` - **R95.** Administrative return item was processed and resubmitted as a MICR-Split.\n- `R97` - **R97.** Administrative return item was processed and resubmitted with corrected dollar amount.\n- `R98` - **R98.** Indicates a return PAC (pre-authorized check); RDFI provides a text reason and indicated a new account number on the PAC itself.\n- `R99` - **R99.** Indicates a return PAC (pre-authorized check); RDFI provides a text reason on the PAC itself for which there is no equivalent return reason code.\n- `C01` - **C01.** Incorrect DFI Account Number.\n- `C02` - **C02.** Incorrect Transit/Routing Number.\n- `C03` - **C03.** Incorrect Transit/Routing Number and Incorrect DFI Account Number.\n- `C04` - **C04.** Incorrect Individual Name.\n- `C05` - **C05.** Incorrect Transaction Code.\n- `C06` - **C06.** Incorrect DFI Account Number and Incorrect Transaction Code.\n- `C07` - **C07.** Incorrect Transit/Routing Number, Incorrect DFI Account Number, and Incorrect Transaction Code.\n- `C08` - **C08.** Reserved.\n- `C09` - **C09.** Incorrect Individual Identification Number.\n- `C10` - **C10.** Incorrect Company Name.\n- `C11` - **C11.** Incorrect Company Identification.\n- `C12` - **C12.** Incorrect Company Name and Company Identification.\n- `C13` - **C13.** Addenda Format Error.\n- `C61` - **C61.** Misrouted Notification of Change.\n- `C62` - **C62.** Incorrect Trace Number.\n- `C63` - **C63.** Incorrect Company Identification Number.\n- `C64` - **C64.** Incorrect Individual Identification Number.\n- `C65` - **C65.** Incorrectly Formatted Corrected Data.\n- `C66` - **C66.** Incorrect Discretionary Data.\n- `C67` - **C67.** Routing Number Not From Original Entry Detail Record.\n- `C68` - **C68.** DFI Account Number Not From Original Entry Detail Record.\n- `C69` - **C69.** Incorrect Transaction Code.\n- `R900-07` - **R900-07.** Institution ID Invalid.\n- `R900-08` - **R900-08.** Account Number Invalid.\n- `R900-16` - **R900-16.** Institution ID for Return Invalid.\n- `R900-17` - **R900-17.** Account Number for Return Invalid.\n- `R900-D2` - **R900-D2.** Destination Institute is Not Defined on FIF.\n- `R900-E1` - **R900-E1.** Destination Account Number Invalid.\n- `R900-L2` - **R900-L2.** Institution for Return Not Defined on FIF.\n- `R900-L3` - **R900-L3.** Institution for Return Cross Reference Invalid.\n- `R900-M1` - **R900-M1.** Account for Return Invalid.\n- `R901` - **R901.** NFS (Debit Only).\n- `R902` - **R902.** Cannot Trace.\n- `R903` - **R903.** Payment Stopped/Recalled.\n- `R904` - **R904.** Post/Stale Dated.\n- `R905` - **R905.** Account Closed.\n- `R907` - **R907.** No Debit Allowed.\n- `R908` - **R908.** Funds Not Cleared.\n- `R909` - **R909.** Currency/Account Mismatch.\n- `R910` - **R910.** Payor/Payee Deceased.\n- `R911` - **R911.** Account Frozen.\n- `R912` - **R912.** Invalid/Incorrect Account Number.\n- `R914` - **R914.** Incorrect Payor/Payee Name.\n- `R915` - **R915.** PAD No Agreement Existed - Business/Personal.\n- `R916` - **R916.** PAD Not According to Agreement - Personal.\n- `R917` - **R917.** PAD Agreement Revoked - Personal.\n- `R918` - **R918.** PAD No Confirmation/Pre-Notification - Personal.\n- `R919` - **R919.** PAD Not According to Agreement - Business.\n- `R920` - **R920.** PAD Agreement Revoked - Business.\n- `R921` - **R921.** PAD No Confirmation/Pre-Notification - Business.\n- `R922` - **R922.** Customer Initiated Return - CREDIT only.\n- `R990` - **R990.** Institution in Default.\n
" } ] }, "message": { "type": "string", "description": "The message that is received from the platform." }, "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" }, "entityRoutesModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "Division ID in which the entity route is associated." }, "entityRoutesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this entityRoute applies to." }, "entityRoutesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this EntityRoute." }, "entityRoutesModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org that this entityRoute applies to." }, "entityRoutesModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "ID of the partition in which this entity operates." }, "entityRoutesResponse": { "title": "entityRoutesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/entityRoutesModelLogin" }, { "description": "The Login that owns this EntityRoute." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/entityRoutesModelDivision" }, { "description": "Division ID in which the entity route is associated." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/entityRoutesModelEntity" }, { "description": "The identifier of the Entity that this entityRoute applies to." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/entityRoutesModelOrg" }, { "description": "The identifier of the Org that this entityRoute applies to." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/entityRoutesModelPartition" }, { "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
" } ] }, "entityRefs": { "type": "array", "items": { "$ref": "#/$defs/entityRefsResponse" }, "description": "" } } }, "entityTermsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the entity that the terms are associated with." }, "entityTermsResponse": { "title": "entityTermsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/entityTermsModelEntity" }, { "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" }, "entriesIsEFE": { "title": "entriesIsEFE", "enum": [ 0, 1 ], "type": "integer" }, "entriesIsFee": { "title": "entriesIsFee", "enum": [ 0, 1 ], "type": "integer" }, "entriesModelAdjustment": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/adjustmentsResponse" } ], "description": "The adjustment ID from which the funding activity was triggered." }, "entriesModelChargeback": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebacksResponse" } ], "description": "If the activity that this Entry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource." }, "entriesModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "If the activity that this Entry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement resource." }, "entriesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that owns this Entry." }, "entriesModelEventId": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the record that is associated with this Entry." }, "entriesModelFee": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/feesResponse" } ], "description": "If the activity that this Entry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource." }, "entriesModelFromentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "If the activity that this Entry refers to involves two parties in the system with one paying a charge of any kind, then this field stores the identifier of the Entity that the charge or other activity is for." }, "entriesModelFund": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/fundsResponse" } ], "description": "The identifier of the Fund that this Entry refers to." }, "entriesModelOnentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this Entry refers to. This is the owner of the record that triggered the charge." }, "entriesModelOpposingEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The identifier of the Entry that this Entry was created based on." }, "entriesModelPendingEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/pendingEntriesResponse" } ], "description": "The ID of the pending entry that is associated with this entry." }, "entriesModelProfitShare": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/profitSharesResponse" } ], "description": "If the activity that this Entry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource." }, "entriesModelRefund": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/refundsResponse" } ], "description": "If the activity that this Entry refers to is the paying of a Refund, then this field stores the identifier of the corresponding Refund resource." }, "entriesModelRevShareStatement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/revShareStatmentsResponse" } ], "description": "If the activity that this Entry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource." }, "entriesModelSettlement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/settlementsResponse" } ], "description": "If the activity that this Entry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource." }, "entriesModelStatement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/statementsResponse" } ], "description": "If the activity that this Entry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource." }, "entriesModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "If the activity that this Entry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource." }, "entriesResponse": { "title": "entriesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/entriesModelEntity" }, { "description": "The identifier of the Entity that owns this Entry." } ] }, "onentity": { "allOf": [ { "$ref": "#/$defs/entriesModelOnentity" }, { "description": "The identifier of the Entity that this Entry refers to. This is the owner of the record that triggered the charge." } ] }, "fromentity": { "allOf": [ { "$ref": "#/$defs/entriesModelFromentity" }, { "description": "If the activity that this Entry refers to involves two parties in the system with one paying a charge of any kind, then this field stores the identifier of the Entity that the charge or other activity is for." } ] }, "opposingEntry": { "allOf": [ { "$ref": "#/$defs/entriesModelOpposingEntry" }, { "description": "The identifier of the Entry that this Entry was created based on." } ] }, "fund": { "allOf": [ { "$ref": "#/$defs/entriesModelFund" }, { "description": "The identifier of the Fund that this Entry refers to." } ] }, "fee": { "allOf": [ { "$ref": "#/$defs/entriesModelFee" }, { "description": "If the activity that this Entry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource." } ] }, "disbursement": { "allOf": [ { "$ref": "#/$defs/entriesModelDisbursement" }, { "description": "If the activity that this Entry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement resource." } ] }, "refund": { "allOf": [ { "$ref": "#/$defs/entriesModelRefund" }, { "description": "If the activity that this Entry refers to is the paying of a Refund, then this field stores the identifier of the corresponding Refund resource." } ] }, "settlement": { "allOf": [ { "$ref": "#/$defs/entriesModelSettlement" }, { "description": "If the activity that this Entry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/entriesModelTxn" }, { "description": "If the activity that this Entry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource." } ] }, "chargeback": { "allOf": [ { "$ref": "#/$defs/entriesModelChargeback" }, { "description": "If the activity that this Entry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource." } ] }, "adjustment": { "allOf": [ { "$ref": "#/$defs/entriesModelAdjustment" }, { "description": "The adjustment ID from which the funding activity was triggered." } ] }, "profitShare": { "allOf": [ { "$ref": "#/$defs/entriesModelProfitShare" }, { "description": "If the activity that this Entry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource." } ] }, "statement": { "allOf": [ { "$ref": "#/$defs/entriesModelStatement" }, { "description": "If the activity that this Entry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource." } ] }, "event": { "allOf": [ { "$ref": "#/$defs/entryEvent" }, { "description": "The type of event that triggered this Entry resource.\n
\nValid Values\n- `1` - **DAYS**. The Entry is triggered by a daily event.\n- `2` - **WEEKS**. The Entry is triggered by a weekly event.\n- `3` - **MONTHS**. The Entry is triggered by a monthly event.\n- `4` - **YEARS**. The Entry is triggered by an annual event.\n- `5` - **SINGLE**. The Entry is triggered by a one-off event.\n- `6` - **AUTH**. The Entry is triggered when a transaction has been authorized.\n- `7` - **CAPTURE**. The Entry is triggered when a transaction has been captured.\n- `8` - **REFUND**. The Entry is triggered when a refund transaction is processed.\n- `9` - **BOARD**. The Entry is triggered when a Merchant is boarded.\n- `10` - **PAYOUT**. The Entry is triggered when a payout is processed.\n- `11` - **CHARGEBACK**. The Entry is triggered when a card chargeback occurs.\n- `12` - **OVERDRAFT**. The Entry is triggered when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE**. The Entry is triggered when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR**. The Entry is triggered when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL**. The Entry is triggered when an automated clearing house failure occurs.\n- `16` - **ACCOUNT**. The Entry is triggered when a bank account is verified.\n- `17` - **SIFT**. The Entry is triggered by a transaction's fraud Score.\n- `18` - **ADJUSTMENT**. The Entry is triggered when there's an adjustment.\n- `19` - **RETRIEVAL**. The Entry is triggered by a retrieval request chargeback.\n- `20` - **ARBITRATION**. The Entry is triggered by an arbitration chargeback.\n- `21` - **ECSALE**. The Entry is triggered by an eCheck sale transaction.\n- `22` - **ECREFUND**. The Entry is triggered by an eCheck refund.\n- `23` - **ECRETURN**. The Entry is triggered by an eCheck return.\n- `24` - **SETTLEMENT**. The Entry triggers when a transaction has been settled.\n- `25` - **MISUSE**. The Entry is triggered when there's been a Misuse of authorization.\n- `26` - **PROFIT_SHARE**. The Entry is triggered by a profit sharing entry event.\n- `27` - **UNAUTH**. The Entry is triggered when a transaction is unauthorized.\n- `28` - **ACHNOC**. The Entry is triggered by a disbursement NOC (Notification of change).\n- `29` - **ECNOC**. The Entry is triggered by an echeck transaction NOC (Notification of change).\n- `30` - **ECFAIL**. The Entry is triggered by an echeck transaction failed.\n- `31` - **ECNSF**. The Entry is triggered by an eCheck transaction NSF (Non-sufficient funds) return.\n- `32` - **CURRENCY_CONVERSION**. This Entry is triggered by a currency conversion.\n- `33` - **TERMINAL_TXN**. This Entry is triggered by a terminal transaction.\n- `34` - **REVERSE_PAYOUT**. This Entry is triggered by a payout that has been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT**. This Entry is triggered by a payout that has been partially reversed.\n- `43` - **PAYMENT_CHECK**. This Entry is triggered by a payment check for Account Updater.\n- `44` - **PAYMENT_UPDATE**. This Entry is triggered by a payment update for Account Updater.\n- `45` - **PAYMENT_GROUP_CHECK**. This Entry is triggered by a payment group check for Account Updater.\n- `46` - **PAYMENT_GROUP_UPDATE**. This Entry is triggered by a payment group update for Account Updater.\n- `47` - **ENTRY_REFUND**. This Entry is triggered by an entry refund.\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through a risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees\n
" } ] }, "eventId": { "allOf": [ { "$ref": "#/$defs/entriesModelEventId" }, { "description": "The identifier of the record that is associated with this Entry." } ] }, "revShareStatement": { "allOf": [ { "$ref": "#/$defs/entriesModelRevShareStatement" }, { "description": "If the activity that this Entry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource." } ] }, "originalEventId": { "type": "string", "description": "ID of the original event." }, "originalEvent": { "allOf": [ { "$ref": "#/$defs/originalEntryEvent" }, { "description": "The event that originally triggered the entry.\n
\nValid Values\n- `1` - **DAYS**. The Entry is triggered by a daily event.\n- `2` - **WEEKS**. The Entry is triggered by a weekly event.\n- `3` - **MONTHS**. The Entry is triggered by a monthly event.\n- `4` - **YEARS**. The Entry is triggered by an annual event.\n- `5` - **SINGLE**. The Entry is triggered by a one-off event.\n- `6` - **AUTH**. The Entry is triggered when a transaction has been authorized.\n- `7` - **CAPTURE**. The Entry is triggered when a transaction has been captured.\n- `8` - **REFUND**. The Entry is triggered when a refund transaction is processed.\n- `9` - **BOARD**. The Entry is triggered when a Merchant is boarded.\n- `10` - **PAYOUT**. The Entry is triggered when a payout is processed.\n- `11` - **CHARGEBACK**. The Entry is triggered when a card chargeback occurs.\n- `12` - **OVERDRAFT**. The Entry is triggered when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE**. The Entry is triggered when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR**. The Entry is triggered when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL**. The Entry is triggered when an automated clearing house failure occurs.\n- `16` - **ACCOUNT**. The Entry is triggered when a bank account is verified.\n- `17` - **SIFT**. The Entry is triggered by a transaction's fraud Score.\n- `18` - **ADJUSTMENT**. The Entry is triggered when there's an adjustment.\n- `19` - **RETRIEVAL**. The Entry is triggered by a retrieval request chargeback.\n- `20` - **ARBITRATION**. The Entry is triggered by an arbitration chargeback.\n- `21` - **ECSALE**. The Entry is triggered by an eCheck sale transaction.\n- `22` - **ECREFUND**. The Entry is triggered by an eCheck refund.\n- `23` - **ECRETURN**. The Entry is triggered by an eCheck return.\n- `24` - **SETTLEMENT**. The Entry triggers when a transaction has been settled.\n- `25` - **MISUSE**. The Entry is triggered when there's been a Misuse of authorization.\n- `26` - **PROFIT_SHARE**. The Entry is triggered by a profit sharing entry event.\n- `27` - **UNAUTH**. The Entry is triggered when a transaction is unauthorized.\n- `28` - **ACHNOC**. The Entry is triggered by a disbursement NOC (Notification of change).\n- `29` - **ECNOC**. The Entry is triggered by an echeck transaction NOC (Notification of change).\n- `30` - **ECFAIL**. The Entry is triggered by an echeck transaction failed.\n- `31` - **ECNSF**. The Entry is triggered by an eCheck transaction NSF (Non-sufficient funds) return.\n- `32` - **CURRENCY_CONVERSION**. This Entry is triggered by a currency conversion.\n- `33` - **TERMINAL_TXN**. This Entry is triggered by a terminal transaction.\n- `34` - **REVERSE_PAYOUT**. This Entry is triggered by a payout that has been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT**. This Entry is triggered by a payout that has been partially reversed.\n- `43` - **PAYMENT_CHECK**. This Entry is triggered by a payment check for Account Updater.\n- `44` - **PAYMENT_UPDATE**. This Entry is triggered by a payment update for Account Updater.\n- `45` - **PAYMENT_GROUP_CHECK**. This Entry is triggered by a payment group check for Account Updater.\n- `46` - **PAYMENT_GROUP_UPDATE**. This Entry is triggered by a payment group update for Account Updater.\n- `47` - **ENTRY_REFUND**. This Entry is triggered by an entry refund.\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through a risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees\n
" } ] }, "description": { "type": "string", "description": "A description of this Entry." }, "originalCurrency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "Original Currency describes the currency, set automatically based on the settled total. The default is 'USD'. See Currency codes for all valid values." } ] }, "currencyRate": { "type": "number", "description": "currency conversion rate(up to three decimal points)." }, "amount": { "type": "number", "description": "The amount involved in this Entry. It refers to the amount charged, transferred, or disbursed. This field is specified in cents(up to three decimal points)." }, "pending": { "type": "integer", "description": "Integer boolean that determines whether or not this entry is pending.", "contentEncoding": "int32" }, "isFee": { "allOf": [ { "$ref": "#/$defs/entriesIsFee" }, { "description": "An integer-boolean indicating whether or not the funding activity was triggered by a fee assessment.
Valid Values\n- `0` - **Off.** - `1` - **On.**\n
" } ] }, "archiveSummary": { "type": "integer", "description": "Summary record for archived entries.", "contentEncoding": "int32" }, "pendingEntry": { "allOf": [ { "$ref": "#/$defs/entriesModelPendingEntry" }, { "description": "The ID of the pending entry that is associated with this entry." } ] }, "pendingEntryCreated": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "The date and time (up to the second) when the initially associated pendingEntry was created. The format should be YYYY-MM-DD HH:MM:SS" }, "isEFE": { "allOf": [ { "$ref": "#/$defs/entriesIsEFE" }, { "description": "An integer-boolean indicating whether or not the funding activity was triggered by a fee assessment.\n\n
\nValid Values\n\n- `0` - **Off**\n- `1` - **On**\n\n
" } ] }, "cancellation": { "type": "array", "items": { "$ref": "#/$defs/entryOriginsResponse" }, "description": "" }, "disbursementEntries": { "type": "array", "items": { "$ref": "#/$defs/disbursementEntriesResponse" }, "description": "" }, "entryOrigins": { "type": "array", "items": { "$ref": "#/$defs/entryOriginsResponse" }, "description": "" }, "lastNegativeOfDisbursement": { "$ref": "#/$defs/disbursementsResponse" }, "lastPositiveOfDisbursement": { "$ref": "#/$defs/disbursementsResponse" }, "opposingEntries": { "$ref": "#/$defs/entriesResponse" }, "profitShareResults": { "type": "array", "items": { "$ref": "#/$defs/profitShareResultsResponse" }, "description": "" }, "refunds": { "type": "array", "items": { "$ref": "#/$defs/refundsResponse" }, "description": "" }, "reserveEntries": { "type": "array", "items": { "$ref": "#/$defs/reserveEntriesResponse" }, "description": "" } } }, "entryEvent": { "title": "entryEvent", "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, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 101, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 601, 602, 603, 604, 605, 606, 607, 608 ], "type": "integer" }, "entryMode": { "title": "entryMode", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 ], "type": "integer" }, "entryOriginPlatform": { "title": "entryOriginPlatform", "enum": [ "APPLE", "ELAVON", "FIRSTDATA", "GOOGLE", "VANTIV", "VCORE", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY", "TDBANKCA" ], "type": "string" }, "entryOriginsModelCancellation": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The identifier of the Cancellation that this entry origin relates to." }, "entryOriginsModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "The identifier of the Disbursement that this entry origin relates to." }, "entryOriginsModelEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The entry on which the funding source was recorded." }, "entryOriginsModelFunding": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entityRefsResponse" } ], "description": "The processor’s funding ID (related to a merchant, for some processors it is the merchant ID) from which the funds were sourced." }, "entryOriginsResponse": { "title": "entryOriginsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entry": { "allOf": [ { "$ref": "#/$defs/entryOriginsModelEntry" }, { "description": "The entry on which the funding source was recorded." } ] }, "disbursement": { "allOf": [ { "$ref": "#/$defs/entryOriginsModelDisbursement" }, { "description": "The identifier of the Disbursement that this entry origin relates to." } ] }, "cancellation": { "allOf": [ { "$ref": "#/$defs/entryOriginsModelCancellation" }, { "description": "The identifier of the Cancellation that this entry origin relates to." } ] }, "amount": { "type": "number", "description": "The amount for this funding activity in cents (up to three decimal points for sub-cents)." }, "funding": { "allOf": [ { "$ref": "#/$defs/entryOriginsModelFunding" }, { "description": "The processor’s funding ID (related to a merchant, for some processors it is the merchant ID) from which the funds were sourced." } ] }, "platform": { "allOf": [ { "$ref": "#/$defs/entryOriginPlatform" }, { "description": "The processor through which the funds are available.\n\n
\nValid Values\n\n- `ELAVON` - **The Elavon processor.**\n- `VANTIV` - **The WorldPay (aka Vantiv or Litle) eComm (aka VAP) processor.**\n- `VCORE` - **The WorldPay (aka Vantiv) Core processor.**\n- `TDBANK` - **External funding with TD Bank via the Operating Account.**\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
" } ] }, "fbo": { "type": "string", "description": "FBO in which each entry origin belongs to." } } }, "errorItem": { "title": "errorItem", "type": "object", "properties": { "code": { "type": "integer", "description": "The error code associated with a particular error.", "contentEncoding": "int32" }, "severity": { "type": "integer", "description": "The severity level of a particular error. \nPossible values are '0' (informational), '1' (warning), '2' (error) and '4' (failure).", "contentEncoding": "int32" }, "msg": { "type": "string", "description": "The message associated with a particular error." }, "field": { "type": "string", "description": "Field name associated with error." }, "errorCode": { "type": "string", "description": "An identifying string code for this error." } } }, "facilitatorsResponse": { "title": "facilitatorsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "type": "string", "description": "The identifier of the Entity that this Facilitators resource belongs to." }, "prefix": { "type": "string", "description": "The billing descriptor prefix for this Facilitator. \nThis string appears at the start of the description for transactions on credit card statements when any sub-Merchant of this Facilitator charges a card." }, "partition": { "type": "string", "description": "The identifier of the Partition that this Facilitator is associated with. \nYou can only associate one Facilitator to each Partition." }, "gatewayName": { "type": "string", "description": "The name of the credit card processor. \nOptional field used by transaction fraud checking." }, "tcMerchant": { "type": "string", "description": "Latest merchant terms and conditions version for this facilitator." }, "tcVendor": { "type": "string", "description": "Latest vendor terms and conditions version for this facilitator." }, "chargebackNotificationEmail": { "type": "string", "description": "Email for the facilitator to recieve a notification of a chargeback" }, "riskContactEmails": { "type": "string", "description": "List of risk contact emails. \\nThese emails are used for risk management communications." }, "onboardingContactEmails": { "type": "string", "description": "List of onboarding contact emails. \\nThese emails are used for initial contact and setup processes." }, "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
" } ] } } }, "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" }, "feeModifiersModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "Division ID in which the fee modifiers is associated." }, "feeModifiersModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this Fee Modifier applies for." }, "feeModifiersModelFee": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/feesResponse" } ], "description": "The identifier of the Fee that this Fee Modifier applies." }, "feeModifiersModelFromentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "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." }, "feeModifiersModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "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." }, "feeModifiersModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "ID of the partition related to this fee modifiers." }, "feeModifiersResponse": { "title": "feeModifiersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "fee": { "allOf": [ { "$ref": "#/$defs/feeModifiersModelFee" }, { "description": "The identifier of the Fee that this Fee Modifier applies." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/feeModifiersModelEntity" }, { "description": "The identifier of the Entity that this Fee Modifier applies for." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/feeModifiersModelOrg" }, { "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." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/feeModifiersModelDivision" }, { "description": "Division ID in which the fee modifiers is associated." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/feeModifiersModelPartition" }, { "description": "ID of the partition related to this fee modifiers." } ] }, "fromentity": { "allOf": [ { "$ref": "#/$defs/feeModifiersModelFromentity" }, { "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", "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" }, "feeRulesModelFee": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/feesResponse" } ], "description": "The identifier of the Fee that this Fee Rule applies." }, "feeRulesResponse": { "title": "feeRulesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "fee": { "allOf": [ { "$ref": "#/$defs/feeRulesModelFee" }, { "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" }, "feesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that will charge this Fee." }, "feesModelForentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this Fee applies for." }, "feesModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "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." }, "feesResponse": { "title": "feesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/feesModelEntity" }, { "description": "The identifier of the Entity that will charge this Fee." } ] }, "forentity": { "allOf": [ { "$ref": "#/$defs/feesModelForentity" }, { "description": "The identifier of the Entity that this Fee applies for." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/feesModelOrg" }, { "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." } ] }, "partition": { "type": "string", "description": "The identifier of the Partition 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 the whole Partition 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" }, "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", "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 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 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
" } ] }, "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
" } ] }, "feeModifiers": { "type": "array", "items": { "$ref": "#/$defs/feeModifiersResponse" }, "description": "" }, "feeRules": { "type": "array", "items": { "$ref": "#/$defs/feeRulesResponse" }, "description": "" }, "assessments": { "type": "array", "items": { "$ref": "#/$defs/assessmentsResponse" }, "description": "" }, "billingEvents": { "type": "array", "items": { "$ref": "#/$defs/billingEventsResponse" }, "description": "" }, "entries": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" }, "pendingEntries": { "type": "array", "items": { "$ref": "#/$defs/pendingEntriesResponse" }, "description": "" }, "statementEntries": { "type": "array", "items": { "$ref": "#/$defs/statementEntriesResponse" }, "description": "" } } }, "feesTxnFee": { "title": "feesTxnFee", "enum": [ 0, 1 ], "type": "integer" }, "frozen": { "title": "frozen", "enum": [ 0, 1 ], "type": "integer" }, "fundOriginPlatform": { "title": "fundOriginPlatform", "enum": [ "APPLE", "ELAVON", "FIRSTDATA", "GOOGLE", "VANTIV", "VCORE", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY", "TDBANKCA", "all" ], "type": "string" }, "fundOriginsModelAdjustment": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/adjustmentsResponse" } ], "description": "The identifier of the Adjustment that this fund origin relates to." }, "fundOriginsModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "ID of the disbursement related to this fund." }, "fundOriginsModelFund": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/fundsResponse" } ], "description": "The fund for which the amount is available from this source." }, "fundOriginsModelFunding": { "anyOf": [ { "$ref": "#/$defs/fundOriginPlatform" }, { "$ref": "#/$defs/entityRefsResponse" } ], "description": "The processor's funding ID (related to a merchant, this field is required if the adjustment is not between entities." }, "fundOriginsModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the Transaction that this fund origin relates to." }, "fundOriginsResponse": { "title": "fundOriginsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "fund": { "allOf": [ { "$ref": "#/$defs/fundOriginsModelFund" }, { "description": "The fund for which the amount is available from this source." } ] }, "disbursement": { "allOf": [ { "$ref": "#/$defs/fundOriginsModelDisbursement" }, { "description": "ID of the disbursement related to this fund." } ] }, "amount": { "type": "number", "description": "The amount of funds available from this source, in cents(up to three decimal points)." }, "funding": { "allOf": [ { "$ref": "#/$defs/fundOriginsModelFunding" }, { "description": "The processor's funding ID (related to a merchant, this field is required if the adjustment is not between entities." } ] }, "fbo": { "type": "string", "description": "FBO which this fund is drawn from." }, "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
" } ] }, "adjustment": { "allOf": [ { "$ref": "#/$defs/fundOriginsModelAdjustment" }, { "description": "The identifier of the Adjustment that this fund origin relates to." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/fundOriginsModelTxn" }, { "description": "The identifier of the Transaction that this fund origin relates to." } ] } } }, "fundingParameterLocked": { "title": "fundingParameterLocked", "enum": [ 0, 1 ], "type": "integer" }, "fundingParameterPaymentMethods": { "title": "fundingParameterPaymentMethods", "enum": [ "amex", "visa", "masterCard", "diners", "discover", "paypal", "debit", "checking", "savings", "corpChecking", "corpSavings", "gift", "ebt", "wic", "Accel", "ATH", "AFFN", "Culiance", "Interlink", "Jeanie", "Maestro", "NYCE", "Pulse", "Shazam", "Star", "Interac", "Omnitoken" ], "type": "string" }, "fundingParameterPlatform": { "title": "fundingParameterPlatform", "enum": [ "APPLE", "ELAVON", "FIRSTDATA", "GOOGLE", "VANTIV", "VCORE", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY", "TDBANKCA", "all" ], "type": "string" }, "fundingParameterType": { "title": "fundingParameterType", "enum": [ "agentCnp", "agentCp", "creditCompanyId", "debitCompanyId", "delay", "offDaysAdditionalDelay", "settlementAccountTransferDelay", "settlementAccountTransferEnabled", "settlementAccountTransferFloat", "settlementAccountTransferMaximum", "settlementAccountTransferMinimum", "settlementAccountTransferPercent", "customBatchCloseTime", "lateFunding", "5AmFunding" ], "type": "string" }, "fundingParametersModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division associated with this fundingParameter." }, "fundingParametersModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this fundingParameter." }, "fundingParametersModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this fundingParameter resource." }, "fundingParametersModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org associated with this fundingParameter." }, "fundingParametersModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition associated with this fundingParameter." }, "fundingParametersResponse": { "title": "fundingParametersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/fundingParametersModelLogin" }, { "description": "The identifier of the Login that owns this fundingParameter resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/fundingParametersModelEntity" }, { "description": "The identifier of the Entity associated with this fundingParameter." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/fundingParametersModelOrg" }, { "description": "The identifier of the Org associated with this fundingParameter." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/fundingParametersModelDivision" }, { "description": "The identifier of the Division associated with this fundingParameter." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/fundingParametersModelPartition" }, { "description": "The identifier of the Partition associated with this fundingParameter." } ] }, "platform": { "allOf": [ { "$ref": "#/$defs/fundingParameterPlatform" }, { "description": "The identifier of the Platform associated with this fundingParameter.\n\n
\nValid Values\n\n- `APPLE` - **The Apple Payment Processor.**\n- `ELAVON` - **The Elavon processor.**\n- `FIRSTDATA` - **The First Data 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- `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- `TDBANKCA` - **External funding with TD Bank Canada via the Operating Account.**\n- `all` - **All Platform Processor.**\n\n
" } ] }, "type": { "allOf": [ { "$ref": "#/$defs/fundingParameterType" }, { "description": "The type of fundingParameter that we will be configuring.\n\n
\nValid Values\n\n- `agentCnp` - **The id to use for boarding merchants that are card not present**\n- `agentCp` - **The id to use for boarding merchants that are card present**\n- `creditCompanyId` - **Company credit identifier**\n- `debitCompanyId` - **Company debit identifier**\n- `delay` - **Delay**\n- `offDaysAdditionalDelay` - **Additional delay for off days.**\n- `settlementAccountTransferDelay` - **The amount of time in days to wait before issuing a transfer, will be counted from the date of the first item within the total settlement amount.**\n- `settlementAccountTransferEnabled` - **Indication if during settlements credits should be transferred from the merchant's operating account.**\n- `settlementAccountTransferFloat` - **Additional amount to keep at the merchant's operating account.**\n- `settlementAccountTransferMaximum` - **The maximum amount needed to transfer funds from merchant's operating account.**\n- `settlementAccountTransferMinimum` - **The minimum amount needed to transfer funds from the merchant's operating account.**\n- `settlementAccountTransferPercent` - **The percent amount to transfer from the total settlement amount.**\n- `customBatchCloseTime` - **The specified time to close a batch**\n- `lateFunding` - **2 am late funding cutoff time**\n- `5AmFunding` - **5 am funding cutoff time**\n\n
" } ] }, "value": { "type": "string", "description": "The value of this type of fundingParameter." }, "paymentMethods": { "allOf": [ { "$ref": "#/$defs/fundingParameterPaymentMethods" }, { "description": "The payment methods that the fundingParameter should apply to.\n\n
\nValid Values\n\n- `amex` - **American Express**\n- `visa` - **Visa**\n- `masterCard` - **MasterCard**\n- `diners` - **Diners Club**\n- `discover` - **Discover**\n- `paypal` - **PayPal**\n- `debit` - **Debit**\n- `checking` - **Personal checking**\n- `savings` - **Personal savings**\n- `corpChecking` - **Corporate checking**\n- `corpSavings` - **Corporate savings**\n- `gift` - **Gift card**\n- `ebt` - **EBT (Electronic Benefits Transfer)**\n- `wic` - **WIC (Women, Infants and Children)**\n\n
" } ] }, "locked": { "allOf": [ { "$ref": "#/$defs/fundingParameterLocked" }, { "description": "Whether this fundingParameter is locked or not.\nIf it is locked, then the value of this type of fundingParameter will prevail.\n\n
\nValid Values\n\n- `0` - **OFF**\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
" } ] } } }, "fundsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that owns this Fund." }, "fundsResponse": { "title": "fundsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/fundsModelEntity" }, { "description": "The identifier of the Entity that owns this Fund." } ] }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency of the Fund." } ] }, "reserved": { "type": "number", "description": "The amount held in this Fund that is marked as reserved, This field is specified in cents(up to three decimal points). See Currency codes for all valid values." }, "pending": { "type": "number", "description": "The current funds pending for the entity, This field is specified in cents(up to three decimal points)" }, "available": { "type": "number", "description": "The amount held in this Fund that is currently available for disbursement, This field is specified in cents(up to three decimal points)." }, "total": { "type": "number", "description": "The total amount held in this Fund, This field is specified in cents(up to three decimal points)." }, "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
" } ] }, "entityReserves": { "type": "array", "items": { "$ref": "#/$defs/entityReservesResponse" }, "description": "" }, "entries": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" }, "reserveEntries": { "type": "array", "items": { "$ref": "#/$defs/reserveEntriesResponse" }, "description": "" }, "fundOrigins": { "type": "array", "items": { "$ref": "#/$defs/fundOriginsResponse" }, "description": "" } } }, "globalBusinessType": { "title": "globalBusinessType", "enum": [ "ssn", "tin", "other", "CD", "AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT" ], "type": "string" }, "holdAction": { "title": "holdAction", "enum": [ 0, 1, 3, 4, 5, 6, 8 ], "type": "integer" }, "holdsHoldSource": { "title": "holdsHoldSource", "enum": [ "DS_MODEL_POLICY_RUN", "API_DECISION", "POLICY_RUN", "RISK_ALERT", "MANUAL", "ERROR" ], "type": "string" }, "holdsModelAccount": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/accountsResponse" } ], "description": "The identifier of the Account that owns this holds resource." }, "holdsModelAnalyst": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The person who review the hold applied." }, "holdsModelDecisionAction": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/decisionActionsResponse" } ], "description": "The identifier of the DecisionAction associated with this Hold resource." }, "holdsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this Hold resource." }, "holdsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this holds resource." }, "holdsModelTerminalTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/terminalTxnsResponse" } ], "description": "The TerminalTxn id in which this Hold belongs to." }, "holdsModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the Txn that is being held with this hold." }, "holdsModelVerification": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/verificationsResponse" } ], "description": "If this hold resource was triggered through a verification, then this field stores the identifier of the Verification." }, "holdsModelVerificationRef": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/verificationRefsResponse" } ], "description": "If this hold resource was triggered through Payrix Integration Risk, then this field stores the identifier of the VerificationRef." }, "holdsReleaseAction": { "title": "holdsReleaseAction", "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "holdsResponse": { "title": "holdsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/holdsModelLogin" }, { "description": "The identifier of the Login that owns this holds resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/holdsModelEntity" }, { "description": "The identifier of the Entity associated with this Hold resource." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/holdsModelTxn" }, { "description": "The identifier of the Txn that is being held with this hold." } ] }, "terminalTxn": { "allOf": [ { "$ref": "#/$defs/holdsModelTerminalTxn" }, { "description": "The TerminalTxn id in which this Hold belongs to." } ] }, "account": { "allOf": [ { "$ref": "#/$defs/holdsModelAccount" }, { "description": "The identifier of the Account that owns this holds resource." } ] }, "verification": { "allOf": [ { "$ref": "#/$defs/holdsModelVerification" }, { "description": "If this hold resource was triggered through a verification, then this field stores the identifier of the Verification." } ] }, "verificationRef": { "allOf": [ { "$ref": "#/$defs/holdsModelVerificationRef" }, { "description": "If this hold resource was triggered through Payrix Integration Risk, then this field stores the identifier of the VerificationRef." } ] }, "decisionAction": { "allOf": [ { "$ref": "#/$defs/holdsModelDecisionAction" }, { "description": "The identifier of the DecisionAction associated with this Hold resource." } ] }, "action": { "allOf": [ { "$ref": "#/$defs/holdAction" }, { "description": "The action taken on the referenced Txn. Block, Hold, or Reserve it.\n\n
\nValid Values\n\n- `0` - **NONE**\n- `1` - **Block.** Block the Transaction from proceeding. This returns an error.\n- `3` - **Hold.** Hold the Transaction. It will not be captured until it is manually released.\n- `4` - **Reserve** Reserve the Transaction. The funds for the transaction will not be released until the Transaction is manually reviewed.\n- `5` - **LIMIT** Block current activity.\n- `6` - **PASS** Passed decision(s).\n- `8` - **POSTREVIEWONLY** Passed decision(s).\n\n
" } ] }, "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. The format should be YYYY-MM-DD HH:MM: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" }, "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
" } ] }, "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
" } ] }, "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. The format should be YYYY-MM-DD HH:MM:SS." }, "analyst": { "allOf": [ { "$ref": "#/$defs/holdsModelAnalyst" }, { "description": "The person who review the hold applied." } ] }, "claimed": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string", "description": "The timestamp for the most recent update of the analyst field. The format should be YYYY-MM-DD HH:MM:SS." }, "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": "Reason id for why a hold was created." }, "holdSourceDetails": { "type": "string", "description": "It adds details to hold source." }, "division": { "type": "string", "description": "ID of the division associated with this vendor" }, "messageThread": { "type": "array", "items": { "$ref": "#/$defs/messageThreadsResponse" }, "description": "" }, "notes": { "type": "array", "items": { "$ref": "#/$defs/notesResponse" }, "description": "" }, "reserveEntries": { "type": "array", "items": { "$ref": "#/$defs/reserveEntriesResponse" }, "description": "" }, "reserve": { "$ref": "#/$defs/reservesResponse" } } }, "hostsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division resource that this Host belongs to." }, "hostsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition resource that this Host belongs to." }, "hostsResponse": { "title": "hostsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "partition": { "allOf": [ { "$ref": "#/$defs/hostsModelPartition" }, { "description": "The identifier of the Partition resource that this Host belongs to." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/hostsModelDivision" }, { "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" }, "interchangeHistoriesIsCurrent": { "title": "interchangeHistoriesIsCurrent", "enum": [ 0, 1 ], "type": "integer" }, "interchangeHistoriesIsInitial": { "title": "interchangeHistoriesIsInitial", "enum": [ 0, 1 ], "type": "integer" }, "interchangeHistoriesResponse": { "title": "interchangeHistoriesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "ref": { "type": "string", "description": "A reference identifier for this interchange history record." }, "txn": { "type": "string", "description": "The identifier of the Transaction associated with this interchange history record." }, "flatRateFee": { "type": "integer", "description": "The flat rate fee component of the interchange, in cents. For example, 22 represents $0.22.", "contentEncoding": "int32" }, "percentFee": { "type": "integer", "description": "The percentage fee component of the interchange, in basis points. For example, 2530 represents 25.3%.", "contentEncoding": "int32" }, "network": { "type": "string", "description": "The card network associated with this interchange record (e.g., Visa, Mastercard, Discover, Amex)." }, "date": { "type": "string", "description": "The date of this interchange record. Used to determine the most recent record for a transaction.", "contentEncoding": "date" }, "amount": { "type": "integer", "description": "The total interchange amount for this record, in cents.", "contentEncoding": "int32" }, "code": { "type": "string", "description": "The interchange qualification code assigned by the card network." }, "description": { "type": "string", "description": "A human-readable description of the interchange qualification level." }, "reclassReason": { "type": "string", "description": "The reason for the interchange reclassification, if applicable. Populated when a transaction's interchange is reclassified after initial settlement." }, "reclassDelta": { "type": "integer", "description": "The difference in interchange amount compared to the previous record, in cents. Calculated as the current record's amount minus the previous record's amount. A value of 0 indicates no change or that this is not the most recent record.", "contentEncoding": "int32" }, "isInitial": { "allOf": [ { "$ref": "#/$defs/interchangeHistoriesIsInitial" }, { "description": "Indicates whether this is the initial interchange assignment received at settlement.\n\n
\nValid Values\n\n- `0` - **This is an interchange reclassification record.**\n\n- `1` - **This is the original interchange record assigned at settlement.**\n\n
" } ] }, "isCurrent": { "allOf": [ { "$ref": "#/$defs/interchangeHistoriesIsCurrent" }, { "description": "Indicates whether this is the most recent interchange record for the transaction. Only one record per transaction will have isCurrent = 1.\n\n
\nValid Values\n\n- `0` - **This record has been superseded by a later reclassification.**\n\n- `1` - **This is the current interchange record for the transaction.**\n\n
" } ] } } }, "invoiceItemsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this InvoiceItem." }, "invoiceItemsResponse": { "title": "invoiceItemsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/invoiceItemsModelLogin" }, { "description": "The identifier of the Login that owns this InvoiceItem." } ] }, "item": { "type": "string", "description": "The desired name of this InvoiceItem. This field is stored as a text string and must be between 1 and 500 characters long." }, "description": { "type": "string", "description": "The description of this InvoiceItem. This field is stored as a text string and must be between 0 and 500 characters long." }, "custom": { "type": "string", "description": "A custom field of this InvoiceItem. This field is stored as a text string and must be between 0 and 500 characters long." }, "um": { "type": "string", "description": "The unit of measure of this InvoiceItem is stored as a text string and must be between 0 and 100 characters long; examples of units of measure may be: each, kilogram, pound, month." }, "commodityCode": { "type": "string", "description": "The commodity code for this InvoiceItem. This field is stored as a text string and must be between 0 and 12 characters long." }, "productCode": { "type": "string", "description": "The product code for this invoice item such as: UPC, catalog number, or inventory number. This field is stored as a text string and must be between 0 and 100 characters long." }, "price": { "type": "integer", "description": "The price of this InvoiceItem is specified as an integer in cents.", "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
" } ] }, "invoiceLineItems": { "type": "array", "items": { "$ref": "#/$defs/invoiceLineItemsResponse" }, "description": "" } } }, "invoiceLineItemsModelInvoice": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/invoicesResponse" } ], "description": "The identifier of the Invoice that owns this InvoiceLineItem." }, "invoiceLineItemsModelInvoiceItem": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/invoiceItemsResponse" } ], "description": "The identifier of the InvoiceItem associated with this InvoiceLineItem." }, "invoiceLineItemsResponse": { "title": "invoiceLineItemsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "invoice": { "allOf": [ { "$ref": "#/$defs/invoiceLineItemsModelInvoice" }, { "description": "The identifier of the Invoice that owns this InvoiceLineItem." } ] }, "invoiceItem": { "allOf": [ { "$ref": "#/$defs/invoiceLineItemsModelInvoiceItem" }, { "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" }, "price": { "type": "integer", "description": "The price for each item, this field is specified as an integer in cents.", "contentEncoding": "int64" }, "discount": { "type": "integer", "description": "The discount for the line item, this field is specified as an integer in cents.", "contentEncoding": "int64" }, "total": { "type": "integer", "description": "The total price for the line item, which 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" }, "invoiceParametersModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division associated with this invoiceParameter." }, "invoiceParametersModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this invoiceParameter." }, "invoiceParametersModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this invoiceParameter resource." }, "invoiceParametersModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org associated with this invoiceParameter." }, "invoiceParametersModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition associated with this invoiceParameter." }, "invoiceParametersResponse": { "title": "invoiceParametersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/invoiceParametersModelLogin" }, { "description": "The identifier of the Login that owns this invoiceParameter resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/invoiceParametersModelEntity" }, { "description": "The identifier of the Entity associated with this invoiceParameter." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/invoiceParametersModelOrg" }, { "description": "The identifier of the Org associated with this invoiceParameter." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/invoiceParametersModelDivision" }, { "description": "The identifier of the Division associated with this invoiceParameter." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/invoiceParametersModelPartition" }, { "description": "The identifier of the Partition associated with this invoiceParameter." } ] }, "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." }, "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
" } ] }, "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
" } ] } } }, "invoiceResultModelInvoice": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/invoicesResponse" } ], "description": "The identifier of the Invoice that owns this invoiceResult resource." }, "invoiceResultModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the Transaction associated with this invoiceResult resource." }, "invoiceResultResponse": { "title": "invoiceResultResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "invoice": { "allOf": [ { "$ref": "#/$defs/invoiceResultModelInvoice" }, { "description": "The identifier of the Invoice that owns this invoiceResult resource." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/invoiceResultModelTxn" }, { "description": "The identifier of the Transaction associated with this invoiceResult resource." } ] }, "status": { "allOf": [ { "$ref": "#/$defs/invoiceResultStatus" }, { "description": "The status of this invoiceResult\n\n
\nValid Values\n\n- `success` - **Successfuly processed.** \n\n- `failure` - **Failed to process.**\n\n
" } ] }, "message": { "type": "string", "description": "A message that accompanies and describes this invoice result. This field is specified as a text string and must be between 1 and 500 characters long." }, "shippingFirst": { "type": "string", "description": "The shipping first name associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 100 characters long." }, "shippingMiddle": { "type": "string", "description": "The shipping middle name associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 100 characters long." }, "shippingLast": { "type": "string", "description": "The shipping last name associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 100 characters long." }, "shippingCompany": { "type": "string", "description": "The shipping name of the company associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 100 characters long." }, "shippingAddress1": { "type": "string", "description": "The shipping first line of the address associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 500 characters long." }, "shippingAddress2": { "type": "string", "description": "The shipping second line of the address associated with this InvoiceResult. This field is stored as a text string and must be between 0 and 500 characters long." }, "shippingCity": { "type": "string", "description": "The shipping name of the city in the address associated with this InvoiceResult. This field is stored as a text string and must be between 0 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 shipping zip code in the address associated with this InvoiceResult. This field is stored as a text string and must be between 1 and 20 characters long." }, "shippingCountry": { "allOf": [ { "$ref": "#/$defs/country" }, { "description": "The shipping country associated with this InvoiceResult, valid values being the 3-letter ISO code for the country." } ] }, "shippingPhone": { "type": "string", "description": "The shipping phone number associated with this InvoiceResult. This field is stored as a text string and must be between 5 and 15 characters long." }, "shippingFax": { "type": "string", "description": "The shipping fax number associated with this InvoiceResult, stored as a text string and must be between 5 and 15 characters long." }, "authorization": { "type": "string", "description": "The authorization text the customer agreed to when making this payment." }, "authorizationData": { "type": "string", "description": "Replacement data for replaceable strings in the authorization text." }, "signature": { "type": "string", "description": "The signature on file for the customer’s authorization acceptance." } } }, "invoiceResultStatus": { "title": "invoiceResultStatus", "enum": [ "success", "failure" ], "type": "string" }, "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" }, "invoicesModelCustomer": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/customersResponse" } ], "description": "The identifier of the Customer of this invoice resource." }, "invoicesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login of this invoice resource." }, "invoicesModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant of this invoice resource." }, "invoicesModelSubscription": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/subscriptionsResponse" } ], "description": "The identifier of the Subscription of this invoice resource." }, "invoicesResponse": { "title": "invoicesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/invoicesModelLogin" }, { "description": "The identifier of the Login of this invoice resource." } ] }, "merchant": { "allOf": [ { "$ref": "#/$defs/invoicesModelMerchant" }, { "description": "The identifier of the Merchant of this invoice resource." } ] }, "customer": { "allOf": [ { "$ref": "#/$defs/invoicesModelCustomer" }, { "description": "The identifier of the Customer of this invoice resource." } ] }, "subscription": { "allOf": [ { "$ref": "#/$defs/invoicesModelSubscription" }, { "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." }, "emails": { "type": "string", "description": "The email addresses to send the invoice to." }, "total": { "type": "integer", "description": "The total amount for this invoice.", "contentEncoding": "int64" }, "tax": { "type": "integer", "description": "The tax amount for this invoice.", "contentEncoding": "int64" }, "discount": { "type": "integer", "description": "The discount amount applied to this invoice.", "contentEncoding": "int64" }, "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
" } ] }, "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
" } ] }, "dueDate": { "type": "integer", "description": "The date the invoice is due.", "contentEncoding": "int32" }, "expirationDate": { "type": "integer", "description": "The date the invoice is due.", "contentEncoding": "int32" }, "sendOn": { "type": "integer", "description": "The date to send this invoice.", "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
" } ] }, "invoiceLineItems": { "type": "array", "items": { "$ref": "#/$defs/invoiceLineItemsResponse" }, "description": "" }, "invoiceResults": { "type": "array", "items": { "$ref": "#/$defs/invoiceResultResponse" }, "description": "" } } }, "itemsModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The txn in which these items have been sold, A single txn may have many items." }, "itemsResponse": { "title": "itemsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "txn": { "allOf": [ { "$ref": "#/$defs/itemsModelTxn" }, { "description": "The txn in which these items have been sold, A single txn may have many items." } ] }, "item": { "type": "string", "description": "The SKU, short name or title of the item sold." }, "description": { "type": "string", "description": "A description of this Item. This field is stored as a text string and must be between 0 and 500 characters long." }, "custom": { "type": "string", "description": "A custom identifier for this line Item. This field is stored as a text string and must be between 0 and 500 characters long." }, "um": { "type": "string", "description": "The unit of measure for this Item. This field is stored as a text string and must be between 0 and 100 characters long. Examples of units of measure may be: each, kilogram, pound, month." }, "commodityCode": { "type": "string", "description": "The commodity code for this Item. This field is stored as a text string and must be between 0 and 12 characters long." }, "productCode": { "type": "string", "description": "The product code for this Item such as: UPC, catalog number, or inventory number. This field is stored as a text string and must be between 0 and 100 characters long." }, "quantity": { "type": "integer", "description": "The quantity of this Item included in the Transaction. This field is specified as an integer.", "contentEncoding": "int32" }, "price": { "type": "integer", "description": "The amount charged for this Item. This field is specified as an integer in cents.", "contentEncoding": "int64" }, "total": { "type": "integer", "description": "The total price for the line item. This field is specified as an integer in cents.", "contentEncoding": "int64" }, "discount": { "type": "integer", "description": "The discount for the line item. This field is specified as an integer in cents.", "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
" } ] } } }, "loginHelpersLoginAsEnabled": { "title": "loginHelpersLoginAsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "loginHelpersModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "loginHelpersResponse": { "title": "loginHelpersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/loginHelpersModelLogin" }, { "description": "The Login that owns this resource." } ] }, "mfaSmsCode": { "type": "string", "description": "The most recent SMS Code which has been texted to the user." }, "mfaSmsCodeUnixTime": { "type": "integer", "description": "The expiry date of the most recent SMS Code.", "contentEncoding": "int32" }, "mfaSmsCodeAttempts": { "type": "integer", "description": "The number of times the most recent code has been attempted.", "contentEncoding": "int32" }, "mfaSmsCodesCount": { "type": "integer", "description": "The number of codes which has been created in the current window. \n If this goes above the max, you must wait until a new window to create more.", "contentEncoding": "int32" }, "mfaSmsWindow": { "type": "integer", "description": "The end time of the current MFA SMS window which is a sliding window limiting how many codes can be generated during a given window.", "contentEncoding": "int32" }, "loginAsEnabled": { "allOf": [ { "$ref": "#/$defs/loginHelpersLoginAsEnabled" }, { "description": "Whether the associated login can use loginAs or not.\n\n
\nValid Values\n\n- `0` - **OFF**\n- `1` - **ON**\n\n
" } ] } } }, "loginsConfirmed": { "title": "loginsConfirmed", "enum": [ 0, 1 ], "type": "integer" }, "loginsMfaEnabled": { "title": "loginsMfaEnabled", "enum": [ 0, 1 ], "type": "integer" }, "loginsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The division that this Login belongs to." }, "loginsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login." }, "loginsPortalAccess": { "title": "loginsPortalAccess", "enum": [ 0, 1 ], "type": "integer" }, "loginsResponse": { "title": "loginsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/loginsModelLogin" }, { "description": "The identifier of the Login." } ] }, "lastLogin": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "The timestamp when this Login last logged in to the API. The format should be YYYY-MM-DD HH:MM:SS." }, "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." }, "ssoId": { "type": "string", "description": "The SSO (Single Sign On) ID setup for the login. \nThis field is stored as a text string and must be between 1 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." }, "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." }, "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." }, "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." } ] }, "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." }, "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
" }, "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." }, "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." }, "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." }, "confirmed": { "allOf": [ { "$ref": "#/$defs/loginsConfirmed" }, { "description": "Whether the email associated with this Login was confirmed. This field is stored as an integer and will be set to '1' when the email is confirmed. \n\n
Valid Values\n\n - `0` - **Not confirmed.**\n\n - `1` - **Confirmed.**\n\n
" } ] }, "roles": { "type": "integer", "description": "The roles associated with this Login, specified as an integer.", "contentEncoding": "int64" }, "partition": { "type": "string", "description": "The partition that this Login is associated with." }, "division": { "allOf": [ { "$ref": "#/$defs/loginsModelDivision" }, { "description": "The division that this Login belongs to." } ] }, "parentDivision": { "type": "string", "description": "The parent division that this Login belongs to. Children of this Login will inherit its parent division." }, "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." }, "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." }, "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": { "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." }, "effectiveRoles": { "type": "integer", "description": "EffectiveRoles is included in the response when a user record is returned via API indicating the full effective roles of the user (as an integer), broken down by role, for roles that include other roles automatically.", "contentEncoding": "int64" }, "mfaSmsCodesCount": { "type": "integer", "description": "The end time of the current MFA SMS window which is a sliding window limitinig how many codes can be generated during a given window", "contentEncoding": "int32" }, "mfaSmsWindow": { "type": "integer", "description": "The most recent SMS Code which has been texted to the user", "contentEncoding": "int32" }, "loginAsEnabled": { "type": "integer", "description": "Whether the associated login can use loginAs or not", "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
" } ] }, "aggregations": { "type": "array", "items": { "$ref": "#/$defs/aggregationsResponse" }, "description": "" }, "analyzedChangeRequests": { "type": "array", "items": { "$ref": "#/$defs/changeRequest" }, "description": "" }, "changeRequests": { "type": "array", "items": { "$ref": "#/$defs/changeRequest" }, "description": "" }, "confirmCodes": { "type": "array", "items": { "$ref": "#/$defs/confirmCodesResponse" }, "description": "" }, "customers": { "type": "array", "items": { "$ref": "#/$defs/customersResponse" }, "description": "" }, "billings": { "type": "array", "items": { "$ref": "#/$defs/billingsResponse" }, "description": "" }, "divisions": { "type": "array", "items": { "$ref": "#/$defs/divisionsResponse" }, "description": "" }, "entities": { "type": "array", "items": { "$ref": "#/$defs/entitiesResponse" }, "description": "" }, "entityReturns": { "type": "array", "items": { "$ref": "#/$defs/entityReturnsResponse" }, "description": "" }, "invoices": { "type": "array", "items": { "$ref": "#/$defs/invoicesResponse" }, "description": "" }, "invoiceParameters": { "type": "array", "items": { "$ref": "#/$defs/invoiceParametersResponse" }, "description": "" }, "logins": { "type": "array", "items": { "$ref": "#/$defs/loginsResponse" }, "description": "" }, "loginsHelpers": { "type": "array", "items": { "$ref": "#/$defs/loginHelpersResponse" }, "description": "" }, "notes": { "type": "array", "items": { "$ref": "#/$defs/notesResponse" }, "description": "" }, "messageThreads": { "type": "array", "items": { "$ref": "#/$defs/messageThreadsResponse" }, "description": "" }, "orgFlows": { "type": "array", "items": { "$ref": "#/$defs/orgFlowsResponse" }, "description": "" }, "orgFlowsforlogin": { "type": "array", "items": { "$ref": "#/$defs/orgFlowsResponse" }, "description": "" }, "profitShares": { "type": "array", "items": { "$ref": "#/$defs/profitSharesResponse" }, "description": "" }, "secrets": { "type": "array", "items": { "$ref": "#/$defs/secretsResponse" }, "description": "" }, "teamLogins": { "type": "array", "items": { "$ref": "#/$defs/teamLoginResponse" }, "description": "" }, "teams": { "type": "array", "items": { "$ref": "#/$defs/teamsResponse" }, "description": "" } } }, "mccType": { "title": "mccType", "enum": [ "blacklist", "whitelist" ], "type": "string" }, "mccsMccCode": { "title": "mccsMccCode", "enum": [ "0742", "0763", "0780", "1520", "1711", "1731", "1740", "1750", "1761", "1771", "1799", "2741", "2791", "2842", "3000", "3001", "3002", "3003", "3004", "3005", "3006", "3007", "3008", "3009", "3010", "3011", "3012", "3013", "3014", "3015", "3016", "3017", "3018", "3019", "3020", "3021", "3022", "3023", "3024", "3025", "3026", "3027", "3028", "3029", "3030", "3031", "3032", "3033", "3034", "3035", "3036", "3037", "3038", "3039", "3040", "3041", "3042", "3043", "3044", "3045", "3046", "3047", "3048", "3049", "3050", "3051", "3052", "3053", "3054", "3055", "3056", "3057", "3058", "3059", "3060", "3061", "3062", "3063", "3064", "3065", "3066", "3067", "3068", "3069", "3070", "3071", "3072", "3073", "3074", "3075", "3076", "3077", "3078", "3079", "3080", "3081", "3082", "3083", "3084", "3085", "3086", "3087", "3088", "3089", "3090", "3091", "3092", "3093", "3094", "3095", "3096", "3097", "3098", "3099", "3100", "3101", "3102", "3103", "3104", "3105", "3106", "3107", "3108", "3109", "3110", "3111", "3112", "3113", "3114", "3115", "3116", "3117", "3118", "3119", "3120", "3121", "3122", "3123", "3124", "3125", "3126", "3127", "3128", "3129", "3130", "3131", "3132", "3133", "3134", "3135", "3136", "3137", "3138", "3139", "3140", "3141", "3142", "3143", "3144", "3145", "3146", "3147", "3148", "3149", "3150", "3151", "3152", "3153", "3154", "3155", "3156", "3157", "3158", "3159", "3160", "3161", "3162", "3163", "3164", "3165", "3166", "3167", "3168", "3169", "3170", "3171", "3172", "3173", "3174", "3175", "3176", "3177", "3178", "3179", "3180", "3181", "3182", "3183", "3184", "3185", "3186", "3187", "3188", "3189", "3190", "3191", "3192", "3193", "3194", "3195", "3196", "3197", "3198", "3199", "3200", "3201", "3202", "3203", "3204", "3205", "3206", "3207", "3208", "3209", "3210", "3211", "3212", "3213", "3214", "3215", "3216", "3217", "3218", "3219", "3220", "3221", "3222", "3223", "3224", "3225", "3226", "3227", "3228", "3229", "3230", "3231", "3232", "3233", "3234", "3235", "3236", "3237", "3238", "3239", "3240", "3241", "3242", "3243", "3244", "3245", "3246", "3247", "3248", "3249", "3250", "3251", "3252", "3253", "3254", "3255", "3256", "3257", "3258", "3259", "3260", "3261", "3262", "3263", "3264", "3265", "3266", "3267", "3268", "3269", "3270", "3271", "3272", "3273", "3274", "3275", "3276", "3277", "3278", "3279", "3280", "3281", "3282", "3283", "3284", "3285", "3286", "3287", "3288", "3289", "3290", "3291", "3292", "3293", "3294", "3295", "3296", "3297", "3298", "3299", "3351", "3352", "3353", "3354", "3355", "3356", "3357", "3358", "3359", "3360", "3361", "3362", "3363", "3364", "3365", "3366", "3367", "3368", "3369", "3370", "3371", "3372", "3373", "3374", "3375", "3376", "3377", "3378", "3379", "3380", "3381", "3382", "3383", "3384", "3385", "3386", "3387", "3388", "3389", "3390", "3391", "3392", "3393", "3394", "3395", "3396", "3397", "3398", "3399", "3400", "3401", "3402", "3403", "3404", "3405", "3406", "3407", "3408", "3409", "3410", "3411", "3412", "3413", "3414", "3415", "3416", "3417", "3418", "3419", "3420", "3421", "3422", "3423", "3424", "3425", "3426", "3427", "3428", "3429", "3430", "3431", "3432", "3433", "3434", "3435", "3436", "3437", "3438", "3439", "3440", "3441", "3501", "3502", "3503", "3504", "3505", "3506", "3507", "3508", "3509", "3510", "3511", "3512", "3513", "3514", "3515", "3516", "3517", "3518", "3519", "3520", "3521", "3522", "3523", "3524", "3525", "3526", "3527", "3528", "3529", "3530", "3531", "3532", "3533", "3534", "3535", "3536", "3537", "3538", "3539", "3540", "3541", "3542", "3543", "3544", "3545", "3546", "3547", "3548", "3549", "3550", "3551", "3552", "3553", "3554", "3555", "3556", "3557", "3558", "3559", "3560", "3561", "3562", "3563", "3564", "3565", "3566", "3567", "3568", "3569", "3570", "3571", "3572", "3573", "3574", "3575", "3576", "3577", "3578", "3579", "3580", "3581", "3582", "3583", "3584", "3585", "3586", "3587", "3588", "3589", "3590", "3591", "3592", "3593", "3594", "3595", "3596", "3597", "3598", "3599", "3600", "3601", "3602", "3603", "3604", "3605", "3606", "3607", "3608", "3609", "3610", "3611", "3612", "3613", "3614", "3615", "3616", "3617", "3618", "3619", "3620", "3621", "3622", "3623", "3624", "3625", "3626", "3627", "3628", "3629", "3630", "3631", "3632", "3633", "3634", "3635", "3636", "3637", "3638", "3639", "3640", "3641", "3642", "3643", "3644", "3645", "3646", "3647", "3648", "3649", "3650", "3651", "3652", "3653", "3654", "3655", "3656", "3657", "3658", "3659", "3660", "3661", "3662", "3663", "3664", "3665", "3666", "3667", "3668", "3669", "3670", "3671", "3672", "3673", "3674", "3675", "3676", "3677", "3678", "3679", "3680", "3681", "3682", "3683", "3684", "3685", "3686", "3687", "3688", "3689", "3690", "3691", "3692", "3693", "3694", "3695", "3696", "3697", "3698", "3699", "3700", "3701", "3702", "3703", "3704", "3705", "3706", "3707", "3708", "3709", "3710", "3711", "3712", "3713", "3714", "3715", "3716", "3717", "3718", "3719", "3720", "3721", "3722", "3723", "3724", "3725", "3726", "3727", "3728", "3729", "3730", "3731", "3732", "3733", "3734", "3735", "3736", "3737", "3738", "3739", "3740", "3741", "3742", "3743", "3744", "3745", "3746", "3747", "3748", "3749", "3750", "3751", "3752", "3753", "3754", "3755", "3756", "3757", "3758", "3759", "3760", "3761", "3762", "3763", "3764", "3765", "3766", "3767", "3768", "3769", "3770", "3771", "3772", "3773", "3774", "3775", "3776", "3777", "3778", "3779", "3780", "3781", "3782", "3783", "3784", "3785", "3786", "3787", "3788", "3789", "3790", "3816", "3835", "4011", "4111", "4112", "4119", "4121", "4131", "4214", "4215", "4225", "4411", "4457", "4468", "4511", "4582", "4722", "4723", "4784", "4789", "4812", "4814", "4815", "4816", "4821", "4829", "4899", "4900", "5013", "5021", "5039", "5044", "5045", "5046", "5047", "5051", "5065", "5072", "5074", "5085", "5094", "5099", "5111", "5122", "5131", "5137", "5139", "5169", "5172", "5192", "5193", "5198", "5199", "5200", "5211", "5231", "5251", "5261", "5271", "5300", "5309", "5310", "5311", "5331", "5399", "5411", "5422", "5441", "5451", "5462", "5499", "5511", "5521", "5531", "5532", "5533", "5541", "5542", "5551", "5552", "5561", "5571", "5592", "5598", "5599", "5611", "5621", "5631", "5641", "5651", "5655", "5661", "5681", "5691", "5697", "5698", "5699", "5712", "5713", "5714", "5718", "5719", "5722", "5732", "5733", "5734", "5735", "5811", "5812", "5813", "5814", "5815", "5816", "5817", "5818", "5832", "5912", "5921", "5931", "5932", "5933", "5935", "5937", "5940", "5941", "5942", "5943", "5944", "5945", "5946", "5947", "5948", "5949", "5950", "5960", "5961", "5962", "5963", "5964", "5965", "5966", "5967", "5968", "5969", "5970", "5971", "5972", "5973", "5975", "5976", "5977", "5978", "5983", "5992", "5993", "5994", "5995", "5996", "5997", "5998", "5999", "6010", "6011", "6012", "6051", "6211", "6300", "6381", "6399", "6513", "7011", "7012", "7032", "7033", "7210", "7211", "7216", "7217", "7221", "7230", "7251", "7261", "7273", "7276", "7277", "7278", "7296", "7297", "7298", "7299", "7311", "7321", "7332", "7333", "7338", "7339", "7342", "7349", "7361", "7372", "7375", "7379", "7392", "7393", "7394", "7395", "7399", "7511", "7512", "7513", "7519", "7523", "7531", "7534", "7535", "7538", "7542", "7549", "7622", "7623", "7629", "7631", "7641", "7692", "7699", "7800", "7801", "7802", "7829", "7832", "7841", "7911", "7922", "7929", "7932", "7933", "7941", "7991", "7992", "7993", "7994", "7995", "7996", "7997", "7998", "7999", "8011", "8021", "8031", "8041", "8042", "8043", "8044", "8049", "8050", "8062", "8071", "8099", "8111", "8211", "8220", "8241", "8244", "8249", "8299", "8351", "8398", "8641", "8651", "8661", "8675", "8699", "8734", "8911", "8931", "8999", "9211", "9222", "9223", "9311", "9399", "9402", "9405", "9700", "9701", "9702", "9950" ], "type": "string" }, "mccsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The Division on which this MCC applies." }, "mccsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this Mcc resource." }, "mccsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this Mccs resource." }, "mccsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org associated with this Mcc resource." }, "mccsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The Partition on which this MCC applies." }, "mccsResponse": { "title": "mccsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/mccsModelLogin" }, { "description": "The identifier of the Login that owns this Mccs resource." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/mccsModelOrg" }, { "description": "The identifier of the Org associated with this Mcc resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/mccsModelEntity" }, { "description": "The identifier of the Entity associated with this Mcc resource." } ] }, "mcc": { "allOf": [ { "$ref": "#/$defs/mccsMccCode" }, { "description": "
Valid Values\n\n `0742` - **Veterinary Services**\n\n `0763` - **Agricultural Co-operatives**\n\n `0780` - **Horticultural Services, Landscaping Services**\n\n `1520` - **General Contractors-Residential and Commercial**\n\n `1711` - **Air Conditioning Contractors - Sales and Installation, Heating Contractors - Sales, Service, Installation**\n\n `1731` - **Electrical Contractors**\n\n `1740` - **Insulation - Contractors, Masonry, Stonework Contractors, Plastering Contractors, Stonework and Masonry Contractors, Tile Settings Contractors**\n\n `1750` - **Carpentry Contractors**\n\n `1761` - **Roofing - Contractors, Sheet Metal Work - Contractors, Siding - Contractors**\n\n `1771` - **Contractors - Concrete Work**\n\n `1799` - **Contractors - Special Trade, Not Elsewhere Classified**\n\n `2741` - **Miscellaneous Publishing and Printing**\n\n `2791` - **Typesetting, Plate Making, & Related Services**\n\n `2842` - **Specialty Cleaning, Polishing, and Sanitation Preparations**\n\n `3000` - **UNITED AIRLINES**\n\n `3001` - **AMERICAN AIRLINES**\n\n `3002` - **PAN AMERICAN**\n\n `3003` - **Airlines**\n\n `3004` - **TRANS WORLD AIRLINES**\n\n `3005` - **BRITISH AIRWAYS**\n\n `3006` - **JAPAN AIRLINES**\n\n `3007` - **AIR FRANCE**\n\n `3008` - **LUFTHANSA**\n\n `3009` - **AIR CANADA**\n\n `3010` - **KLM (ROYAL DUTCH AIRLINES)**\n\n `3011` - **AEORFLOT**\n\n `3012` - **QUANTAS**\n\n `3013` - **ALITALIA**\n\n `3014` - **SAUDIA ARABIAN AIRLINES**\n\n `3015` - **SWISSAIR**\n\n `3016` - **SAS**\n\n `3017` - **SOUTH AFRICAN AIRWAYS**\n\n `3018` - **VARIG (BRAZIL)**\n\n `3019` - **Airlines**\n\n `3020` - **AIR-INDIA**\n\n `3021` - **AIR ALGERIE**\n\n `3022` - **PHILIPPINE AIRLINES**\n\n `3023` - **MEXICANA**\n\n `3024` - **PAKISTAN INTERNATIONAL**\n\n `3025` - **AIR NEW ZEALAND**\n\n `3026` - **Airlines**\n\n `3027` - **UTA/INTERAIR**\n\n `3028` - **AIR MALTA**\n\n `3029` - **SABENA**\n\n `3030` - **AEROLINEAS ARGENTINAS**\n\n `3031` - **OLYMPIC AIRWAYS**\n\n `3032` - **EL AL**\n\n `3033` - **ANSETT AIRLINES**\n\n `3034` - **AUSTRAINLIAN AIRLINES**\n\n `3035` - **TAP (PORTUGAL)**\n\n `3036` - **VASP (BRAZIL)**\n\n `3037` - **EGYPTAIR**\n\n `3038` - **KUWAIT AIRLINES**\n\n `3039` - **AVIANCA**\n\n `3040` - **GULF AIR (BAHRAIN)**\n\n `3041` - **BALKAN-BULGARIAN AIRLINES**\n\n `3042` - **FINNAIR**\n\n `3043` - **AER LINGUS**\n\n `3044` - **AIR LANKA**\n\n `3045` - **NIGERIA AIRWAYS**\n\n `3046` - **CRUZEIRO DO SUL (BRAZIJ)**\n\n `3047` - **THY (TURKEY)**\n\n `3048` - **ROYAL AIR MAROC**\n\n `3049` - **TUNIS AIR**\n\n `3050` - **ICELANDAIR**\n\n, `3051` - **AUSTRIAN AIRLINES**\n\n `3052` - **LANCHILE**\n\n `3053` - **AVIACO (SPAIN)**\n\n `3054` - **LADECO (CHILE)**\n\n `3055` - **LAB (BOLIVIA)**\n\n `3056` - **QUEBECAIRE**\n\n `3057` - **EASTWEST AIRLINES (AUSTRALIA)**\n\n `3058` - **DELTA**\n\n `3059` - **Airlines**\n\n `3060` - **NORTHWEST**\n\n `3061` - **CONTINENTAL**\n\n `3062` - **WESTERN**\n\n `3063` - **US AIR**\n\n `3064` - **Airlines**\n\n `3065` - **AIRINTER**\n\n `3066` - **SOUTHWEST**\n\n `3067` - **Airlines**\n\n `3068` - **Airlines**\n\n `3069` - **SUN COUNTRY AIRLINES**\n\n `3070` - **Airlines**\n\n `3071` - **AIR BRITISH COLUMBIA**\n\n `3072` - **Airlines**\n\n `3073` - **Airlines**\n\n `3074` - **Airlines**\n\n `3075` - **SINGAPORE AIRLINES**\n\n `3076` - **AEROMEXICO**\n\n `3077` - **THAI AIRWAYS**\n\n `3078` - **CHINA AIRLINES**\n\n `3079` - **Airlines**\n\n `3080` - **Airlines**\n\n `3081` - **NORDAIR**\n\n `3082` - **KOREAN AIRLINES**\n\n `3083` - **AIR AFRIGUE**\n\n `3084` - **EVA AIRLINES**\n\n `3085` - **MIDWEST EXPRESS AIRLINES, INC.**\n\n `3086` - **Airlines**\n\n `3087` - **METRO AIRLINES**\n\n `3088` - **CROATIA AIRLINES**\n\n `3089` - **TRANSAERO**\n\n `3090` - **Airlines**\n\n `3091` - **Airlines**\n\n `3092` - **Airlines**\n\n `3093` - **Airlines**\n\n `3094` - **ZAMBIA AIRWAYS**\n\n `3095` - **Airlines**\n\n `3096` - **AIR ZIMBABWE**\n\n `3097` - **Airlines**\n\n `3098` - **Airlines**\n\n `3099` - **CATHAY PACIFIC**\n\n `3100` - **MALAYSIAN AIRLINE SYSTEM**\n\n `3101` - **Airlines**\n\n `3102` - **IBERIA**\n\n `3103` - **GARUDA (INDONESIA)**\n\n `3104` - **Airlines**\n\n `3105` - **Airlines**\n\n `3106` - **BRAATHENS S.A.F.E. (NORWAY)**\n\n `3107` - **Airlines**\n\n `3108` - **Airlines**\n\n `3109` - **Airlines**\n\n `3110` - **WINGS AIRWAYS**\n\n `3111` - **BRITISH MIDLAND**\n\n `3112` - **WINDWARD ISLAND**\n\n `3113` - **Airlines**\n\n `3114` - **Airlines**\n\n `3115` - **Airlines**\n\n `3116` - **Airlines**\n\n `3117` - **VIASA**\n\n `3118` - **VALLEY AIRLINES**\n\n `3119` - **Airlines**\n\n `3120` - **Airlines**\n\n `3121` - **Airlines**\n\n `3122` - **Airlines**\n\n `3123` - **Airlines**\n\n `3124` - **Airlines**\n\n `3125` - **TAN**\n\n `3126` - **TALAIR**\n\n `3127` - **TACA INTERNATIONAL**\n\n `3128` - **Airlines**\n\n `3129` - **SURINAM AIRWAYS**\n\n `3130` - **SUN WORLD INTERNATIONAL**\n\n `3131` - **Airlines**\n\n `3132` - **Airlines**\n\n `3133` - **SUNBELT AIRLINES**\n\n `3134` - **Airlines**\n\n `3135` - **SUDAN AIRWAYS**\n\n `3136` - **Airlines**\n\n `3137` - **SINGLETON**\n\n `3138` - **SIMMONS AIRLINES**\n\n `3139` - **Airlines**\n\n `3140` - **Airlines**\n\n `3141` - **Airlines**\n\n `3142` - **Airlines**\n\n `3143` - **SCENIC AIRLINES**\n\n `3144` - **VIRGIN ATLANTIC**\n\n `3145` - **SAN JUAN AIRLINES**\n\n `3146` - **LUXAIR**\n\n `3147` - **Airlines**\n\n `3148` - **Airlines**\n\n `3149` - **Airlines**\n\n `3150` - **Airlines**\n\n `3151` - **AIR ZAIRE**\n\n `3152` - **Airlines**\n\n `3153` - **Airlines**\n\n `3154` - **PRINCEVILLE**\n\n `3155` - **Airlines**\n\n `3156` - **Airlines**\n\n `3157` - **Airlines**\n\n `3158` - **Airlines**\n\n `3159` - **PBA**\n\n `3160` - **Airlines**\n\n `3161` - **ALL NIPPON AIRWAYS**\n\n `3162` - **Airlines**\n\n `3163` - **Airlines**\n\n `3164` - **NORONTAIR**\n\n `3165` - **NEW YORK HELICOPTER**\n\n `3166` - **Airlines**\n\n `3167` - **Airlines**\n\n `3168` - **Airlines**\n\n `3169` - **Airlines**\n\n `3170` - **NOUNT COOK**\n\n `3171` - **CANADIAN AIRLINES INTERNATIONAL**\n\n `3172` - **NATIONAIR**\n\n `3173` - **Airlines**\n\n `3174` - **Airlines**\n\n `3175` - **Airlines**\n\n `3176` - **METROFLIGHT AIRLINES**\n\n `3177` - **Airlines**\n\n `3178` - **MESA AIR**\n\n `3179` - **Airlines**\n\n `3180` - **Airlines**\n\n `3181` - **MALEV**\n\n `3182` - **LOT (POLAND)**\n\n `3183` - **Airlines**\n\n `3184` - **LIAT**\n\n `3185` - **LAV (VENEZUELA)**\n\n `3186` - **LAP (PARAGUAY)**\n\n `3187` - **LACSA (COSTA RICA)**\n\n `3188` - **Airlines**\n\n `3189` - **Airlines**\n\n `3190` - **JUGOSLAV AIR**\n\n `3191` - **ISLAND AIRLINES**\n\n `3192` - **IRAN AIR**\n\n `3193` - **INDIAN AIRLINES**\n\n `3194` - **Airlines**\n\n `3195` - **Airlines**\n\n `3196` - **HAWAIIAN AIR**\n\n `3197` - **HAVASU AIRLINES**\n\n `3198` - **Airlines**\n\n `3199` - **Airlines**\n\n `3200` - **FUYANA AIRWAYS**\n\n `3201` - **Airlines**\n\n `3202` - **Airlines**\n\n `3203` - **GOLDEN PACIFIC AIR**\n\n `3204` - **FREEDOM AIR**\n\n `3205` - **Airlines**\n\n `3206` - **Airlines**\n\n `3207` - **Airlines**\n\n `3208` - **Airlines**\n\n `3209` - **Airlines**\n\n `3210` - **Airlines**\n\n `3211` - **Airlines**\n\n `3212` - **DOMINICANA**\n\n `3213` - **Airlines**\n\n `3214` - **Airlines**\n\n `3215` - **DAN AIR SERVICES**\n\n `3216` - **CUMBERLAND AIRLINES**\n\n `3217` - **CSA**\n\n `3218` - **CROWN AIR**\n\n `3219` - **COPA**\n\n `3220` - **COMPANIA FAUCETT**\n\n `3221` - **TRANSPORTES AEROS MILITARES ECCUATORANOS**\n\n `3222` - **COMMAND AIRWAYS**\n\n `3223` - **COMAIR**\n\n `3224` - **Airlines**\n\n `3225` - **Airlines**\n\n `3226` - **Airlines**\n\n `3227` - **Airlines**\n\n `3228` - **CAYMAN AIRWAYS**\n\n `3229` - **SAETA SOCIAEDAD ECUATORIANOS DE TRANSPORTES AEREOS**\n\n `3230` - **Airlines**\n\n `3231` - **SASHA SERVICIO AERO DE HONDURAS**\n\n `3232` - **Airlines**\n\n `3233` - **CAPITOL AIR**\n\n `3234` - **BWIA**\n\n `3235` - **BROKWAY AIR**\n\n `3236` - **Airlines**\n\n `3237` - **Airlines**\n\n `3238` - **BEMIDJI AIRLINES**\n\n `3239` - **BAR HARBOR AIRLINES**\n\n `3240` - **BAHAMASAIR**\n\n `3241` - **AVIATECA (GUATEMALA)**\n\n `3242` - **AVENSA**\n\n `3243` - **AUSTRIAN AIR SERVICE**\n\n `3244` - **Airlines**\n\n `3245` - **Airlines**\n\n `3246` - **Airlines**\n\n `3247` - **Airlines**\n\n `3248` - **Airlines**\n\n `3249` - **Airlines**\n\n `3250` - **Airlines**\n\n `3251` - **ALOHA AIRLINES**\n\n `3252` - **ALM**\n\n `3253` - **AMERICA WEST**\n\n `3254` - **TRUMP AIRLINE**\n\n `3255` - **Airlines**\n\n `3256` - **ALASKA AIRLINES**\n\n `3257` - **Airlines**\n\n `3258` - **Airlines**\n\n `3259` - **AMERICAN TRANS AIR**\n\n `3260` - **Airlines**\n\n `3261` - **AIR CHINA**\n\n `3262` - **RENO AIR, INC.**\n\n `3263` - **Airlines**\n\n `3264` - **Airlines**\n\n `3265` - **Airlines**\n\n `3266` - **AIR SEYCHELLES**\n\n `3267` - **AIR PANAMA**\n\n `3268` - **Airlines**\n\n `3269` - **Airlines**\n\n `3270` - **Airlines**\n\n `3271` - **Airlines**\n\n `3272` - **Airlines**\n\n `3273` - **Airlines**\n\n `3274` - **Airlines**\n\n `3275` - **Airlines**\n\n `3276` - **Airlines**\n\n `3277` - **Airlines**\n\n `3278` - **Airlines**\n\n `3279` - **Airlines**\n\n `3280` - **AIR JAMAICA**\n\n `3281` - **Airlines**\n\n `3282` - **AIR DJIBOUTI**\n\n `3283` - **Airlines**\n\n `3284` - **AERO VIRGIN ISLANDS**\n\n `3285` - **AERO PERU**\n\n `3286` - **AEROLINEAS NICARAGUENSIS**\n\n `3287` - **AERO COACH AVAIATION**\n\n `3288` - **Airlines**\n\n `3289` - **Airlines**\n\n `3290` - **Airlines**\n\n `3291` - **ARIANA AFGHAN**\n\n `3292` - **CYPRUS AIRWAYS**\n\n `3293` - **ECUATORIANA**\n\n `3294` - **ETHIOPIAN AIRLINES**\n\n `3295` - **KENYA AIRLINES**\n\n `3296` - **Airlines**\n\n `3297` - **Airlines**\n\n `3298` - **AIR MAURITIUS**\n\n `3299` - **WIDERO'S FLYVESELSKAP**\n\n `3351` - **AFFILIATED AUTO RENTAL**\n\n `3352` - **AMERICAN INTL RENT-A-CAR**\n\n `3353` - **BROOKS RENT-A-CAR**\n\n `3354` - **ACTION AUTO RENTAL**\n\n `3355` - **Car Rental**\n\n `3356` - **Car Rental**\n\n `3357` - **HERTZ RENT-A-CAR**\n\n `3358` - **Car Rental**\n\n `3359` - **PAYLESS CAR RENTAL**\n\n `3360` - **SNAPPY CAR RENTAL**\n\n `3361` - **AIRWAYS RENT-A-CAR**\n\n `3362` - **ALTRA AUTO RENTAL**\n\n `3363` - **Car Rental**\n\n `3364` - **AGENCY RENT-A-CAR**\n\n `3365` - **Car Rental**\n\n `3366` - **BUDGET RENT-A-CAR**\n\n `3367` - **Car Rental**\n\n `3368` - **HOLIDAY RENT-A-WRECK**\n\n `3369` - **Car Rental**\n\n `3370` - **RENT-A-WRECK**\n\n `3371` - **Car Rental**\n\n `3372` - **Car Rental**\n\n `3373` - **Car Rental**\n\n `3374` - **Car Rental**\n\n `3375` - **Car Rental**\n\n `3376` - **AJAX RENT-A-CAR**\n\n `3377` - **Car Rental**\n\n `3378` - **Car Rental**\n\n `3379` - **Car Rental**\n\n `3380` - **Car Rental**\n\n `3381` - **EUROP CAR**\n\n `3382` - **Car Rental**\n\n `3383` - **Car Rental**\n\n `3384` - **Car Rental**\n\n `3385` - **TROPICAL RENT-A-CAR**\n\n `3386` - **SHOWCASE RENTAL CARS**\n\n `3387` - **ALAMO RENT-A-CAR**\n\n `3388` - **Car Rental**\n\n `3389` - **AVIS RENT-A-CAR**\n\n `3390` - **DOLLAR RENT-A-CAR**\n\n `3391` - **EUROPE BY CAR**\n\n `3392` - **Car Rental**\n\n `3393` - **NATIONAL CAR RENTAL**\n\n `3394` - **KEMWELL GROUP RENT-A-CAR**\n\n `3395` - **THRIFTY RENT-A-CAR**\n\n `3396` - **TILDEN TENT-A-CAR**\n\n `3397` - **Car Rental**\n\n `3398` - **ECONO-CAR RENT-A-CAR**\n\n `3399` - **Car Rental**\n\n `3400` - **AUTO HOST COST CAR RENTALS**\n\n `3401` - **Car Rental**\n\n `3402` - **Car Rental**\n\n `3403` - **Car Rental**\n\n `3404` - **Car Rental**\n\n `3405` - **ENTERPRISE RENT-A-CAR**\n\n `3406` - **Car Rental**\n\n `3407` - **Car Rental**\n\n `3408` - **Car Rental**\n\n `3409` - **GENERAL RENT-A-CAR**\n\n `3410` - **Car Rental**\n\n `3411` - **Car Rental**\n\n `3412` - **A-1 RENT-A-CAR**\n\n `3413` - **Car Rental**\n\n `3414` - **GODFREY NATL RENT-A-CAR**\n\n `3415` - **Car Rental**\n\n `3416` - **Car Rental**\n\n `3417` - **Car Rental**\n\n `3418` - **Car Rental**\n\n `3419` - **ALPHA RENT-A-CAR**\n\n `3420` - **ANSA INTL RENT-A-CAR**\n\n `3421` - **ALLSTAE RENT-A-CAR**\n\n `3422` - **Car Rental**\n\n `3423` - **AVCAR RENT-A-CAR**\n\n `3424` - **Car Rental**\n\n `3425` - **AUTOMATE RENT-A-CAR**\n\n `3426` - **Car Rental**\n\n `3427` - **AVON RENT-A-CAR**\n\n `3428` - **CAREY RENT-A-CAR**\n\n `3429` - **INSURANCE RENT-A-CAR**\n\n `3430` - **MAJOR RENT-A-CAR**\n\n `3431` - **REPLACEMENT RENT-A-CAR**\n\n `3432` - **RESERVE RENT-A-CAR**\n\n `3433` - **UGLY DUCKLING RENT-A-CAR**\n\n `3434` - **USA RENT-A-CAR**\n\n `3435` - **VALUE RENT-A-CAR**\n\n `3436` - **AUTOHANSA RENT-A-CAR**\n\n `3437` - **CITE RENT-A-CAR**\n\n `3438` - **INTERENT RENT-A-CAR**\n\n `3439` - **MILLEVILLE RENT-A-CAR**\n\n `3440` - **VIA ROUTE RENT-A-CAR**\n\n `3441` - **Car Rental**\n\n `3501` - **HOLIDAY INNS, HOLIDAY INN EXPRESS**\n\n `3502` - **BEST WESTERN HOTELS**\n\n `3503` - **SHERATON HOTELS**\n\n `3504` - **HILTON HOTELS**\n\n `3505` - **FORTE HOTELS**\n\n `3506` - **GOLDEN TULIP HOTELS**\n\n `3507` - **FRIENDSHIP INNS**\n\n `3508` - **QUALITY INNS, QUALITY SUITES**\n\n `3509` - **MARRIOTT HOTELS**\n\n `3510` - **DAYS INN, DAYSTOP**\n\n `3511` - **ARABELLA HOTELS**\n\n `3512` - **INTER-CONTINENTAL HOTELS**\n\n `3513` - **WESTIN HOTELS**\n\n `3514` - **Hotels/Motels/Inns/Resorts**\n\n `3515` - **RODEWAY INNS**\n\n `3516` - **LA QUINTA MOTOR INNS**\n\n `3517` - **AMERICANA HOTELS**\n\n `3518` - **SOL HOTELS**\n\n `3519` - **PULLMAN INTERNATIONAL HOTELS**\n\n `3520` - **MERIDIEN HOTELS**\n\n `3521` - **CREST HOTELS (see FORTE HOTELS)**\n\n `3522` - **TOKYO HOTEL**\n\n `3523` - **PENNSULA HOTEL**\n\n `3524` - **WELCOMGROUP HOTELS**\n\n `3525` - **DUNFEY HOTELS**\n\n `3526` - **Hotels/Motels/Inns/Resorts**\n\n `3527` - **DOWNTOWNER-PASSPORT HOTEL**\n\n `3528` - **RED LION HOTELS, RED LION INNS**\n\n `3529` - **CP HOTELS**\n\n `3530` - **RENAISSANCE HOTELS, STOUFFER HOTELS**\n\n `3531` - **ASTIR HOTELS**\n\n `3532` - **SUN ROUTE HOTELS**\n\n `3533` - **HOTEL IBIS**\n\n `3534` - **SOUTHERN PACIFIC HOTELS**\n\n `3535` - **HILTON INTERNATIONAL**\n\n `3536` - **AMFAC HOTELS**\n\n `3537` - **ANA HOTEL**\n\n `3538` - **CONCORDE HOTELS**\n\n `3539` - **Hotels/Motels/Inns/Resorts**\n\n `3540` - **IBEROTEL HOTELS**\n\n `3541` - **HOTEL OKURA**\n\n `3542` - **ROYAL HOTELS**\n\n `3543` - **FOUR SEASONS HOTELS**\n\n `3544` - **CIGA HOTELS**\n\n `3545` - **SHANGRI-LA INTERNATIONAL**\n\n `3546` - **Hotels/Motels/Inns/Resorts**\n\n `3547` - **Hotels/Motels/Inns/Resorts**\n\n `3548` - **HOTELES MELIA**\n\n `3549` - **AUBERGE DES GOVERNEURS**\n\n `3550` - **REGAL 8 INNS**\n\n `3551` - **Hotels/Motels/Inns/Resorts**\n\n `3552` - **COAST HOTELS**\n\n `3553` - **PARK INNS INTERNATIONAL**\n\n `3554` - **Hotels/Motels/Inns/Resorts**\n\n `3555` - **Hotels/Motels/Inns/Resorts**\n\n `3556` - **Hotels/Motels/Inns/Resorts**\n\n `3557` - **Hotels/Motels/Inns/Resorts**\n\n `3558` - **JOLLY HOTELS**\n\n `3559` - **Hotels/Motels/Inns/Resorts**\n\n `3560` - **Hotels/Motels/Inns/Resorts**\n\n `3561` - **Hotels/Motels/Inns/Resorts**\n\n `3562` - **COMFORT INNS**\n\n `3563` - **JOURNEY'S END MOTLS**\n\n `3564` - **Hotels/Motels/Inns/Resorts**\n\n `3565` - **RELAX INNS**\n\n `3566` - **Hotels/Motels/Inns/Resorts**\n\n `3567` - **Hotels/Motels/Inns/Resorts**\n\n `3568` - **LADBROKE HOTELS**\n\n `3569` - **Hotels/Motels/Inns/Resorts**\n\n `3570` - **FORUM HOTELS**\n\n `3571` - **Hotels/Motels/Inns/Resorts**\n\n `3572` - **MIYAKO HOTELS**\n\n `3573` - **SANDMAN HOTELS**\n\n `3574` - **VENTURE INNS**\n\n `3575` - **VAGABOND HOTELS**\n\n `3576` - **Hotels/Motels/Inns/Resorts**\n\n `3577` - **MANDARIN ORIENTAL HOTEL**\n\n `3578` - **Hotels/Motels/Inns/Resorts**\n\n `3579` - **HOTEL MERCURE**\n\n `3580` - **Hotels/Motels/Inns/Resorts**\n\n `3581` - **DELTA HOTEL**\n\n `3582` - **Hotels/Motels/Inns/Resorts**\n\n `3583` - **SAS HOTELS**\n\n `3584` - **PRINCESS HOTELS INTERNATIONAL**\n\n `3585` - **HUNGAR HOTELS**\n\n `3586` - **SOKOS HOTELS**\n\n `3587` - **DORAL HOTELS**\n\n `3588` - **HELMSLEY HOTELS**\n\n `3589` - **Hotels/Motels/Inns/Resorts**\n\n `3590` - **FAIRMONT HOTELS**\n\n `3591` - **SONESTA HOTELS**\n\n `3592` - **OMNI HOTELS**\n\n `3593` - **CUNARD HOTELS**\n\n `3594` - **Hotels/Motels/Inns/Resorts**\n\n `3595` - **HOSPITALITY INTERNATIONAL**\n\n `3596` - **Hotels/Motels/Inns/Resorts**\n\n `3597` - **Hotels/Motels/Inns/Resorts**\n\n `3598` - **REGENT INTERNATIONAL HOTELS**\n\n `3599` - **PANNONIA HOTELS**\n\n `3600` - **Hotels/Motels/Inns/Resorts**\n\n `3601` - **Hotels/Motels/Inns/Resorts**\n\n `3602` - **Hotels/Motels/Inns/Resorts**\n\n `3603` - **NOAH'S HOTELS**\n\n `3604` - **Hotels/Motels/Inns/Resorts**\n\n `3605` - **Hotels/Motels/Inns/Resorts**\n\n `3606` - **Hotels/Motels/Inns/Resorts**\n\n `3607` - **Hotels/Motels/Inns/Resorts**\n\n `3608` - **Hotels/Motels/Inns/Resorts**\n\n `3609` - **Hotels/Motels/Inns/Resorts**\n\n `3610` - **Hotels/Motels/Inns/Resorts**\n\n `3611` - **Hotels/Motels/Inns/Resorts**\n\n `3612` - **MOVENPICK HOTELS**\n\n `3613` - **Hotels/Motels/Inns/Resorts**\n\n `3614` - **Hotels/Motels/Inns/Resorts**\n\n `3615` - **TRAVELODGE**\n\n `3616` - **Hotels/Motels/Inns/Resorts**\n\n `3617` - **Hotels/Motels/Inns/Resorts**\n\n `3618` - **Hotels/Motels/Inns/Resorts**\n\n `3619` - **Hotels/Motels/Inns/Resorts**\n\n `3620` - **TELFORD INTERNATIONAL**\n\n `3621` - **Hotels/Motels/Inns/Resorts**\n\n `3622` - **MERLIN HOTELS**\n\n `3623` - **DORINT HOTELS**\n\n `3624` - **Hotels/Motels/Inns/Resorts**\n\n `3625` - **HOTLE UNIVERSALE**\n\n `3626` - **PRINCE HOTELS**\n\n `3627` - **Hotels/Motels/Inns/Resorts**\n\n `3628` - **Hotels/Motels/Inns/Resorts**\n\n `3629` - **DAN HOTELS**\n\n `3630` - **Hotels/Motels/Inns/Resorts**\n\n `3631` - **Hotels/Motels/Inns/Resorts**\n\n `3632` - **Hotels/Motels/Inns/Resorts**\n\n `3633` - **RANK HOTELS**\n\n `3634` - **SWISSOTEL**\n\n `3635` - **RESO HOTELS**\n\n `3636` - **SAROVA HOTELS**\n\n `3637` - **RAMADA INNS, RAMADA LIMITED**\n\n `3638` - **HO JO INN, HOWARD JOHNSON**\n\n `3639` - **MOUNT CHARLOTTE THISTLE**\n\n `3640` - **HYATT HOTEL**\n\n `3641` - **SOFITEL HOTELS**\n\n `3642` - **NOVOTEL HOTELS**\n\n `3643` - **STEIGENBERGER HOTELS**\n\n `3644` - **ECONO LODGES**\n\n `3645` - **QUEENS MOAT HOUSES**\n\n `3646` - **SWALLOW HOTELS**\n\n `3647` - **HUSA HOTELS**\n\n `3648` - **DE VERE HOTELS**\n\n `3649` - **RADISSON HOTELS**\n\n `3650` - **RED ROOK INNS**\n\n `3651` - **IMPERIAL LONDON HOTEL**\n\n `3652` - **EMBASSY HOTELS**\n\n `3653` - **PENTA HOTELS**\n\n `3654` - **LOEWS HOTELS**\n\n `3655` - **SCANDIC HOTELS**\n\n `3656` - **SARA HOTELS**\n\n `3657` - **OBEROI HOTELS**\n\n `3658` - **OTANI HOTELS**\n\n `3659` - **TAJ HOTELS INTERNATIONAL**\n\n `3660` - **KNIGHTS INNS**\n\n `3661` - **METROPOLE HOTELS**\n\n `3662` - **Hotels/Motels/Inns/Resorts**\n\n `3663` - **HOTELES EL PRESIDENTS**\n\n `3664` - **FLAG INN**\n\n `3665` - **HAMPTON INNS**\n\n `3666` - **STAKIS HOTELS**\n\n `3667` - **Hotels/Motels/Inns/Resorts**\n\n `3668` - **MARITIM HOTELS**\n\n `3669` - **Hotels/Motels/Inns/Resorts**\n\n `3670` - **ARCARD HOTELS**\n\n `3671` - **ARCTIA HOTELS**\n\n `3672` - **CAMPANIEL HOTELS**\n\n `3673` - **IBUSZ HOTELS**\n\n `3674` - **RANTASIPI HOTELS**\n\n `3675` - **INTERHOTEL CEDOK**\n\n `3676` - **Hotels/Motels/Inns/Resorts**\n\n `3677` - **CLIMAT DE FRANCE HOTELS**\n\n `3678` - **CUMULUS HOTELS**\n\n `3679` - **DANUBIUS HOTEL**\n\n `3680` - **Hotels/Motels/Inns/Resorts**\n\n `3681` - **ADAMS MARK HOTELS**\n\n `3682` - **ALLSTAR INNS**\n\n `3683` - **Hotels/Motels/Inns/Resorts**\n\n `3684` - **BUDGET HOST INNS**\n\n `3685` - **BUDGETEL HOTELS**\n\n `3686` - **SUISSE CHALETS**\n\n `3687` - **CLARION HOTELS**\n\n `3688` - **COMPRI HOTELS**\n\n `3689` - **CONSORT HOTELS**\n\n `3690` - **COURTYARD BY MARRIOTT**\n\n `3691` - **DILLION INNS**\n\n `3692` - **DOUBLETREE HOTELS**\n\n `3693` - **DRURY INNS**\n\n `3694` - **ECONOMY INNS OF AMERICA**\n\n `3695` - **EMBASSY SUITES**\n\n `3696` - **EXEL INNS**\n\n `3697` - **FARFIELD HOTELS**\n\n `3698` - **HARLEY HOTELS**\n\n `3699` - **MIDWAY MOTOR LODGE**\n\n `3700` - **MOTEL 6**\n\n `3701` - **GUEST QUARTERS (Formally PICKETT SUITE HOTELS)**\n\n `3702` - **THE REGISTRY HOTELS**\n\n `3703` - **RESIDENCE INNS**\n\n `3704` - **ROYCE HOTELS**\n\n `3705` - **SANDMAN INNS**\n\n `3706` - **SHILO INNS**\n\n `3707` - **SHONEY'S INNS**\n\n `3708` - **Hotels/Motels/Inns/Resorts**\n\n `3709` - **SUPER8 MOTELS**\n\n `3710` - **THE RITZ CARLTON HOTELS**\n\n `3711` - **FLAG INNS (AUSRALIA)**\n\n `3712` - **GOLDEN CHAIN HOTEL**\n\n `3713` - **QUALITY PACIFIC HOTEL**\n\n `3714` - **FOUR SEASONS HOTEL (AUSTRALIA)**\n\n `3715` - **FARIFIELD INN**\n\n `3716` - **CARLTON HOTELS**\n\n `3717` - **CITY LODGE HOTELS**\n\n `3718` - **KAROS HOTELS**\n\n `3719` - **PROTEA HOTELS**\n\n `3720` - **SOUTHERN SUN HOTELS**\n\n `3721` - **HILTON CONRAD**\n\n `3722` - **WYNDHAM HOTEL AND RESORTS**\n\n `3723` - **RICA HOTELS**\n\n `3724` - **INER NOR HOTELS**\n\n `3725` - **SEAINES PLANATION**\n\n `3726` - **RIO SUITES**\n\n `3727` - **BROADMOOR HOTEL**\n\n `3728` - **BALLY'S HOTEL AND CASINO**\n\n `3729` - **JOHN ASCUAGA'S NUGGET**\n\n `3730` - **MGM GRAND HOTEL**\n\n `3731` - **HARRAH'S HOTELS AND CASINOS**\n\n `3732` - **OPRYLAND HOTEL**\n\n `3733` - **BOCA RATON RESORT**\n\n `3734` - **HARVEY/BRISTOL HOTELS**\n\n `3735` - **Hotels/Motels/Inns/Resorts**\n\n `3736` - **COLORADO BELLE/EDGEWATER RESORT**\n\n `3737` - **RIVIERA HOTEL AND CASINO**\n\n `3738` - **TROPICANA RESORT AND CASINO**\n\n `3739` - **WOODSIDE HOTELS AND RESORTS**\n\n `3740` - **TOWNPLACE SUITES**\n\n `3741` - **MILLENIUM BROADWAY HOTEL**\n\n `3742` - **CLUB MED**\n\n `3743` - **BILTMORE HOTEL AND SUITES**\n\n `3744` - **CAREFREE RESORTS**\n\n `3745` - **ST. REGIS HOTEL**\n\n `3746` - **THE ELIOT HOTEL**\n\n `3747` - **CLUBCORP/CLUB RESORTS**\n\n `3748` - **WELESLEY INNS**\n\n `3749` - **THE BEVERLY HILLS HOTEL**\n\n `3750` - **CROWNE PLAZA HOTELS**\n\n `3751` - **HOMEWOOD SUITES**\n\n `3752` - **PEABODY HOTELS**\n\n `3753` - **GREENBRIAH RESORTS**\n\n `3754` - **AMELIA ISLAND PLANATION**\n\n `3755` - **THE HOMESTEAD**\n\n `3756` - **SOUTH SEAS RESORTS**\n\n `3757` - **Hotels/Motels/Inns/Resorts**\n\n `3758` - **Hotels/Motels/Inns/Resorts**\n\n `3759` - **Hotels/Motels/Inns/Resorts**\n\n `3760` - **Hotels/Motels/Inns/Resorts**\n\n `3761` - **Hotels/Motels/Inns/Resorts**\n\n `3762` - **Hotels/Motels/Inns/Resorts**\n\n `3763` - **Hotels/Motels/Inns/Resorts**\n\n `3764` - **Hotels/Motels/Inns/Resorts**\n\n `3765` - **Hotels/Motels/Inns/Resorts**\n\n `3766` - **Hotels/Motels/Inns/Resorts**\n\n `3767` - **Hotels/Motels/Inns/Resorts**\n\n `3768` - **Hotels/Motels/Inns/Resorts**\n\n `3769` - **Hotels/Motels/Inns/Resorts**\n\n `3770` - **Hotels/Motels/Inns/Resorts**\n\n `3771` - **Hotels/Motels/Inns/Resorts**\n\n `3772` - **Hotels/Motels/Inns/Resorts**\n\n `3773` - **Hotels/Motels/Inns/Resorts**\n\n `3774` - **Hotels/Motels/Inns/Resorts**\n\n `3775` - **Hotels/Motels/Inns/Resorts**\n\n `3776` - **Hotels/Motels/Inns/Resorts**\n\n `3777` - **Hotels/Motels/Inns/Resorts**\n\n `3778` - **Hotels/Motels/Inns/Resorts**\n\n `3779` - **Hotels/Motels/Inns/Resorts**\n\n `3780` - **Hotels/Motels/Inns/Resorts**\n\n `3781` - **Hotels/Motels/Inns/Resorts**\n\n `3782` - **Hotels/Motels/Inns/Resorts**\n\n `3783` - **Hotels/Motels/Inns/Resorts**\n\n `3784` - **Hotels/Motels/Inns/Resorts**\n\n `3785` - **Hotels/Motels/Inns/Resorts**\n\n `3786` - **Hotels/Motels/Inns/Resorts**\n\n `3787` - **Hotels/Motels/Inns/Resorts**\n\n `3788` - **Hotels/Motels/Inns/Resorts**\n\n `3789` - **Hotels/Motels/Inns/Resorts**\n\n `3790` - **Hotels/Motels/Inns/Resorts**\n\n `3816` - **Home2Suites**\n\n `3835` - **MASTERS ECONOMY INNS**\n\n `4011` - **Railroads**\n\n `4111` - **Local/Suburban Commuter Passenger Transportation - Railroads, Ferries, Local Water Transportation**\n\n `4112` - **Passenger Railways**\n\n `4119` - **Ambulance Services**\n\n `4121` - **Taxicabs and Limousines**\n\n `4131` - **Bus Lines, Including Charters, Tour Buses**\n\n `4214` - **Motor Freight Carriers, Moving and Storage Companies, Trucking - Local/Long Distance, Delivery Services - Local**\n\n `4215` - **Courier Services - Air or Ground, Freight Forwarders**\n\n `4225` - **Public Warehousing, Storage**\n\n `4411` - **Cruise and Steamship Lines**\n\n `4457` - **Boat Rentals and Leases**\n\n `4468` - **Marinas, Marine Service, and Supplies**\n\n `4511` - **Airlines, Air Carriers (not listed elsewhere)**\n\n `4582` - **Airports, Airport Terminals, Flying Fields**\n\n `4722` - **Travel Agencies and Tour Operations**\n\n `4723` - **Package Tour Operators (For use in Germany only)**\n\n `4784` - **Toll and Bridge Fees**\n\n `4789` - **Transportation Services, Not Elsewhere Classified**\n\n `4812` - **Telecommunications Equipment including Telephone Sales**\n\n `4814` - **Fax Services, Telecommunication Services**\n\n `4815` - **VisaPhone**\n\n `4816` - **Computer Network Services**\n\n `4821` - **Telegraph Services**\n\n `4829` - **Money Orders - Wire Transfer**\n\n `4899` - **Cable and Other Pay Television (previously Cable Services)**\n\n `4900` - **Electric, Gas, Sanitary and Water Utilities**\n\n `5013` - **Motor Vehicle Supplies and New Parts**\n\n `5021` - **Office and Commercial Furniture**\n\n `5039` - **Construction Materials, Not Elsewhere Classified**\n\n `5044` - **Office, Photographic, Photocopy, and Microfilm Equipment**\n\n `5045` - **Computers, Computer Peripheral Equipment, Software**\n\n `5046` - **Commercial Equipment, Not Elsewhere Classified**\n\n `5047` - **Medical, Dental, Ophthalmic, Hospital Equipment and Supplies**\n\n `5051` - **Metal Service Centers and Offices**\n\n `5065` - **Electrical Parts and Equipment**\n\n `5072` - **Hardware Equipment and Supplies**\n\n `5074` - **Plumbing and Heating Equipment and Supplies**\n\n `5085` - **Industrial Supplies, Not Elsewhere Classified**\n\n `5094` - **Precious Stones and Metals, Watches and Jewelry**\n\n `5099` - **Durable Goods, Not Elsewhere Classified**\n\n `5111` - **Stationery, Office Supplies, Printing, and Writing Paper**\n\n `5122` - **Drugs, Drug Proprietors, and Druggist's Sundries**\n\n `5131` - **Piece Goods, Notions, and Other Dry Goods**\n\n `5137` - **Men's, Women's, and Children's Uniforms and Commercial Clothing**\n\n `5139` - **Commercial Footwear**\n\n `5169` - **Chemicals and Allied Products, Not Elsewhere Classified**\n\n `5172` - **Petroleum and Petroleum Products**\n\n `5192` - **Books, Periodicals, and Newspapers**\n\n `5193` - **Florists' Supplies, Nursery Stock and Flowers**\n\n `5198` - **Paints, Varnishes, and Supplies**\n\n `5199` - **Non-durable Goods, Not Elsewhere Classified**\n\n `5200` - **Home Supply Warehouse Stores**\n\n `5211` - **Lumber and Building Materials Stores**\n\n `5231` - **Glass, Paint, and Wallpaper Stores**\n\n `5251` - **Hardware Stores**\n\n `5261` - **Nurseries - Lawn and Garden Supply Store**\n\n `5271` - **Mobile Home Dealers**\n\n `5300` - **Wholesale Clubs**\n\n `5309` - **Duty Free Store**\n\n `5310` - **Discount Stores**\n\n `5311` - **Department Stores**\n\n `5331` - **Variety Stores**\n\n `5399` - **Misc. General Merchandise**\n\n `5411` - **Grocery Stores, Supermarkets**\n\n `5422` - **Meat Provisioners - Freezer and Locker**\n\n `5441` - **Candy, Nut, and Confectionery Stores**\n\n `5451` - **Dairy Products Stores**\n\n `5462` - **Bakeries**\n\n `5499` - **Misc. Food Stores - Convenience Stores and Specialty Markets**\n\n `5511` - **Car and Truck Dealers (New and Used) Sales, Service, Repairs, Parts, and Leasing**\n\n `5521` - **Automobile and Truck Dealers (Used Only)**\n\n `5531` - **Automobile Supply Stores**\n\n `5532` - **Automotive Tire Stores**\n\n `5533` - **Automotive Parts, Accessories Stores**\n\n `5541` - **Service Stations (with or without ancillary services)**\n\n `5542` - **Automated Fuel Dispensers**\n\n `5551` - **Boat Dealers**\n\n `5552` - **Electric Vehicle Charging**\n\n `5561` - **Recreational and Utility Trailers, Camp Dealers**\n\n `5571` - **Motorcycle Dealers**\n\n `5592` - **Motor Home Dealers**\n\n `5598` - **Snowmobile Dealers**\n\n `5599` - **Miscellaneous Auto Dealers**\n\n `5611` - **Men's and Boy's Clothing and Accessories Stores**\n\n `5621` - **Women's Ready-to-Wear Stores**\n\n `5631` - **Women's Accessory and Specialty Shops**\n\n `5641` - **Children's and Infant's Wear Stores**\n\n `5651` - **Family Clothing Stores**\n\n `5655` - **Sports Apparel, Riding Apparel Stores**\n\n `5661` - **Shoe Stores**\n\n `5681` - **Furriers and Fur Shops**\n\n `5691` - **Men's and Women's Clothing Stores**\n\n `5697` - **Tailors, Seamstress, Mending, and Alterations**\n\n `5698` - **Wig and Toupee Stores**\n\n `5699` - **Miscellaneous Apparel and Accessory Shops**\n\n `5712` - **Furniture, Home Furnishings, and Equipment Stores, Except Appliances**\n\n `5713` - **Floor Covering Stores**\n\n `5714` - **Drapery, Window Covering and Upholstery Stores**\n\n `5718` - **Fireplace, Fireplace Screens, and Accessories Stores**\n\n `5719` - **Miscellaneous Home Furnishing Specialty Stores**\n\n `5722` - **Household Appliance Stores**\n\n `5732` - **Electronic Sales**\n\n `5733` - **Music Stores, Musical Instruments, Piano Sheet Music**\n\n `5734` - **Computer Software Stores**\n\n `5735` - **Record Shops**\n\n `5811` - **Caterers**\n\n `5812` - **Eating Places and Restaurants**\n\n `5813` - **Drinking Places (Alcoholic Beverages), Bars, Taverns, Cocktail Lounges, Nightclubs and Discotheques**\n\n `5814` - **Fast Food Restaurants**\n\n `5815` - **Digital Goods: Media, Books, Movies, Music**\n\n `5816` - **Digital Goods: Games**\n\n `5817` - **Digital Goods: Applications (Excludes Games)**\n\n `5818` - **Digital Goods: Large Digital Goods Merchant**\n\n `5832` - **Antique Shops - Sales, Repairs, and Restoration Services**\n\n `5912` - **Drug Stores and Pharmacies**\n\n `5921` - **Package Stores - Beer, Wine, and Liquor**\n\n `5931` - **Used Merchandise and Secondhand Stores**\n\n `5932` - **Antique Shops**\n\n `5933` - **Pawn Shops and Salvage Yards**\n\n `5935` - **Wrecking and Salvage Yards**\n\n `5937` - **Antique Reproductions**\n\n `5940` - **Bicycle Shops - Sales and Service**\n\n `5941` - **Sporting Goods Stores**\n\n `5942` - **Book Stores**\n\n `5943` - **Stationery Stores, Office and School Supply Stores**\n\n `5944` - **Watch, Clock, Jewelry, and Silverware Stores**\n\n `5945` - **Hobby, Toy, and Game Shops**\n\n `5946` - **Camera and Photographic Supply Stores**\n\n `5947` - **Card Shops, Gift, Novelty, and Souvenir Shops**\n\n `5948` - **Leather Foods Stores**\n\n `5949` - **Sewing, Needle, Fabric, and Price Goods Stores**\n\n `5950` - **Glassware/Crystal Stores**\n\n `5960` - **Direct Marketing- Insurance Service**\n\n `5961` - **Mail Order Houses Including Catalog Order Stores, Book/Record Clubs (No longer permitted for U.S. original presentments)**\n\n `5962` - **Direct Marketing - Travel Related Arrangements Services**\n\n `5963` - **Door-to-Door Sales**\n\n `5964` - **Direct Marketing - Catalog Merchant**\n\n `5965` - **Direct Marketing - Catalog and Catalog and Retail Merchant**\n\n `5966` - **Direct Marketing- Outbound Telemarketing Merchant**\n\n `5967` - **Direct Marketing - Inbound Teleservices Merchant**\n\n `5968` - **Direct Marketing - Continuity/Subscription Merchant**\n\n `5969` - **Direct Marketing - Not Elsewhere Classified**\n\n `5970` - **Artist's Supply and Craft Shops**\n\n `5971` - **Art Dealers and Galleries**\n\n `5972` - **Stamp and Coin Stores - Philatelic and Numismatic Supplies**\n\n `5973` - **Religious Goods Stores**\n\n `5975` - **Hearing Aids - Sales, Service, and Supply Stores**\n\n `5976` - **Orthopedic Goods Prosthetic Devices**\n\n `5977` - **Cosmetic Stores**\n\n `5978` - **Typewriter Stores - Sales, Rental, Service**\n\n `5983` - **Fuel - Fuel Oil, Wood, Coal, Liquefied Petroleum**\n\n `5992` - **Florists**\n\n `5993` - **Cigar Stores and Stands**\n\n `5994` - **News Dealers and Newsstands**\n\n `5995` - **Pet Shops, Pet Foods, and Supplies Stores**\n\n `5996` - **Swimming Pools - Sales, Service, and Supplies**\n\n `5997` - **Electric Razor Stores - Sales and Service**\n\n `5998` - **Tent and Awning Shops**\n\n `5999` - **Miscellaneous and Specialty Retail Stores**\n\n `6010` - **Financial Institutions - Manual Cash Disbursements**\n\n `6011` - **Financial Institutions - Manual Cash Disbursements**\n\n `6012` - **Financial Institutions - Merchandise and Services**\n\n `6051` - **Non-Financial Institutions - Foreign Currency, Money Orders (not wire transfer) and Travelers Cheques**\n\n `6211` - **Security Brokers/Dealers**\n\n `6300` - **Insurance Sales, Underwriting, and Premiums**\n\n `6381` - **Insurance Premiums, (no longer valid for first presentment work)**\n\n `6399` - **Insurance, Not Elsewhere Classified (no longer valid for first presentment work)**\n\n `6513` - **Real Estate Agents and Managers - Rentals**\n\n `7011` - **Lodging - Hotels, Motels, Resorts, Central Reservation Services (not elsewhere classified)**\n\n `7012` - **Timeshares**\n\n `7032` - **Sporting and Recreational Camps**\n\n `7033` - **Trailer Parks and Camp Grounds**\n\n `7210` - **Laundry, Cleaning, and Garment Services**\n\n `7211` - **Laundry - Family and Commercial**\n\n `7216` - **Dry Cleaners**\n\n `7217` - **Carpet and Upholstery Cleaning**\n\n `7221` - **Photographic Studios**\n\n `7230` - **Barber and Beauty Shops**\n\n `7251` - **Shop Repair Shops and Shoe Shine Parlors, and Hat Cleaning Shops**\n\n `7261` - **Funeral Service and Crematories**\n\n `7273` - **Dating and Escort Services**\n\n `7276` - **Tax Preparation Service**\n\n `7277` - **Counseling Service - Debt, Marriage, Personal**\n\n `7278` - **Buying/Shopping Services, Clubs**\n\n `7296` - **Clothing Rental - Costumes, Formal Wear, Uniforms**\n\n `7297` - **Massage Parlors**\n\n `7298` - **Health and Beauty Shops**\n\n `7299` - **Miscellaneous Personal Services (not elsewhere classified)**\n\n `7311` - **Advertising Services**\n\n `7321` - **Consumer Credit Reporting Agencies**\n\n `7332` - **Blueprinting and Photocopying Services**\n\n `7333` - **Commercial Photography, Art and Graphics**\n\n `7338` - **Quick Copy, Reproduction and Blueprinting Services**\n\n `7339` - **Stenographic and Secretarial Support Services**\n\n `7342` - **Exterminating and Disinfecting Services**\n\n `7349` - **Cleaning and Maintenance, Janitorial Services**\n\n `7361` - **Employment Agencies, Temporary Help Services**\n\n `7372` - **Computer Programming, Integrated Systems Design and Data Processing Services**\n\n `7375` - **Information Retrieval Services**\n\n `7379` - **Computer Maintenance and Repair Services, Not Elsewhere Classified**\n\n `7392` - **Management, Consulting, and Public Relations Services**\n\n `7393` - **Protective and Security Services - Including Armored Cars and Guard Dogs**\n\n `7394` - **Equipment Rental and Leasing Services, Tool Rental, Furniture Rental, and Appliance Rental**\n\n `7395` - **Photofinishing Laboratories, Photo Developing**\n\n `7399` - **Business Services, Not Elsewhere Classified**\n\n `7511` - **Truck Stop**\n\n `7512` - **Car Rental Companies (Not Listed Below)**\n\n `7513` - **Truck and Utility Trailer Rentals**\n\n `7519` - **Motor Home and Recreational Vehicle Rentals**\n\n `7523` - **Automobile Parking Lots and Garages**\n\n `7531` - **Automotive Body Repair Shops**\n\n `7534` - **Tire Re-treading and Repair Shops**\n\n `7535` - **Paint Shops - Automotive**\n\n `7538` - **Automotive Service Shops**\n\n `7542` - **Car Washes**\n\n `7549` - **Towing Services**\n\n `7622` - **Radio Repair Shops**\n\n `7623` - **Air Conditioning and Refrigeration Repair Shops**\n\n `7629` - **Electrical And Small Appliance Repair Shops**\n\n `7631` - **Watch, Clock, and Jewelry Repair**\n\n `7641` - **Furniture, Furniture Repair, and Furniture Refinishing**\n\n `7692` - **Welding Repair**\n\n `7699` - **Repair Shops and Related Services - Miscellaneous**\n\n `7800` - **Government-Owned Lotteries**\n\n `7801` - **Government-Licensed On-Line Casinos (On-Line Gambling)**\n\n `7802` - **Government-Licensed Horse/Dog Racing**\n\n `7829` - **Motion Pictures and Video Tape Production and Distribution**\n\n `7832` - **Motion Picture Theaters**\n\n `7841` - **Video Tape Rental Stores**\n\n `7911` - **Dance Halls, Studios and Schools**\n\n `7922` - **Theatrical Producers (Except Motion Pictures), Ticket Agencies**\n\n `7929` - **Bands, Orchestras, and Miscellaneous Entertainers (Not Elsewhere Classified)**\n\n `7932` - **Billiard and Pool Establishments**\n\n `7933` - **Bowling Alleys**\n\n `7941` - **Commercial Sports, Athletic Fields, Professional Sport Clubs, and Sport Promoters**\n\n `7991` - **Tourist Attractions and Exhibits**\n\n `7992` - **Golf Courses - Public**\n\n `7993` - **Video Amusement Game Supplies**\n\n `7994` - **Video Game Arcades/Establishments**\n\n `7995` - **Betting (including Lottery Tickets, Casino Gaming Chips, Off-track Betting and Wagers at Race Tracks)**\n\n `7996` - **Amusement Parks, Carnivals, Circuses, Fortune Tellers**\n\n `7997` - **Membership Clubs (Sports, Recreation, Athletic), Country Clubs, and Private Golf Courses**\n\n `7998` - **Aquariums, Sea-aquariums, Dolphinariums**\n\n `7999` - **Recreation Services (Not Elsewhere Classified)**\n\n `8011` - **Doctors and Physicians (Not Elsewhere Classified)**\n\n `8021` - **Dentists and Orthodontists**\n\n `8031` - **Osteopaths**\n\n `8041` - **Chiropractors**\n\n `8042` - **Optometrists and Ophthalmologists**\n\n `8043` - **Opticians, Opticians Goods and Eyeglasses**\n\n `8044` - **Opticians, Optical Goods, and Eyeglasses (no longer valid for first presentments)**\n\n `8049` - **Podiatrists and Chiropodists**\n\n `8050` - **Nursing and Personal Care Facilities**\n\n `8062` - **Hospitals**\n\n `8071` - **Medical and Dental Laboratories**\n\n `8099` - **Medical Services and Health Practitioners (Not Elsewhere Classified)**\n\n `8111` - **Legal Services and Attorneys**\n\n `8211` - **Elementary and Secondary Schools**\n\n `8220` - **Colleges, Junior Colleges, Universities, and Professional Schools**\n\n `8241` - **Correspondence Schools**\n\n `8244` - **Business and Secretarial Schools**\n\n `8249` - **Vocational Schools and Trade Schools**\n\n `8299` - **Schools and Educational Services (Not Elsewhere Classified)**\n\n `8351` - **Child Care Services**\n\n `8398` - **Charitable and Social Service Organizations**\n\n `8641` - **Civic, Fraternal, and Social Associations**\n\n `8651` - **Political Organizations**\n\n `8661` - **Religious Organizations**\n\n `8675` - **Automobile Associations**\n\n `8699` - **Membership Organizations (Not Elsewhere Classified)**\n\n `8734` - **Testing Laboratories (non-medical)**\n\n `8911` - **Architectural - Engineering and Surveying Services**\n\n `8931` - **Accounting, Auditing, and Bookkeeping Services**\n\n `8999` - **Professional Services (Not Elsewhere Defined)**\n\n `9211` - **Court Costs, including Alimony and Child Support**\n\n `9222` - **Fines**\n\n `9223` - **Bail and Bond Payments**\n\n `9311` - **Tax Payments**\n\n `9399` - **Government Services (Not Elsewhere Classified)**\n\n `9402` - **Postal Services - Government Only**\n\n `9405` - **Intra - Government Transactions**\n\n `9700` - **Automated Referral Service (For Visa Only)**\n\n `9701` - **Visa Credential Service (For Visa Only)**\n\n `9702` - **GCAS Emergency Services (For Visa Only)**\n\n `9950` - **Intra - Company Purchases (For Visa Only)**\n\n
" } ] }, "type": { "allOf": [ { "$ref": "#/$defs/mccType" }, { "description": "Type. Indicates if the Mcc is blacklisted/whitelisted.\n\n
\nValid Values\n\n- `blacklist` - **Indicates if the Mcc is blacklisted.**\n- `whitelist` - **Indicates if the Mcc is whitelisted.**\n\n
" } ] }, "division": { "allOf": [ { "$ref": "#/$defs/mccsModelDivision" }, { "description": "The Division on which this MCC applies." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/mccsModelPartition" }, { "description": "The Partition on which this MCC applies." } ] } } }, "membersModelFacilitator": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/facilitatorsResponse" } ], "description": "This holds the ID of the related facilitator record." }, "membersModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant associated with this Member." }, "membersModelVendor": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/vendorsResponse" } ], "description": "This holds the ID of the related vendor record." }, "membersPoliticallyExposed": { "title": "membersPoliticallyExposed", "enum": [ 0, 1 ], "type": "integer" }, "membersPrimary": { "title": "membersPrimary", "enum": [ 0, 1 ], "type": "integer" }, "membersResponse": { "title": "membersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "merchant": { "allOf": [ { "$ref": "#/$defs/membersModelMerchant" }, { "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
" }, "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" }, "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." }, "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." }, "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." }, "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." } ] }, "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
" } ] }, "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." }, "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
" }, "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." }, "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." }, "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." }, "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" }, "creditScoreDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "Date for Credit Score. The format should be YYYY-MM-DD HH:MM:SS." }, "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." }, "treasuryPrimeRoles": { "type": "string", "description": "[\"signer\", \"control_person\"] Any one of these." }, "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
" }, "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." }, "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." } ] }, "facilitator": { "allOf": [ { "$ref": "#/$defs/membersModelFacilitator" }, { "description": "This holds the ID of the related facilitator record." } ] }, "vendor": { "allOf": [ { "$ref": "#/$defs/membersModelVendor" }, { "description": "This holds the ID of the related vendor record." } ] }, "shareableUrl": { "type": "string", "description": "This is a URL that was used in the Identity Verification for the member. This is a gotten from identity verification through the integration partner." }, "status": { "type": "string", "description": "This is also part of the verification result from the third party that tracks the status of the verification process of the member." }, "createdAt": { "type": "integer", "description": "The timestamp when was createdAt.", "contentEncoding": "int32" }, "completedAt": { "type": "integer", "description": "The timestamp when was completedAt.", "contentEncoding": "int32" }, "plaidIdvId": { "type": "string", "description": "This is the integration ID for the verification response." }, "templateId": { "type": "string", "description": "This is the ID of the template used in the verification process of the member." }, "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
" } ] }, "verifications": { "type": "array", "items": { "$ref": "#/$defs/verificationsResponse" }, "description": "" } } }, "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" }, "merchantPlatformStatusesResponse": { "title": "merchantPlatformStatusesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "merchant": { "type": "string", "description": "The merchant associated with this merchant platform status." }, "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/status" }, { "description": "The status of this merchant platform.\n\n
\nValid Values\n\n- `0` - **Pending.**\n- `1` - **Approved.**\n- `2` - **Failed.**\n\n
" } ] } } }, "merchantResultsResponse": { "title": "merchantResultsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "merchant": { "type": "string", "description": "The merchant associated with this merchant result." }, "type": { "allOf": [ { "$ref": "#/$defs/merchantType" }, { "description": "The type of this merchant result\n\n
\nValid Values\n\n- `general` - **General use for unspecified type.**\n- `internal` - **An internal failure result message.**\n- `data` - **Missing merchant boarding related data failure message.**\n- `legal` - **Result message related to legal matters.**\n- `denial` - **Merchant boarding denial result message.**\n- `platform` - **Processor boarding failure result message.**\n- `platformNote` - **Processor note from merchant boarding.**\n\n
" } ] }, "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
" } ] }, "message": { "type": "string", "description": "The message of this merchant result." }, "boardingProcessID": { "type": "string", "description": "Unique identification number that refers merchant." } } }, "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" }, "merchantType": { "title": "merchantType", "enum": [ "general", "internal", "data", "legal", "denial", "platform", "platformNote" ], "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" }, "merchantsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The Entity associated with this Merchant." }, "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" }, "merchantsPassTokenEnabled": { "title": "merchantsPassTokenEnabled", "enum": [ 0, 1 ], "type": "integer" }, "merchantsResponse": { "title": "merchantsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "lastActivity": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "The date and time on which this Merchant last processed a Transaction. The format should be YYYY-MM-DD HH:MM:SS." }, "totalApprovedSales": { "type": "integer", "description": "Show the total approved amount to this merchant.", "contentEncoding": "int64" }, "entity": { "allOf": [ { "$ref": "#/$defs/merchantsModelEntity" }, { "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
" } ] }, "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
" } ] }, "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
" } ] }, "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
" } ] }, "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" }, "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" }, "amex": { "type": "string", "description": "The American Express merchant identifier for this Merchant, if applicable. \nThis field is stored as a text 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 text 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.", "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
" } ] }, "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
" } ] }, "accountClosureReasonCode": { "type": "string", "description": "The denial or account closure reason code." }, "accountClosureReasonDate": { "type": "integer", "description": "The date the account closure reason code was provided. It should be in YYYYMMDD format", "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" }, "boarded": { "type": "integer", "description": "The date and time on which this Merchant was successfully boarded.", "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 associated with the letter status. The format should be YYYYMMDD.", "contentEncoding": "int32" }, "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
" } ] }, "tmxSessionId": { "type": "string", "description": "Transaction Session Id." }, "chargebackNotificationEmail": { "type": "string", "description": "Notification Email for chargebacks." }, "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
" } ] }, "percentKeyed": { "type": "integer", "description": "The merchant percentage of transactions that are Card Not Present (Includes MOTO and eCommerce).", "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" }, "percentEcomm": { "type": "integer", "description": "This field indicates what percentage are internet originated transactions.", "contentEncoding": "int32" }, "percentBusiness": { "type": "integer", "description": "This field indicates what percentage of the transactions are Business to Business.", "contentEncoding": "int32" }, "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
" } ] }, "applePayStatus": { "type": "string", "description": "The status of Apple Pay for this merchant." }, "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: \"." }, "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." }, "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
" } ] }, "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
" } ] }, "assessments": { "type": "array", "items": { "$ref": "#/$defs/assessmentsResponse" }, "description": "" }, "appleDomains": { "type": "array", "items": { "$ref": "#/$defs/appleDomainsResponse" }, "description": "" }, "batches": { "type": "array", "items": { "$ref": "#/$defs/batchesResponse" }, "description": "" }, "chargebacks": { "type": "array", "items": { "$ref": "#/$defs/chargebacksResponse" }, "description": "" }, "customers": { "type": "array", "items": { "$ref": "#/$defs/customersResponse" }, "description": "" }, "invoices": { "type": "array", "items": { "$ref": "#/$defs/invoicesResponse" }, "description": "" }, "members": { "type": "array", "items": { "$ref": "#/$defs/membersResponse" }, "description": "" }, "merchantPlatformStatuses": { "type": "array", "items": { "$ref": "#/$defs/merchantPlatformStatusesResponse" }, "description": "" }, "merchantResults": { "type": "array", "items": { "$ref": "#/$defs/merchantResultsResponse" }, "description": "" }, "plans": { "type": "array", "items": { "$ref": "#/$defs/plansResponse" }, "description": "" }, "terminals": { "type": "array", "items": { "$ref": "#/$defs/terminalsResponse" }, "description": "" }, "terminalTxns": { "type": "array", "items": { "$ref": "#/$defs/terminalTxnsResponse" }, "description": "" }, "txns": { "type": "array", "items": { "$ref": "#/$defs/txnsResponse" }, "description": "" } } }, "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" }, "messageThreadsModelEntityReturn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entityReturnsResponse" } ], "description": "The identifier of the EntityReturn that is related to this messageThread." }, "messageThreadsModelForlogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the receiving Login of this messageThreads resource." }, "messageThreadsModelHold": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/holdsResponse" } ], "description": "The identifier of the Hold that is related to this messageThread." }, "messageThreadsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this messageThreads resource." }, "messageThreadsModelOpposingMessageThread": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/messageThreadsResponse" } ], "description": "Specifies whether this is the opposing MessageThread." }, "messageThreadsResponse": { "title": "messageThreadsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/messageThreadsModelLogin" }, { "description": "The identifier of the Login that owns this messageThreads resource." } ] }, "forlogin": { "allOf": [ { "$ref": "#/$defs/messageThreadsModelForlogin" }, { "description": "The identifier of the receiving Login of this messageThreads resource." } ] }, "hold": { "allOf": [ { "$ref": "#/$defs/messageThreadsModelHold" }, { "description": "The identifier of the Hold that is related to this messageThread." } ] }, "entityReturn": { "allOf": [ { "$ref": "#/$defs/messageThreadsModelEntityReturn" }, { "description": "The identifier of the EntityReturn that is related to this messageThread." } ] }, "opposingMessageThreads": { "$ref": "#/$defs/messageThreadsResponse" }, "folder": { "type": "string", "description": "Free-form text. By default, a messageThread resource is set as '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/messagesResponse" }, "description": "" }, "opposingMessageThread": { "allOf": [ { "$ref": "#/$defs/messageThreadsModelOpposingMessageThread" }, { "description": "Specifies whether this is the opposing MessageThread." } ] } } }, "messageType": { "title": "messageType", "enum": [ "incoming", "outgoing" ], "type": "string" }, "messagesGenerated": { "title": "messagesGenerated", "enum": [ 0, 1 ], "type": "integer" }, "messagesModelMessageThread": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/messageThreadsResponse" } ], "description": "The identifier of the messageThreads that owns this Messages resource." }, "messagesModelOpposingMessage": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/messagesResponse" } ], "description": "Specifies whether this is the opposingMessage or not." }, "messagesRead": { "title": "messagesRead", "enum": [ 0, 1 ], "type": "integer" }, "messagesResponse": { "title": "messagesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "messageThread": { "allOf": [ { "$ref": "#/$defs/messagesModelMessageThread" }, { "description": "The identifier of the messageThreads that owns this Messages resource." } ] }, "opposingMessage": { "allOf": [ { "$ref": "#/$defs/messagesModelOpposingMessage" }, { "description": "Specifies whether this is the opposingMessage or not." } ] }, "type": { "allOf": [ { "$ref": "#/$defs/messageType" }, { "description": "Whether this resource is incoming or outgoing.\n\n
\nValid Values\n\n- `incoming` - **Incoming messages is assigned.**\n\n- `outgoing` - **Outgoing message is assigned.**\n\n
" } ] }, "generated": { "allOf": [ { "$ref": "#/$defs/messagesGenerated" }, { "description": "Whether this resource was automatically generated or not.\n\n
\nValid Values\n\n- `0` - **Message was automatically generated and a value of '0' means it was manually generated.** \n\n- `1` - **Message was manually generated.** \n\n
" } ] }, "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." }, "opposingMessages": { "$ref": "#/$defs/messagesResponse" } } }, "messagesSecure": { "title": "messagesSecure", "enum": [ 0, 1 ], "type": "integer" }, "minPasswordComplexity": { "title": "minPasswordComplexity", "enum": [ 1, 2, 3, 4 ], "type": "integer" }, "networkTokenIndicator": { "title": "networkTokenIndicator", "enum": [ 0, 1 ], "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" }, "noteDocumentsModelNote": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/notesResponse" } ], "description": "The identifier of the Note that owns this note documents resource." }, "noteDocumentsResponse": { "title": "noteDocumentsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "note": { "allOf": [ { "$ref": "#/$defs/noteDocumentsModelNote" }, { "description": "The identifier of the Note that owns this note documents resource." } ] }, "custom": { "type": "string", "description": "The identifier of the Custom that relates to this notes 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
" } ] }, "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
" } ] }, "name": { "type": "string", "description": "The name of the document on the referenced NoteDocument." }, "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
" } ] }, "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" }, "notesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that relates to this notes resource." }, "notesModelHold": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/holdsResponse" } ], "description": "The identifier of the Hold that relates to this notes resource." }, "notesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this notes resource." }, "notesModelTerminalTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/terminalTxnsResponse" } ], "description": "The identifier of the TerminalTxn that relates to this notes resource." }, "notesModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the Txn that relates to this notes resource." }, "notesResponse": { "title": "notesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/notesModelLogin" }, { "description": "The identifier of the Login that owns this notes resource." } ] }, "hold": { "allOf": [ { "$ref": "#/$defs/notesModelHold" }, { "description": "The identifier of the Hold that relates to this notes resource." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/notesModelTxn" }, { "description": "The identifier of the Txn that relates to this notes resource." } ] }, "terminalTxn": { "allOf": [ { "$ref": "#/$defs/notesModelTerminalTxn" }, { "description": "The identifier of the TerminalTxn that relates to this notes resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/notesModelEntity" }, { "description": "The identifier of the Entity that relates to this notes resource." } ] }, "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
" } ] }, "note": { "type": "string", "description": "A Message/Note regarding this notes resource. \nThis field is stored as a text string." }, "data": { "type": "string", "description": "Free-form text for adding a message along with the type." }, "pinned": { "type": "integer", "description": "Flag to determine if a note has been pinned or not..", "contentEncoding": "int32" }, "pinnedDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$", "type": "string", "description": "The timestamp indicating the date and time when a note was pinned. The format should be YYYY-MM-DD HH:MM: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
" } ] }, "noteDocuments": { "type": "array", "items": { "$ref": "#/$defs/noteDocumentsResponse" }, "description": "" } } }, "omniTokensModelDeleter": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the User who deleted the omniToken." }, "omniTokensModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division that omniTokens is associated to." }, "omniTokensModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this omniTokens is associated to." }, "omniTokensModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org (group) that omniTokens is associated to." }, "omniTokensModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition that omniTokens is associated to." }, "omniTokensResponse": { "title": "omniTokensResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "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": { "allOf": [ { "$ref": "#/$defs/omniTokensModelOrg" }, { "description": "The identifier of the Org (group) that omniTokens is associated to." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/omniTokensModelDivision" }, { "description": "The identifier of the Division that omniTokens is associated to." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/omniTokensModelPartition" }, { "description": "The identifier of the Partition that omniTokens is associated to." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/omniTokensModelEntity" }, { "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": { "allOf": [ { "$ref": "#/$defs/omniTokensModelDeleter" }, { "description": "The identifier of the User who deleted the omniToken." } ] } } }, "orgEntitiesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this orgEntity is associated with." }, "orgEntitiesModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org that this orgEntity is associated with." }, "orgEntitiesResponse": { "title": "orgEntitiesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "org": { "allOf": [ { "$ref": "#/$defs/orgEntitiesModelOrg" }, { "description": "The identifier of the Org that this orgEntity is associated with." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/orgEntitiesModelEntity" }, { "description": "The identifier of the Entity that this orgEntity is associated with." } ] } } }, "orgFlowAction": { "title": "orgFlowAction", "enum": [ "add", "remove" ], "type": "string" }, "orgFlowActionsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org resource that this orgFlowActions resource is associated with." }, "orgFlowActionsModelOrgFlow": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgFlowsResponse" } ], "description": "The identifier of the OrgFlow resource that this orgFlowActions resource is associated with." }, "orgFlowActionsResponse": { "title": "orgFlowActionsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "orgFlow": { "allOf": [ { "$ref": "#/$defs/orgFlowActionsModelOrgFlow" }, { "description": "The identifier of the OrgFlow resource that this orgFlowActions resource is associated with." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/orgFlowActionsModelOrg" }, { "description": "The identifier of the Org 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
" } ] } } }, "orgFlowRulesModelOrgFlow": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgFlowsResponse" } ], "description": "The identifier of the orgFlow resource that this orgFlowActions resource is associated with." }, "orgFlowRulesResponse": { "title": "orgFlowRulesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "orgFlow": { "allOf": [ { "$ref": "#/$defs/orgFlowRulesModelOrgFlow" }, { "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
" } ] } } }, "orgFlowRulesType": { "title": "orgFlowRulesType", "enum": [ "MCC", "Custom" ], "type": "string" }, "orgFlowTrigger": { "title": "orgFlowTrigger", "enum": [ "create", "low", "high", "board" ], "type": "string" }, "orgFlowsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division resource for which this orgFlows resource is triggered." }, "orgFlowsModelForlogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login resource for which this orgFlows resource is triggered." }, "orgFlowsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "orgFlowsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition resource for which this orgFlows resource is triggered." }, "orgFlowsModelTeam": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/teamsResponse" } ], "description": "The identifier of the Team resource for which this orgFlows resource is triggered." }, "orgFlowsResponse": { "title": "orgFlowsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/orgFlowsModelLogin" }, { "description": "The Login that owns this resource." } ] }, "forlogin": { "allOf": [ { "$ref": "#/$defs/orgFlowsModelForlogin" }, { "description": "The identifier of the Login resource for which this orgFlows resource is triggered." } ] }, "team": { "allOf": [ { "$ref": "#/$defs/orgFlowsModelTeam" }, { "description": "The identifier of the Team resource for which this orgFlows resource is triggered." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/orgFlowsModelDivision" }, { "description": "The identifier 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": { "allOf": [ { "$ref": "#/$defs/orgFlowsModelPartition" }, { "description": "The identifier of the Partition resource for which this orgFlows resource is triggered." } ] }, "orgFlowActions": { "type": "array", "items": { "$ref": "#/$defs/orgFlowActionsResponse" }, "description": "" }, "orgFlowRules": { "type": "array", "items": { "$ref": "#/$defs/orgFlowRulesResponse" }, "description": "" } } }, "orgsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this Org." }, "orgsResponse": { "title": "orgsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/orgsModelLogin" }, { "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." }, "defaultFeeFromEntity": { "type": "string", "description": "This is used to specify a default fee for a group." }, "aggregations": { "type": "array", "items": { "$ref": "#/$defs/aggregationsResponse" }, "description": "" }, "billingModifiers": { "type": "array", "items": { "$ref": "#/$defs/billingModifiersResponse" }, "description": "" }, "billings": { "type": "array", "items": { "$ref": "#/$defs/billingsResponse" }, "description": "" }, "decisions": { "type": "array", "items": { "$ref": "#/$defs/decisionsResponse" }, "description": "" }, "embeddedFinance": { "type": "array", "items": { "$ref": "#/$defs/embeddedFinanceResponse" }, "description": "" }, "feeModifiers": { "type": "array", "items": { "$ref": "#/$defs/feeModifiersResponse" }, "description": "" }, "fees": { "type": "array", "items": { "$ref": "#/$defs/feesResponse" }, "description": "" }, "invoiceParameters": { "type": "array", "items": { "$ref": "#/$defs/invoiceParametersResponse" }, "description": "" }, "orgEntities": { "type": "array", "items": { "$ref": "#/$defs/orgEntitiesResponse" }, "description": "" }, "omniTokens": { "type": "array", "items": { "$ref": "#/$defs/omniTokensResponse" }, "description": "" }, "payoutFlows": { "type": "array", "items": { "$ref": "#/$defs/payoutFlowsResponse" }, "description": "" }, "profitShares": { "type": "array", "items": { "$ref": "#/$defs/profitSharesResponse" }, "description": "" }, "reserves": { "type": "array", "items": { "$ref": "#/$defs/reservesResponse" }, "description": "" }, "revenueBoosts": { "type": "array", "items": { "$ref": "#/$defs/revenueBoostsResponse" }, "description": "" }, "secrets": { "type": "array", "items": { "$ref": "#/$defs/secretsResponse" }, "description": "" }, "saferPayments": { "type": "array", "items": { "$ref": "#/$defs/saferPaymentsResponse" }, "description": "" } } }, "originalEntryEvent": { "title": "originalEntryEvent", "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, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 101, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 601, 602, 603, 604, 605, 606, 607, 608 ], "type": "integer" }, "parametersAccountUpdaterEnabled": { "title": "parametersAccountUpdaterEnabled", "enum": [ 0, 1, 2 ], "type": "integer" }, "parametersAmex3dsEnabled": { "title": "parametersAmex3dsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersAmexEnabled": { "title": "parametersAmexEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersApplePayEnabled": { "title": "parametersApplePayEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersAutoTaxExemptEnabled": { "title": "parametersAutoTaxExemptEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersBankAccountAddStopEmail": { "title": "parametersBankAccountAddStopEmail", "enum": [ 0, 1 ], "type": "integer" }, "parametersBoardingDisabled": { "title": "parametersBoardingDisabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersBoardingExemptionsDisabled": { "title": "parametersBoardingExemptionsDisabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersDebtRepaymentEnabled": { "title": "parametersDebtRepaymentEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersDecisionMicroserviceEnabled": { "title": "parametersDecisionMicroserviceEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersDeclineNotificationEmail": { "title": "parametersDeclineNotificationEmail", "enum": [ 0, 1 ], "type": "integer" }, "parametersDiscover3dsEnabled": { "title": "parametersDiscover3dsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersDiscoverAcquiredEnabled": { "title": "parametersDiscoverAcquiredEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersDiscoverEnabled": { "title": "parametersDiscoverEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersECheckEnabled": { "title": "parametersECheckEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersFundingEnabled": { "title": "parametersFundingEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersGetParametersEnabled": { "title": "parametersGetParametersEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersGooglePayEnabled": { "title": "parametersGooglePayEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersHoldMessagesDisabled": { "title": "parametersHoldMessagesDisabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersLoginAsEnabled": { "title": "parametersLoginAsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersMc3dsEnabled": { "title": "parametersMc3dsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersMcInstantPayoutsEnabled": { "title": "parametersMcInstantPayoutsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersMfaEnabled": { "title": "parametersMfaEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersNegativeBalanceEmail": { "title": "parametersNegativeBalanceEmail", "enum": [ 0, 1 ], "type": "integer" }, "parametersOmniTokenEnabled": { "title": "parametersOmniTokenEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersOptBlueEnabled": { "title": "parametersOptBlueEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersPassTokenEnabled": { "title": "parametersPassTokenEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersPayoutAdjustSubcents": { "title": "parametersPayoutAdjustSubcents", "enum": [ 0, 1 ], "type": "integer" }, "parametersPayoutDelayIncludeOffDays": { "title": "parametersPayoutDelayIncludeOffDays", "enum": [ 0, 1 ], "type": "integer" }, "parametersPayoutIncludePending": { "title": "parametersPayoutIncludePending", "enum": [ 0, 1 ], "type": "integer" }, "parametersPortalAccessEnabled": { "title": "parametersPortalAccessEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersPositiveBalanceEmail": { "title": "parametersPositiveBalanceEmail", "enum": [ 0, 1 ], "type": "integer" }, "parametersResponse": { "title": "parametersResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "type": "string", "description": "The Login that owns this resource." }, "org": { "type": "string", "description": "The identifier of the Org resource that this Parameter resource is associated with." }, "division": { "type": "string", "description": "The identifier of the Division resource that this Parameter resource is associated with." }, "partition": { "type": "string", "description": "The identifier of the Partition resource that this Parameter resource is associated with." }, "minTxnTotal": { "type": "integer", "description": "The minimum allowed Transaction total. \nThis field is specified as an integer in cents. \nThe default setting is to have no minimum total.", "contentEncoding": "int64" }, "maxTxnTotal": { "type": "integer", "description": "The maximum allowed Transaction total. \nThis field is specified as an integer in cents. \nThe default setting is to have no maximum total.", "contentEncoding": "int64" }, "maxTxnDailyTotal": { "type": "integer", "description": "The maximum allowed Transaction total in any single day. \nThis field is specified as an integer in cents. \nThe default setting is to have no maximum total.", "contentEncoding": "int64" }, "maxTxnDailyNum": { "type": "integer", "description": "The highest daily number of Sale, eCheck Sale and Capture transactions.", "contentEncoding": "int64" }, "maxTxnMonthlyTotal": { "type": "integer", "description": "The maximum allowed Transaction total in any single month. \nThis field is specified as an integer in cents. \nThe default setting is to have no maximum total.", "contentEncoding": "int64" }, "maxTxnMonthlyNum": { "type": "integer", "description": "The maximum allowed number of Transactions in any single month. \nThe default setting is to have no maximum total.", "contentEncoding": "int64" }, "maxSubscriptionFailures": { "type": "integer", "description": "The highest amount of consecutive failures for a subscription payment before it is automatically inactivated.", "contentEncoding": "int32" }, "minPayoutCreditTotal": { "type": "integer", "description": "The minimum allowed Payout Credit total. \nThis field is specified as an integer in cents. \nThe default setting is 1 cent.", "contentEncoding": "int64" }, "maxPayoutCreditTotal": { "type": "integer", "description": "The maximum allowed Payout Credit total. \nThis field is specified as an integer in cents. \nThe default setting is to have no maximum total.", "contentEncoding": "int64" }, "minPayoutDebitTotal": { "type": "integer", "description": "The minimum allowed Payout Debit total. \nThis field is specified as a negative integer in cents. \nThe default setting is -1 cent.", "contentEncoding": "int64" }, "maxPayoutDebitTotal": { "type": "integer", "description": "The maximum allowed Payout Debit total. \nThis field is specified as an integer in cents.", "contentEncoding": "int64" }, "minAvailableFunds": { "type": "integer", "description": "The minimum available funds that the Payout's entity needs to have to payout. \nThis field is specified as an +/- integer in cents. \nThe default setting is null.", "contentEncoding": "int64" }, "minStatementDebitPayoutDelay": { "type": "integer", "description": "The minimum allowed number of days to delay statement debit Payouts by. \nThe default setting is 5.", "contentEncoding": "int64" }, "minFundsPayoutTotal": { "type": "integer", "description": "The minimum total debit allowed. \nThis field is specified as an integer in cents. \nThe default setting is 500.", "contentEncoding": "int64" }, "minPayoutDelay": { "type": "integer", "description": "The minimum allowed number of days to delay Payouts by. \nThe default setting is 3.", "contentEncoding": "int64" }, "minFirstPayoutDelay": { "type": "integer", "description": "The minimum amount of days to delay processing of a requested payout for the first payout to an entity.", "contentEncoding": "int64" }, "payoutAdjustSubcents": { "allOf": [ { "$ref": "#/$defs/parametersPayoutAdjustSubcents" }, { "description": "Whether a payout will process sub-cents as an adjustment (defaults to no).\n\n
\nValid Values\n\n- `0` - **No**\n- `1` - **Yes**\n\n
" } ] }, "payoutDelayIncludeOffDays": { "allOf": [ { "$ref": "#/$defs/parametersPayoutDelayIncludeOffDays" }, { "description": "Whether the API should count weekends and holidays towards the number of days in the payout delay (defaults to no).\n\n
\nValid Values\n\n- `0` - **No**\n- `1` - **Yes**\n\n
" } ] }, "payoutIncludePending": { "allOf": [ { "$ref": "#/$defs/parametersPayoutIncludePending" }, { "description": "Whether a payout will be processed if there's enough pending funds to cover the negative available.\n\n
\nValid Values\n\n- `0` - **OFF**\n- `1` - **ON**\n\n
" } ] }, "amexEnabled": { "allOf": [ { "$ref": "#/$defs/parametersAmexEnabled" }, { "description": "Whether American Express processing should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "optBlueEnabled": { "allOf": [ { "$ref": "#/$defs/parametersOptBlueEnabled" }, { "description": "Whether American Express OptBlue should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "discoverEnabled": { "allOf": [ { "$ref": "#/$defs/parametersDiscoverEnabled" }, { "description": "Whether Discover processing should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "discoverAcquiredEnabled": { "allOf": [ { "$ref": "#/$defs/parametersDiscoverAcquiredEnabled" }, { "description": "Whether a new Discover ID should be created.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "mc3dsEnabled": { "allOf": [ { "$ref": "#/$defs/parametersMc3dsEnabled" }, { "description": "Whether MasterCard 3DSecure processing should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "visa3dsEnabled": { "allOf": [ { "$ref": "#/$defs/parametersVisa3dsEnabled" }, { "description": "Whether Visa 3DSecure processing should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "amex3dsEnabled": { "allOf": [ { "$ref": "#/$defs/parametersAmex3dsEnabled" }, { "description": "Whether Amex 3DSecure processing should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "discover3dsEnabled": { "allOf": [ { "$ref": "#/$defs/parametersDiscover3dsEnabled" }, { "description": "Whether Discover 3DSecure processing should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "eCheckEnabled": { "allOf": [ { "$ref": "#/$defs/parametersECheckEnabled" }, { "description": "Whether eCheck processing should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "fundingEnabled": { "allOf": [ { "$ref": "#/$defs/parametersFundingEnabled" }, { "description": "Whether Payouts should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "debtRepaymentEnabled": { "allOf": [ { "$ref": "#/$defs/parametersDebtRepaymentEnabled" }, { "description": "Whether debt repayment for transactions is enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "verifyDisabled": { "allOf": [ { "$ref": "#/$defs/parametersVerifyDisabled" }, { "description": "Whether bank account verification requirements should be disabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "verifyForBoardingNotRequired": { "allOf": [ { "$ref": "#/$defs/parametersVerifyForBoardingNotRequired" }, { "description": "Whether the requirement to verify a Merchant's bank account before boarding should be disabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "verifyForPayoutNotRequired": { "allOf": [ { "$ref": "#/$defs/parametersVerifyForPayoutNotRequired" }, { "description": "Whether the requirement to verify a Merchant's bank account before making a Payout should be disabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "refundReleasesReserve": { "allOf": [ { "$ref": "#/$defs/refundReleaseReserve" }, { "description": "Whether a refund Transaction should cause any reserved funds in the related Transaction to be released.\n\n
\nValid Values\n\n- `0` - **False**\n- `1` - **True**\n\n
" } ] }, "vendorFeesEnabled": { "allOf": [ { "$ref": "#/$defs/vendorFeesEnabled" }, { "description": "Whether third parties can charge fees. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "vendorFeesExternal": { "allOf": [ { "$ref": "#/$defs/vendorFeesExternal" }, { "description": "Whether any third-party fees that are incurred are settled from an external account. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **False**\n- `1` - **True**\n\n
" } ] }, "visaMisuseSettlement": { "type": "integer", "description": "The number of days before an Auth Misuse fee should be charged on a VISA txn that has not settled. \nThe default setting is 10.", "contentEncoding": "int32" }, "visaMisuseTravelAutoSettlement": { "type": "integer", "description": "The number of days before an Auth Misuse fee should be charged on a VISA txn that has not settled. Applies only to merchants with a Travel & Entertainment mcc. \nThe default setting is 20.", "contentEncoding": "int32" }, "visaMisuseCardPresentReversal": { "type": "integer", "description": "The number of hours before an Auth Misuse fee should be charged on a card present VISA txn that wasn't reversed within the timeframe. \nThe default setting is 24.", "contentEncoding": "int32" }, "visaMisuseCardNotPresentReversal": { "type": "integer", "description": "The number of hours before an Auth Misuse fee should be charged on a card not present VISA txn that wasn't reversed within the timeframe. \nThe default setting is 168.", "contentEncoding": "int32" }, "mcMisuseSettlement": { "type": "integer", "description": "The number of days before an Auth Misuse fee should be charged on a MasterCard txn that has not settled. \nThe default setting is 120.", "contentEncoding": "int32" }, "minEcheckCaptureDelay": { "type": "integer", "description": "Number of days after which to process (capture) eCheck sales. Will delay the funding and fees until the specified days from date of creation.", "contentEncoding": "int32" }, "minDebitProcessingDelay": { "type": "integer", "description": "Minimum number of business days before a debit is processed and made available for funding. \nThe default setting is 5.", "contentEncoding": "int32" }, "minBoardingOwnership": { "type": "integer", "description": "Minimum required total ownership of members for boarding. \nThe default setting is '0'.", "contentEncoding": "int32" }, "boardingExemptionsDisabled": { "allOf": [ { "$ref": "#/$defs/parametersBoardingExemptionsDisabled" }, { "description": "Whether FinCen boarding exemptions should be disabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "mcMisuseCardPresentReversal": { "type": "integer", "description": "The number of hours before an Auth Misuse fee should be charged on a card present MasterCard txn that wasn't reversed within the timeframe. \nThe default setting is 24.", "contentEncoding": "int32" }, "mcMisuseCardNotPresentReversal": { "type": "integer", "description": "The number of hours before an Auth Misuse fee should be charged on a card not present MasterCard txn that wasn't reversed within the timeframe. \nThe default setting is 72.", "contentEncoding": "int32" }, "mcMisuseTravelAutoReversal": { "type": "integer", "description": "The number of hours before an Auth Misuse fee should be charged on a MasterCard txn that wasn't reversed within the timeframe. Applies only to merchants with a Travel & Entertainment mcc. \nThe default setting is 480.", "contentEncoding": "int32" }, "boardingDisabled": { "allOf": [ { "$ref": "#/$defs/parametersBoardingDisabled" }, { "description": "Whether boarding for an entity is enabled or disabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "autoReboardDays": { "type": "integer", "description": "Number of days after a merchant's created date to attempt a reboard on a not yet boarded merchant. The default setting is `60`.", "contentEncoding": "int32" }, "autoTaxExemptEnabled": { "allOf": [ { "$ref": "#/$defs/parametersAutoTaxExemptEnabled" }, { "description": "Whether to assume a transaction is tax-exempt if no tax is set for Level II processing. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "surchargeEnabled": { "allOf": [ { "$ref": "#/$defs/parametersSurchargeEnabled" }, { "description": "Whether it is allowed to use a surcharge on transactions. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "mcInstantPayoutsEnabled": { "allOf": [ { "$ref": "#/$defs/parametersMcInstantPayoutsEnabled" }, { "description": "Whether MasterCard instant payouts should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "visaInstantPayoutsEnabled": { "allOf": [ { "$ref": "#/$defs/parametersVisaInstantPayoutsEnabled" }, { "description": "Whether Visa Instant Payout should be enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "sameDayPayoutsEnabled": { "allOf": [ { "$ref": "#/$defs/parametersSameDayPayoutsEnabled" }, { "description": "Whether same day account payout is enabled.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "applePayEnabled": { "allOf": [ { "$ref": "#/$defs/parametersApplePayEnabled" }, { "description": "Whether Apple Pay is enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "googlePayEnabled": { "allOf": [ { "$ref": "#/$defs/parametersGooglePayEnabled" }, { "description": "Whether Google Pay is enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "sameDayPayoutsDailyMax": { "type": "integer", "description": "Maximum allowed total for same day payouts daily.", "contentEncoding": "int64" }, "minSameDayPayoutCreditTotal": { "type": "integer", "description": "Minimum allowed total for same day payout credit total.", "contentEncoding": "int64" }, "maxSameDayPayoutCreditTotal": { "type": "integer", "description": "Maximum allowed total for same day payout credit total.", "contentEncoding": "int64" }, "minSameDayPayoutDebitTotal": { "type": "integer", "description": "Minimum allowed total for same day payout credit total.", "contentEncoding": "int64" }, "maxSameDayPayoutDebitTotal": { "type": "integer", "description": "Maximum allowed total for same day payout credit total.", "contentEncoding": "int64" }, "accountUpdaterEnabled": { "allOf": [ { "$ref": "#/$defs/parametersAccountUpdaterEnabled" }, { "description": "Indicates whether the Account Updater is enabled and states which platform it will use to send the payment update files.\nThe default setting is 0 (Not Enabled)\n\n
\n Valid Values\n\n - `0` - **Not Enabled**\n - `1` - **Enabled for VAP AU.**\n - `2` - **Enabled for VCORE AU.**\n\n
" } ] }, "updateAllTokensEnabled": { "allOf": [ { "$ref": "#/$defs/parametersUpdateAllTokensEnabled" }, { "description": "Whether all tokenized payments will be checked for updates. Tokenized payments will be checked and updated if enabled. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "accountUpdaterFrequency": { "type": "integer", "description": "The frequency for which to check for payment updates. \nThe default setting is 30.", "contentEncoding": "int32" }, "minDebitedAvailableFunds": { "type": "integer", "description": "The level to restore the funds to. \nThe default setting is '0'.", "contentEncoding": "int64" }, "getParametersEnabled": { "allOf": [ { "$ref": "#/$defs/parametersGetParametersEnabled" }, { "description": "Whether it is allowed to return the parameters of this entity. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "payoutCutoffTime": { "type": "integer", "description": "The cutoff time for making a single payment.", "contentEncoding": "int32" }, "declineNotificationEmail": { "allOf": [ { "$ref": "#/$defs/parametersDeclineNotificationEmail" }, { "description": "Whether merchant boarding decline will generate a notification email to the members.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "decisionMicroserviceEnabled": { "allOf": [ { "$ref": "#/$defs/parametersDecisionMicroserviceEnabled" }, { "description": "Whether we will run verifications with decision microservice or old API decision service.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "holdMessagesDisabled": { "allOf": [ { "$ref": "#/$defs/parametersHoldMessagesDisabled" }, { "description": "Whether we will disable creating messages for holds.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "txnDecisionMicroserviceEnabled": { "allOf": [ { "$ref": "#/$defs/parametersTxnDecisionMicroserviceEnabled" }, { "description": "Whether we will run verifications with decision microservice or old API decision service for transactions.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "omniTokenEnabled": { "allOf": [ { "$ref": "#/$defs/parametersOmniTokenEnabled" }, { "description": "Whether it is allowed to use Omni Token. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "passTokenEnabled": { "allOf": [ { "$ref": "#/$defs/parametersPassTokenEnabled" }, { "description": "Whether it is allowed to use Pass Token. The default setting is `0`.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "debitGracePeriod": { "type": "integer", "description": "Limit of the days a merchant can still with negative funds before we do the negative disbursement.", "contentEncoding": "int32" }, "negativeBalanceLimit": { "type": "integer", "description": "Maximum amount the merchant can go negative before we do the negative disbursement.", "contentEncoding": "int64" }, "negativeBalanceEmail": { "allOf": [ { "$ref": "#/$defs/parametersNegativeBalanceEmail" }, { "description": "Controls whether an email is sent when an entity reaches a negative balance. The default setting is 0.\n
\nValid Values\n\n- `0` - **Disabled.**\n- `1` - **Enabled.**\n\n
" } ] }, "positiveBalanceEmail": { "allOf": [ { "$ref": "#/$defs/parametersPositiveBalanceEmail" }, { "description": "Will dictate whether an email is sent when an entity recovers from a negative balance. The default setting is 0.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "loginAsEnabled": { "allOf": [ { "$ref": "#/$defs/parametersLoginAsEnabled" }, { "description": "Will dictate whether a login will have login as access or not by default.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "mfaEnabled": { "allOf": [ { "$ref": "#/$defs/parametersMfaEnabled" }, { "description": "Will dictate whether a login will have MFA turned on or not by default.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "portalAccessEnabled": { "allOf": [ { "$ref": "#/$defs/parametersPortalAccessEnabled" }, { "description": "Will dictate whether a login will have portal access or not by default.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "bankAccountAddStopEmail": { "allOf": [ { "$ref": "#/$defs/parametersBankAccountAddStopEmail" }, { "description": "Email notification to the business email when a new bank account record is created.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "bankAccountUpdateStopEmail": { "allOf": [ { "$ref": "#/$defs/bankAccountUpdateStopEmail" }, { "description": "Email notification to the business email when an existing bank account record is updated.\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
" } ] } } }, "parametersSameDayPayoutsEnabled": { "title": "parametersSameDayPayoutsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersSurchargeEnabled": { "title": "parametersSurchargeEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersTxnDecisionMicroserviceEnabled": { "title": "parametersTxnDecisionMicroserviceEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersUpdateAllTokensEnabled": { "title": "parametersUpdateAllTokensEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersVerifyDisabled": { "title": "parametersVerifyDisabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersVerifyForBoardingNotRequired": { "title": "parametersVerifyForBoardingNotRequired", "enum": [ 0, 1 ], "type": "integer" }, "parametersVerifyForPayoutNotRequired": { "title": "parametersVerifyForPayoutNotRequired", "enum": [ 0, 1 ], "type": "integer" }, "parametersVisa3dsEnabled": { "title": "parametersVisa3dsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "parametersVisaInstantPayoutsEnabled": { "title": "parametersVisaInstantPayoutsEnabled", "enum": [ 0, 1 ], "type": "integer" }, "partitionNoEmailConfirmation": { "title": "partitionNoEmailConfirmation", "enum": [ 0, 1 ], "type": "integer" }, "partitionNoHoldEmail": { "title": "partitionNoHoldEmail", "enum": [ 0, 1 ], "type": "integer" }, "partitionsResponse": { "title": "partitionsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "type": "string", "description": "The Login that owns this resource." }, "name": { "type": "string", "description": "The name of this Partition. \nThis field is stored as a text string and must be between 0 and 50 characters long." }, "email": { "type": "string", "description": "The email address that the API should send email notifications from when processing requests in this Partition. \nThis field is stored as a text string and must be between 1 and 100 characters long." }, "minPasswordLength": { "type": "integer", "description": "The minimum number of characters that all passwords used in this Partition must have. \nThis field is specified as an integer. \nThe value must be between 8 and 16.", "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
" } ] }, "minPasswordHistory": { "type": "integer", "description": "The minimum number of previous passwords that the current password must be distinct from.\nThis field is specified as an integer. The value must be between 3 and 12.", "contentEncoding": "int32" }, "noEmailConfirmation": { "allOf": [ { "$ref": "#/$defs/partitionNoEmailConfirmation" }, { "description": "Whether to disable the email address confirmation process for this Partition.\n\n
\nValid Values\n\n- `0` - **Disabled**\n- `1` - **Enabled**\n\n
" } ] }, "noHoldEmail": { "allOf": [ { "$ref": "#/$defs/partitionNoHoldEmail" }, { "description": "Whether to disable email notification for automated hold messages.\n\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
" } ] }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency in which an entity should board. See Currency codes for all valid values." } ] } } }, "paymentExpirationUpdated": { "title": "paymentExpirationUpdated", "enum": [ 0, 1 ], "type": "integer" }, "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" }, "paymentModelBin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/binsResponse" } ], "description": "Bin identifier for this payment." }, "paymentNumberUpdatedModel": { "title": "paymentNumberUpdatedModel", "enum": [ 0, 1 ], "type": "integer" }, "paymentResponse": { "title": "paymentResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "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." }, "routing": { "type": "string", "description": "The routing code for the eCheck or bank account payment associated with this Transaction." }, "bin": { "allOf": [ { "$ref": "#/$defs/paymentModelBin" }, { "description": "Bin identifier for this payment." } ] }, "payment": { "type": "string" }, "lastChecked": { "type": [ "integer", "null" ], "description": "Times timestamp with last time payment was checked.", "contentEncoding": "int32" }, "last4": { "type": "string" }, "mask": { "type": [ "string", "null" ] }, "plaidConsumerAccount": { "type": [ "string", "null" ] } } }, "paymentUpdateGroupsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this resource belongs to." }, "paymentUpdateGroupsResponse": { "title": "paymentUpdateGroupsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/paymentUpdateGroupsModelEntity" }, { "description": "The identifier of the Entity that this resource belongs to." } ] }, "processing": { "type": "integer", "description": "Whether payment is processing.", "contentEncoding": "int32" }, "processed": { "type": "integer", "description": "Whether payment is processed.", "contentEncoding": "int32" }, "numberUpdated": { "allOf": [ { "$ref": "#/$defs/paymentNumberUpdatedModel" }, { "description": "Whether payment number changes.\n\n
\nValid Values\n\n- `0` - **Not Updated**\n- `1` - **Updated**\n\n
" } ] }, "expirationUpdated": { "allOf": [ { "$ref": "#/$defs/paymentExpirationUpdated" }, { "description": "Whether token expiration date changes.\n\n
\nValid Values\n\n- `0` - **Not Updated**\n- `1` - **Updated**\n\n
" } ] }, "payment": { "$ref": "#/$defs/paymentResponse" }, "paymentUpdates": { "type": "array", "items": { "$ref": "#/$defs/paymentUpdatesResponse" }, "description": "" } } }, "paymentUpdateStatus": { "title": "paymentUpdateStatus", "enum": [ "pending", "processing", "failed", "processed" ], "type": "string" }, "paymentUpdatesModelAccount": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/accountsResponse" } ], "description": "The account associated with this Payment being updated. Used for instant funding payouts." }, "paymentUpdatesModelPayment": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/paymentResponse" } ], "description": "The payment associated with this PaymentUpdate." }, "paymentUpdatesModelPaymentUpdateGroup": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/paymentUpdateGroupsResponse" } ], "description": "The PaymentGroup resource that this PaymentUpdate belongs to." }, "paymentUpdatesModelToken": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/tokensResponse" } ], "description": "The ID of the token record to associate with this terminal activation request." }, "paymentUpdatesResponse": { "title": "paymentUpdatesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "paymentUpdateGroup": { "allOf": [ { "$ref": "#/$defs/paymentUpdatesModelPaymentUpdateGroup" }, { "description": "The PaymentGroup resource that this PaymentUpdate belongs to." } ] }, "payment": { "allOf": [ { "$ref": "#/$defs/paymentUpdatesModelPayment" }, { "description": "The payment associated with this PaymentUpdate." } ] }, "status": { "allOf": [ { "$ref": "#/$defs/paymentUpdateStatus" }, { "description": "The status of the payment update.\n\n
\nValid Values\n\n- `pending` - **The Payment Update was sent and is pending to be processed.**\n- `processing` - **The Payment Update was received and is processing.**\n- `failed` - **The Payment Update has failed.**\n- `processed` - **The Payment Update was processed.**\n\n
" } ] }, "token": { "allOf": [ { "$ref": "#/$defs/paymentUpdatesModelToken" }, { "description": "The ID of the token record to associate with this terminal activation request." } ] }, "account": { "allOf": [ { "$ref": "#/$defs/paymentUpdatesModelAccount" }, { "description": "The account associated with this Payment being updated. Used for instant funding payouts." } ] }, "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
" } ] }, "ref": { "type": "string", "description": "A platform reference for this PaymentUpdate. This field is stored as a text string and must be between 0 and 50 characters long." }, "clientRef": { "type": "string", "description": "An internally generated reference for this PaymentUpdate. This field is stored as a text string and must be between 1 and 50 characters long." }, "message": { "type": "string", "description": "The message with details about the outcome of the paymentUpdate. This field is stored as a text string and must be between 0 and 500 characters long." }, "expiration": { "type": "string", "description": "The expiration number of the payment being updated, 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." } } }, "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" }, "payoutFlowsModelBilling": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/billingsResponse" } ], "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." }, "payoutFlowsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division in which entities will have automated payouts generated." }, "payoutFlowsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this payoutFlow applies to." }, "payoutFlowsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "payoutFlowsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "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." }, "payoutFlowsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition in which entities will have automated payouts generated." }, "payoutFlowsModelPayoutLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that will own the Payout resource. When set to null, the Payout resource will be owned by the triggerring Entity." }, "payoutFlowsResponse": { "title": "payoutFlowsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/payoutFlowsModelLogin" }, { "description": "The Login that owns this resource." } ] }, "payoutLogin": { "allOf": [ { "$ref": "#/$defs/payoutFlowsModelPayoutLogin" }, { "description": "The Login that will own the Payout resource. When set to null, the Payout resource will be owned by the triggerring Entity." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/payoutFlowsModelOrg" }, { "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." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/payoutFlowsModelDivision" }, { "description": "The identifier of the Division in which entities will have automated payouts generated." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/payoutFlowsModelPartition" }, { "description": "The identifier of the Partition in which entities will have automated payouts generated." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/payoutFlowsModelEntity" }, { "description": "The identifier of the Entity that this payoutFlow applies to." } ] }, "billing": { "allOf": [ { "$ref": "#/$defs/payoutFlowsModelBilling" }, { "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" }, "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" }, "minimum": { "type": "integer", "description": "The minium amout of payout that will process.", "contentEncoding": "int64" }, "secondaryDescriptor": { "type": "string", "description": "The secondary billing descriptor to appear on the bank statements in which entities will have automated payouts generated." }, "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
" } ] }, "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
" } ] }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The identifier of a currency that this PayoutFlow is associated with. This field is optional and there is no currency restriction for the PayoutFlow if it's not set. See Currency codes for all valid values." } ] }, "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
" } ] } } }, "payoutFlowsSameDay": { "title": "payoutFlowsSameDay", "enum": [ 0, 1 ], "type": "integer" }, "payoutFlowsSkipOffDays": { "title": "payoutFlowsSkipOffDays", "enum": [ 0, 1 ], "type": "integer" }, "payoutInactive": { "title": "payoutInactive", "enum": [ 0, 1 ], "type": "integer" }, "payoutSchedule": { "title": "payoutSchedule", "enum": [ 1, 2, 3, 4, 5 ], "type": "integer" }, "payoutUm": { "title": "payoutUm", "enum": [ 1, 2, 3 ], "type": "integer" }, "payoutsModelAccount": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/accountsResponse" } ], "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." }, "payoutsModelBilling": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/billingsResponse" } ], "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." }, "payoutsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this Payout is associated with." }, "payoutsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "payoutsModelPayoutFlow": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/payoutFlowsResponse" } ], "description": "The identifier of the PayoutFlow associated with this Payout." }, "payoutsResponse": { "title": "payoutsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/payoutsModelLogin" }, { "description": "The Login that owns this resource." } ] }, "account": { "allOf": [ { "$ref": "#/$defs/payoutsModelAccount" }, { "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": { "allOf": [ { "$ref": "#/$defs/payoutsModelEntity" }, { "description": "The identifier of the Entity that this Payout is associated with." } ] }, "billing": { "allOf": [ { "$ref": "#/$defs/payoutsModelBilling" }, { "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": { "allOf": [ { "$ref": "#/$defs/payoutsModelPayoutFlow" }, { "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" }, "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. This field is only required when Um is set to ACTUAL. If 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": "int32" }, "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
" } ] }, "disbursements": { "type": "array", "items": { "$ref": "#/$defs/disbursementsResponse" }, "description": "" } } }, "pendingEntriesIsEFE": { "title": "pendingEntriesIsEFE", "enum": [ 0, 1 ], "type": "integer" }, "pendingEntriesIsFee": { "title": "pendingEntriesIsFee", "enum": [ 0, 1 ], "type": "integer" }, "pendingEntriesModelAdjustment": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/adjustmentsResponse" } ], "description": "The adjustment ID from which the funding activity was triggered." }, "pendingEntriesModelChargeback": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/chargebacksResponse" } ], "description": "If the activity that this PendingEntry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource." }, "pendingEntriesModelDisbursement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/disbursementsResponse" } ], "description": "If the activity that this PendingEntry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement resource." }, "pendingEntriesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that owns this PendingEntry." }, "pendingEntriesModelEntityDebt": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entityDebtsResponse" } ], "description": "The ID of the entityDebt representing the relationship for the debt" }, "pendingEntriesModelEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The entry ID associated with this pendingEntry." }, "pendingEntriesModelFee": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/feesResponse" } ], "description": "If the activity that this PendingEntry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource." }, "pendingEntriesModelFromentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "If the activity that this PendingEntry refers to involves two parties in the system with one paying a charge of any kind, then this field stores the identifier of the Entity that the charge or other activity is for." }, "pendingEntriesModelFund": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/fundsResponse" } ], "description": "The identifier of the Fund that this PendingEntry refers to." }, "pendingEntriesModelOnentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this PendingEntry refers to. This is the owner of the record that triggered the charge." }, "pendingEntriesModelProfitShare": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/profitSharesResponse" } ], "description": "If the activity that this PendingEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource." }, "pendingEntriesModelRefund": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/refundsResponse" } ], "description": "If the activity that this PendingEntry refers to is the paying of a Refund, then this field stores the identifier of the corresponding Refund resource." }, "pendingEntriesModelRevShareStatement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/revShareStatmentsResponse" } ], "description": "If the activity that this PendingEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource" }, "pendingEntriesModelSettlement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/settlementsResponse" } ], "description": "If the activity that this PendingEntry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource." }, "pendingEntriesModelStatement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/statementsResponse" } ], "description": "If the activity that this PendingEntry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource." }, "pendingEntriesModelTerminalTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/terminalTxnsResponse" } ], "description": "The terminal transaction ID from which the funding activity was triggered." }, "pendingEntriesModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "If the activity that this PendingEntry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource." }, "pendingEntriesOriginalEvent": { "title": "pendingEntriesOriginalEvent", "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, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 101, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 601, 602, 603, 604, 605, 606, 607, 608 ], "type": "integer" }, "pendingEntriesPending": { "title": "pendingEntriesPending", "enum": [ 0, 1 ], "type": "integer" }, "pendingEntriesResponse": { "title": "pendingEntriesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelEntity" }, { "description": "The identifier of the Entity that owns this PendingEntry." } ] }, "onentity": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelOnentity" }, { "description": "The identifier of the Entity that this PendingEntry refers to. This is the owner of the record that triggered the charge." } ] }, "fromentity": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelFromentity" }, { "description": "If the activity that this PendingEntry refers to involves two parties in the system with one paying a charge of any kind, then this field stores the identifier of the Entity that the charge or other activity is for." } ] }, "fund": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelFund" }, { "description": "The identifier of the Fund that this PendingEntry refers to." } ] }, "opposingEntry": { "type": "string", "description": "The identifier of the Entry that this entry was created based on." }, "entry": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelEntry" }, { "description": "The entry ID associated with this pendingEntry." } ] }, "adjustment": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelAdjustment" }, { "description": "The adjustment ID from which the funding activity was triggered." } ] }, "chargeback": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelChargeback" }, { "description": "If the activity that this PendingEntry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource." } ] }, "disbursement": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelDisbursement" }, { "description": "If the activity that this PendingEntry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement resource." } ] }, "fee": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelFee" }, { "description": "If the activity that this PendingEntry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource." } ] }, "refund": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelRefund" }, { "description": "If the activity that this PendingEntry refers to is the paying of a Refund, then this field stores the identifier of the corresponding Refund resource." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelTxn" }, { "description": "If the activity that this PendingEntry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource." } ] }, "event": { "allOf": [ { "$ref": "#/$defs/pendingEntryEvent" }, { "description": "The bucket of rev share fees, comma-separated list with no spaces\n
\nValid Values\n- `1` - **DAYS** The PendingEntry for an Entry that triggers every day.\n- `2` - **WEEKS** The PendingEntry for an Entry that triggers every week.\n- `3` - **MONTHS** The PendingEntry for an Entry that triggers every month.\n- `4` - **YEARS** The PendingEntry for an Entry that triggers every year.\n- `5` - **SINGLE** The PendingEntry for an Entry related to a one-off event.\n- `6` - **AUTH** The PendingEntry for an Entry related to the time of authorization of a transaction.\n- `7` - **CAPTURE** The PendingEntry for an Entry related to the capture time of a Transaction.\n- `8` - **REFUND** The PendingEntry for an Entry related to when a refund transaction is processed.\n- `9` - **BOARD** The PendingEntry for an Entry related to when the Merchant is boarded.\n- `10` - **PAYOUT** The PendingEntry for an Entry related to when a payout is processed.\n- `11` - **CHARGEBACK** The PendingEntry for an Entry related to when a card chargeback occurs.\n- `12` - **OVERDRAFT** The PendingEntry for an Entry related to when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE** The PendingEntry for an Entry related to when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR** The PendingEntry for an Entry related to when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL** The PendingEntry for an Entry related to when an automated clearing house failure occurs.\n- `16` - **ACCOUNT** The PendingEntry for an Entry related to when a bank account is verified.\n- `17` - **SIFT** The PendingEntry for an Entry related to Transaction fraud score.\n- `18` - **ADJUSTMENT** The PendingEntry for an Entry related to adjusted funds.\n- `19` - **RETRIEVAL** The PendingEntry for an Entry related to Retrieval Request Chargeback.\n- `20` - **ARBITRATION** The PendingEntry for an Entry related to Arbitration Chargeback.\n- `21` - **ECSALE** The PendingEntry for an Entry related to an eCheck Sale.\n- `22` - **ECREFUND** The PendingEntry for an Entry related to an eCheck Refund.\n- `23` - **ECRETURN** The PendingEntry for an Entry related to an eCheck Return.\n- `24` - **SETTLEMENT** The PendingEntry for an Entry related to transaction settlement.\n- `25` - **MISUSE** The PendingEntry for an Entry related to Misuse of authorization.\n- `26` - **PROFIT_SHARE** The PendingEntry for an Entry related to a profit sharing entry.\n- `27` - **UNAUTH** The PendingEntry for an Entry related to an unauthorized entry.\n- `28` - **ACHNOC** The PendingEntry for an Entry related to an ACH Notification of Change.\n- `29` - **ECNOC** The PendingEntry for an Entry related to an eCheck Notifications of Change.\n- `30` - **ECFAIL** The PendingEntry for an Entry related to an eCheck Fail.\n- `31` - **ECNSF** The PendingEntry for an Entry related to an eCheck Non-Sufficient Funds.\n- `32` - **CURRENCY_CONVERSION** The PendingEntry for an Entry related to a currency conversion.\n- `33` - **TERMINAL_TXN** The PendingEntry for an Entry related to a terminal transaction.\n- `34` - **REVERSE_PAYOUT** The PendingEntry for an Entry related to a payout that's been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT** The PendingEntry for an Entry related to a payout that's been partially reversed.\n- `43` - **PAYMENT_CHECK** Single payment check (deprecated).\n- `44` - **PAYMENT_UPDATE** Single payment update.\n- `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).\n- `46` - **PAYMENT_GROUP_UPDATE** Group payment update.\n- `47` - **ENTRY_REFUND** Entry refunds.\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through a risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees\n
" } ] }, "eventId": { "type": "string", "description": "The identifier of the record that is associated with this PendingEntry." }, "description": { "type": "string", "description": "A description of this PendingEntry." }, "amount": { "type": "number", "description": "The amount involved in this PendingEntry. It refers to the amount charged, transferred, or disbursed. \nThis field is specified in cents(up to three decimal points)" }, "pending": { "allOf": [ { "$ref": "#/$defs/pendingEntriesPending" }, { "description": "Whether this resource is marked as pending.\n\n
\nValid Values\n\n- `0` - **Not Pending.**\n- `1` - **Pending.**\n\n
" } ] }, "profitShare": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelProfitShare" }, { "description": "If the activity that this PendingEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource." } ] }, "originalCurrency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "Original Currency describes the currency, set automatically based on the settled total. The default is 'USD'. See Currency codes for all valid values." } ] }, "currencyRate": { "type": "number", "description": "currency conversion rate(up to three decimal points)." }, "terminalTxn": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelTerminalTxn" }, { "description": "The terminal transaction ID from which the funding activity was triggered." } ] }, "isFee": { "allOf": [ { "$ref": "#/$defs/pendingEntriesIsFee" }, { "description": "Whether this resource is marked as a fee.\n\n
\nValid Values\n\n- `0` - **Not a Fee.**\n- `1` - **Is a Fee.**\n\n
" } ] }, "entityDebt": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelEntityDebt" }, { "description": "The ID of the entityDebt representing the relationship for the debt" } ] }, "statement": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelStatement" }, { "description": "If the activity that this PendingEntry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource." } ] }, "settlement": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelSettlement" }, { "description": "If the activity that this PendingEntry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource." } ] }, "originalEventId": { "type": "string", "description": "ID of the original event." }, "originalEvent": { "allOf": [ { "$ref": "#/$defs/pendingEntriesOriginalEvent" }, { "description": "The event that originally triggered the entry.\n
\nValid Values\nValid Values\n- `1` - **DAYS** The PendingEntry for an Entry that triggers every day.\n- `2` - **WEEKS** The PendingEntry for an Entry that triggers every week.\n- `3` - **MONTHS** The PendingEntry for an Entry that triggers every month.\n- `4` - **YEARS** The PendingEntry for an Entry that triggers every year.\n- `5` - **SINGLE** The PendingEntry for an Entry related to a one-off event.\n- `6` - **AUTH** The PendingEntry for an Entry related to the time of authorization of a transaction.\n- `7` - **CAPTURE** The PendingEntry for an Entry related to the capture time of a Transaction.\n- `8` - **REFUND** The PendingEntry for an Entry related to when a refund transaction is processed.\n- `9` - **BOARD** The PendingEntry for an Entry related to when the Merchant is boarded.\n- `10` - **PAYOUT** The PendingEntry for an Entry related to when a payout is processed.\n- `11` - **CHARGEBACK** The PendingEntry for an Entry related to when a card chargeback occurs.\n- `12` - **OVERDRAFT** The PendingEntry for an Entry related to when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE** The PendingEntry for an Entry related to when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR** The PendingEntry for an Entry related to when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL** The PendingEntry for an Entry related to when an automated clearing house failure occurs.\n- `16` - **ACCOUNT** The PendingEntry for an Entry related to when a bank account is verified.\n- `17` - **SIFT** The PendingEntry for an Entry related to Transaction fraud score.\n- `18` - **ADJUSTMENT** The PendingEntry for an Entry related to adjusted funds.\n- `19` - **RETRIEVAL** The PendingEntry for an Entry related to Retrieval Request Chargeback.\n- `20` - **ARBITRATION** The PendingEntry for an Entry related to Arbitration Chargeback.\n- `21` - **ECSALE** The PendingEntry for an Entry related to an eCheck Sale.\n- `22` - **ECREFUND** The PendingEntry for an Entry related to an eCheck Refund.\n- `23` - **ECRETURN** The PendingEntry for an Entry related to an eCheck Return.\n- `24` - **SETTLEMENT** The PendingEntry for an Entry related to transaction settlement.\n- `25` - **MISUSE** The PendingEntry for an Entry related to Misuse of authorization.\n- `26` - **PROFIT_SHARE** The PendingEntry for an Entry related to a profit sharing entry.\n- `27` - **UNAUTH** The PendingEntry for an Entry related to an unauthorized entry.\n- `28` - **ACHNOC** The PendingEntry for an Entry related to an ACH Notification of Change.\n- `29` - **ECNOC** The PendingEntry for an Entry related to an eCheck Notifications of Change.\n- `30` - **ECFAIL** The PendingEntry for an Entry related to an eCheck Fail.\n- `31` - **ECNSF** The PendingEntry for an Entry related to an eCheck Non-Sufficient Funds.\n- `32` - **CURRENCY_CONVERSION** The PendingEntry for an Entry related to a currency conversion.\n- `33` - **TERMINAL_TXN** The PendingEntry for an Entry related to a terminal transaction.\n- `34` - **REVERSE_PAYOUT** The PendingEntry for an Entry related to a payout that's been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT** The PendingEntry for an Entry related to a payout that's been partially reversed.\n- `43` - **PAYMENT_CHECK** Single payment check (deprecated).\n- `44` - **PAYMENT_UPDATE** Single payment update.\n- `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).\n- `46` - **PAYMENT_GROUP_UPDATE** Group payment update.\n- `47` - **ENTRY_REFUND** Entry refunds.\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through a risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees\n
" } ] }, "revShareStatement": { "allOf": [ { "$ref": "#/$defs/pendingEntriesModelRevShareStatement" }, { "description": "If the activity that this PendingEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource" } ] }, "isEFE": { "allOf": [ { "$ref": "#/$defs/pendingEntriesIsEFE" }, { "description": "An integer-boolean indicating whether or not the funding activity was triggered by a fee assessment.\n\n
\nValid Values\n\n- `0` - **Off**\n- `1` - **On**\n\n
" } ] }, "lastNegativeOfDisbursement": { "$ref": "#/$defs/disbursementsResponse" }, "lastPositiveOfDisbursement": { "$ref": "#/$defs/disbursementsResponse" }, "opposingPendingEntry": { "$ref": "#/$defs/pendingEntriesResponse" } } }, "pendingEntryEvent": { "title": "pendingEntryEvent", "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, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 101, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 601, 602, 603, 604, 605, 606, 607, 608 ], "type": "integer" }, "pinlessDebitConversionsPlatform": { "title": "pinlessDebitConversionsPlatform", "const": "VCORE", "type": "string" }, "pinlessDebitConversionsResponse": { "title": "pinlessDebitConversionsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "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" }, "plansModelBilling": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/billingsResponse" } ], "description": "The attached billing for which recurring payments should be made to pay off statements." }, "plansModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant associated with this Plan." }, "plansResponse": { "title": "plansResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "merchant": { "allOf": [ { "$ref": "#/$defs/plansModelMerchant" }, { "description": "The identifier of the Merchant associated with this Plan." } ] }, "billing": { "allOf": [ { "$ref": "#/$defs/plansModelBilling" }, { "description": "The attached billing for which recurring payments should be made to pay off statements." } ] }, "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
" } ] }, "name": { "type": "string", "description": "The name of this Plan. \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 Plan. \nThis field is stored as a text string and must be between 0 and 100 characters long." }, "txnDescription": { "type": "string", "description": "The description of the Txn that will be created through this Plan." }, "order": { "type": "string", "description": "The order of the Txn that will be created through this Plan." }, "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. \nThis field is specified as an integer and its value determines how the interval is multiplied.", "contentEncoding": "int32" }, "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
" } ] }, "amount": { "type": "integer", "description": "The amount to charge with each payment under this Plan. \nThis field is specified as an integer in cents.", "contentEncoding": "int64" }, "maxFailures": { "type": "integer", "description": "The maximum consecutive amount of payment failures to allow for a 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
" } ] }, "subscriptions": { "type": "array", "items": { "$ref": "#/$defs/subscriptionsResponse" }, "description": "" } } }, "platformModel": { "title": "platformModel", "enum": [ "APPLE", "ELAVON", "FIRSTDATA", "GOOGLE", "VANTIV", "VCORE", "TDBANKCA", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY" ], "type": "string" }, "profitShareResultsModelEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The identifier of the Entry that this ProfitShareResult refers to." }, "profitShareResultsModelProfitShare": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/profitSharesResponse" } ], "description": "The identifier of the ProfitShare that this ProfitShareResult refers to." }, "profitShareResultsResponse": { "title": "profitShareResultsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "profitShare": { "allOf": [ { "$ref": "#/$defs/profitShareResultsModelProfitShare" }, { "description": "The identifier of the ProfitShare that this ProfitShareResult refers to." } ] }, "entry": { "allOf": [ { "$ref": "#/$defs/profitShareResultsModelEntry" }, { "description": "The identifier of the Entry that this ProfitShareResult refers to." } ] }, "amount": { "type": "number", "description": "The amount that could not be shared between entities, This field is specified in cents(up to three decimal points)" }, "message": { "type": "string", "description": "A message regarding the failure of the ProfitShare process. \nThis field is stored as a text string and must be between 0 and 200 characters long." } } }, "profitShareRuleType": { "title": "profitShareRuleType", "enum": [ "less", "equal", "notEqual", "greater", "event", "notEvent", "fee", "notFee", "fromentity", "notFromentity" ], "type": "string" }, "profitShareRulesModelProfitShare": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/profitSharesResponse" } ], "description": "The identifier of the ProfitShare that this ProfitShare Rule applies to." }, "profitShareRulesResponse": { "title": "profitShareRulesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "profitShare": { "allOf": [ { "$ref": "#/$defs/profitShareRulesModelProfitShare" }, { "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
" } ] }, "fee": { "$ref": "#/$defs/feesResponse" } } }, "profitShareType": { "title": "profitShareType", "enum": [ "income", "expense", "both" ], "type": "string" }, "profitSharesModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division in which entities will have their earnings/expenses shares." }, "profitSharesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this ProfitShare refers to. This is the entity that will receive the split income/expense." }, "profitSharesModelForentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that will have it's earnings/expenses shared." }, "profitSharesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this ProfitShare." }, "profitSharesModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org in which entities will have their earnings/expenses shares." }, "profitSharesModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition in which entities will have their earnings/expenses shares." }, "profitSharesResponse": { "title": "profitSharesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/profitSharesModelLogin" }, { "description": "The identifier of the Login that owns this ProfitShare." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/profitSharesModelEntity" }, { "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/profitSharesModelForentity" }, { "description": "The identifier of the Entity that will have it's earnings/expenses shared." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/profitSharesModelOrg" }, { "description": "The identifier of the Org in which entities will have their earnings/expenses shares." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/profitSharesModelDivision" }, { "description": "The identifier of the Division in which entities will have their earnings/expenses shares." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/profitSharesModelPartition" }, { "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
" } ] }, "billingEvents": { "type": "array", "items": { "$ref": "#/$defs/billingEventsResponse" }, "description": "" }, "pendingEntries": { "type": "array", "items": { "$ref": "#/$defs/pendingEntriesResponse" }, "description": "" }, "profitShareResults": { "type": "array", "items": { "$ref": "#/$defs/profitShareResultsResponse" }, "description": "" }, "profitShareRules": { "type": "array", "items": { "$ref": "#/$defs/profitShareRulesResponse" }, "description": "" }, "statementEntries": { "type": "array", "items": { "$ref": "#/$defs/statementEntriesResponse" }, "description": "" }, "Entries": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" } } }, "refundReleaseReserve": { "title": "refundReleaseReserve", "enum": [ 0, 1 ], "type": "integer" }, "refundsModelEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The identifier of the Entries resource that is being refunded." }, "refundsResponse": { "title": "refundsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entry": { "allOf": [ { "$ref": "#/$defs/refundsModelEntry" }, { "description": "The identifier of the Entries resource that is being refunded." } ] }, "description": { "type": "string", "description": "A description of this Refund. \nThis field is stored as a text string and must be between 0 and 100 characters long." }, "amount": { "type": "number", "description": "The amount of this Refund. \nThis field is specified in cents(up to three decimal points). \nThis field is optional. If it is not set, then the API uses the amount that is specified in the related Entry resource." }, "entries": { "$ref": "#/$defs/entriesResponse" }, "pendingEntries": { "$ref": "#/$defs/pendingEntriesResponse" } } }, "reserveEntriesModelEntityReserve": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entityReservesResponse" } ], "description": "This field indicates that this reserveEntry was triggered from a manual change to an entityReserve, and it stores the identifier of the entityReserve resource." }, "reserveEntriesModelEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entriesResponse" } ], "description": "The entry ID associated with this pendingEntry." }, "reserveEntriesModelEventId": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the record that is associated with this PendingEntry." }, "reserveEntriesModelFund": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/fundsResponse" } ], "description": "The identifier of the Fund that this reserveEntries resource relates to." }, "reserveEntriesModelHold": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/holdsResponse" } ], "description": "The ID of the hold that generated this reserveEntry." }, "reserveEntriesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "reserveEntriesModelOnentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this reserveEntry refers to. This is the owner of the record that triggered the charge." }, "reserveEntriesModelReserve": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/reservesResponse" } ], "description": "This field indicates that this reserveEntry was triggered from an automatic reserve, and it stores the identifier of the Reserve resource." }, "reserveEntriesModelReserveEntry": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/reserveEntriesResponse" } ], "description": "This field indicates that this reserveEntry shows funds moving out of or into reserve. This field stores the identifier of the reserveEntry resource that moved the funds into or out of the reserve." }, "reserveEntriesModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "This field indicates that this reserveEntry was triggered from a Transaction, and it stores the identifier of the Transaction." }, "reserveEntriesResponse": { "title": "reserveEntriesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelLogin" }, { "description": "The Login that owns this resource." } ] }, "fund": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelFund" }, { "description": "The identifier of the Fund that this reserveEntries resource relates to." } ] }, "txn": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelTxn" }, { "description": "This field indicates that this reserveEntry was triggered from a Transaction, and it stores the identifier of the Transaction." } ] }, "hold": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelHold" }, { "description": "The ID of the hold that generated this reserveEntry." } ] }, "reserve": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelReserve" }, { "description": "This field indicates that this reserveEntry was triggered from an automatic reserve, and it stores the identifier of the Reserve resource." } ] }, "entityReserve": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelEntityReserve" }, { "description": "This field indicates that this reserveEntry was triggered from a manual change to an entityReserve, and it stores the identifier of the entityReserve resource." } ] }, "reserveEntry": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelReserveEntry" }, { "description": "This field indicates that this reserveEntry shows funds moving out of or into reserve. This field stores the identifier of the reserveEntry resource that moved the funds into or out of the reserve." } ] }, "onentity": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelOnentity" }, { "description": "The identifier of the Entity that this reserveEntry refers to. This is the owner of the record that triggered the charge." } ] }, "entry": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelEntry" }, { "description": "The entry ID associated with this pendingEntry." } ] }, "event": { "allOf": [ { "$ref": "#/$defs/reserveEntryEvent" }, { "description": "The bucket of rev share fees, comma-separated list with no spaces\n
\nValid Values\n- `1` - **DAYS** The ReserveEntry for an Entry that triggers every day.\n- `2` - **WEEKS** The ReserveEntry for an Entry that triggers every week.\n- `3` - **MONTHS** The ReserveEntry for an Entry that triggers every month.\n- `4` - **YEARS** The ReserveEntry for an Entry that triggers every year.\n- `5` - **SINGLE** The ReserveEntry for an Entry related to a one-off event.\n- `6` - **AUTH** The ReserveEntry for an Entry related to the time of authorization of a transaction.\n- `7` - **CAPTURE** The ReserveEntry for an Entry related to the capture time of a Transaction.\n- `8` - **REFUND** The ReserveEntry for an Entry related to when a refund transaction is processed.\n- `9` - **BOARD** The ReserveEntry for an Entry related to when the Merchant is boarded.\n- `10` - **PAYOUT** The ReserveEntry for an Entry related to when a payout is processed.\n- `11` - **CHARGEBACK** The ReserveEntry for an Entry related to when a card chargeback occurs.\n- `12` - **OVERDRAFT** The ReserveEntry for an Entry related to when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE** The ReserveEntry for an Entry related to when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR** The ReserveEntry for an Entry related to when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL** The ReserveEntry for an Entry related to when an automated clearing house failure occurs.\n- `16` - **ACCOUNT** The ReserveEntry for an Entry related to when a bank account is verified.\n- `17` - **SIFT** The ReserveEntry for an Entry related to Transaction fraud score.\n- `18` - **ADJUSTMENT** The ReserveEntry for an Entry related to adjusted funds.\n- `19` - **RETRIEVAL** The ReserveEntry for an Entry related to Retrieval Request Chargeback.\n- `20` - **ARBITRATION** The ReserveEntry for an Entry related to Arbitration Chargeback.\n- `21` - **ECSALE** The ReserveEntry for an Entry related to an eCheck Sale.\n- `22` - **ECREFUND** The ReserveEntry for an Entry related to an eCheck Refund.\n- `23` - **ECRETURN** The ReserveEntry for an Entry related to an eCheck Return.\n- `24` - **SETTLEMENT** The ReserveEntry for an Entry related to transaction settlement.\n- `25` - **MISUSE** The ReserveEntry for an Entry related to Misuse of authorization.\n- `26` - **PROFIT_SHARE** The ReserveEntry for an Entry related to a profit sharing entry.\n- `27` - **UNAUTH** The ReserveEntry for an Entry related to an unauthorized entry.\n- `28` - **ACHNOC** The ReserveEntry for an Entry related to an ACH Notification of Change.\n- `29` - **ECNOC** The ReserveEntry for an Entry related to an eCheck Notifications of Change.\n- `30` - **ECFAIL** The ReserveEntry for an Entry related to an eCheck Fail.\n- `31` - **ECNSF** The ReserveEntry for an Entry related to an eCheck Non-Sufficient Funds.\n- `32` - **CURRENCY_CONVERSION** The ReserveEntry for an Entry related to a currency conversion.\n- `33` - **TERMINAL_TXN** The ReserveEntry for an Entry related to a terminal transaction.\n- `34` - **REVERSE_PAYOUT** The ReserveEntry for an Entry related to a payout that's been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT** The ReserveEntry for an Entry related to a payout that's been partially reversed.\n- `37` - **RESERVE_ENTRY_RELEASE**: The ReserveEntry for an Entry related to released reserves.\n- `43` - **PAYMENT_CHECK** Single payment check (deprecated).\n- `44` - **PAYMENT_UPDATE** Single payment update.\n- `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).\n- `46` - **PAYMENT_GROUP_UPDATE** Group payment update.\n- `47` - **ENTRY_REFUND** Entry refunds.\n- `48` - **ENTITY_RESERVE_CHANGE** Entity Reserve Total change..\n- `49` - **RELEASE_HOLD** Release Hold.\n- `50` - **RELEASE_ENTRIES_DEFAULT** Default values for older records..\n- `51` - **STATEMENT** Payment of statement.\n- `52` - **MERCHANT_CREATION** Merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.\n- `55` - **MASTER_CARD_MATCH** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID** Business instant ID.\n- `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.\n- `58` - **THREAT_METRIX** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.\n- `61` - **GUIDE_STAR** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.\n- `63` - **TIN_CHECK** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.\n- `66` - **PLAID** Plaid.\n- `67` - **STATEMENT_REVERSAL** Reversal of statement.\n- `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement account on sign-up or post-boarding account.\n- `70` - **BOARD_DECISION** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION** Txn going through a risk decision.\n- `72` - **FANF** External Fees.\n- `73` - **MCLOCATION** External Fees.\n- `74` - **VISAINTEGRITY** External Fees.\n- `75` - **SAFERPAYMENTS_BASIC** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.\n- `78` - **OMNITOKENS_VOLUME** External Fees.\n- `79` - **PAYOUT_RETURN** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.\n- `81` - **REV_SHARE** Rev share.\n- `82` - **CARD_SETTLEMENT** Txns card settlement.\n- `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.\n- `84` - **REV_SHARE_CARD** Rev Share Schedules.\n- `85` - **REV_SHARE_ECHECK** Rev Share Schedules.\n- `86` - **REV_SHARE_DBM** Rev Share Schedules.\n- `87` - **PREARBITRATION** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.\n- `92` - **PLAID_GET_AUTH** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.\n- `94` - **REVERSAL** Chargeback Reversal.\n- `95` - **REPRESENTMENT** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE** External Fees.\n- `207` - **VALUTEC_SETUP_FEE** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.\n- `216` - **EFE_MWC_BILLING** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.\n- `402` - **TXN_THREAT_METRIX** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.\n- `405` - **GIACT_INQUIRY** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.\n- `407` - **TRULIOO_IDV** External Fees.\n- `408` - **TRULIOO_AMLLDV** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees\n
" } ] }, "eventId": { "allOf": [ { "$ref": "#/$defs/reserveEntriesModelEventId" }, { "description": "The identifier of the record that is associated with this PendingEntry." } ] }, "status": { "type": "string", "description": "The current status of the reserveEntry." }, "statusMessage": { "type": "string", "description": "Message that provides details abount failure of the reserveEntry." }, "description": { "type": "string", "description": "A description of this reserveEntries resource. This field is stored as a text string and must be between 0 and 100 characters long." }, "release": { "type": "string", "description": "The date on which the funds in reserve should be released, specified as an eight-digit string in YYYYMMDD format, such as '20160120' for January 20, 2016." }, "amount": { "type": "integer", "description": "The amount held in reserve in this reserveEntries resource, which is specified as an integer in cents.", "contentEncoding": "int64" }, "processed": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time on which the reserveEntry was processed. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "processingId": { "type": "string", "description": "The processing ID for the reserveEntry." }, "lastPositiveOfDisbursement": { "$ref": "#/$defs/disbursementsResponse" }, "lastNegativeOfDisbursement": { "$ref": "#/$defs/disbursementsResponse" } } }, "reserveEntryEvent": { "title": "reserveEntryEvent", "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, 37, 43, 44, 45, 46, 47, 48, 49, 50, 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, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 101, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 601, 602, 603, 604, 605, 606, 607, 608 ], "type": "integer" }, "reserveStatus": { "title": "reserveStatus", "enum": [ 1, 2, 3 ], "type": "integer" }, "reservesLevel": { "title": "reservesLevel", "enum": [ "admin", "division", "merchant", "partition" ], "type": "string" }, "reservesModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division that this Reserve's resource applies to." }, "reservesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that this Reserve applies to." }, "reservesModelHold": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/holdsResponse" } ], "description": "The identifier of the Entity Hold from which this Reserve was generated." }, "reservesModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this Reserve." }, "reservesModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "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." }, "reservesModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition that this Reserve's resource applies to." }, "reservesRelease": { "title": "reservesRelease", "enum": [ "never", "days", "weeks", "months", "years" ], "type": "string" }, "reservesResponse": { "title": "reservesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/reservesModelLogin" }, { "description": "The identifier of the Login that owns this Reserve." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/reservesModelOrg" }, { "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": { "allOf": [ { "$ref": "#/$defs/reservesModelDivision" }, { "description": "The identifier of the Division that this Reserve's resource applies to." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/reservesModelPartition" }, { "description": "The identifier of the Partition that this Reserve's resource applies to." } ] }, "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": { "allOf": [ { "$ref": "#/$defs/reservesModelEntity" }, { "description": "The identifier of the Entity that this Reserve applies to." } ] }, "hold": { "allOf": [ { "$ref": "#/$defs/reservesModelHold" }, { "description": "The identifier of 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" }, "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" }, "status": { "allOf": [ { "$ref": "#/$defs/reserveStatus" }, { "description": "The status of reserve.\n
\nValid Values\n- `1` - **The reserve is active.**\n- `2` - **The reserve is under review.**\n- `3` - **The reserve is inactive.**\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
" } ] }, "reserveEntries": { "type": "array", "items": { "$ref": "#/$defs/reserveEntriesResponse" }, "description": "" } } }, "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" }, "revShareScheduleEvent": { "title": "revShareScheduleEvent", "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, 87, 88, 89, 90, 91, 92, 93, 94, 95, 101, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 601, 602, 603, 604, 605, 606, 607, 608 ], "type": "integer" }, "revShareSchedulesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The Entities object which is collecting the money." }, "revShareSchedulesModelForentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The Entities object which is paying the money." }, "revShareSchedulesResponse": { "title": "revShareSchedulesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/revShareSchedulesModelEntity" }, { "description": "The Entities object which is collecting the money." } ] }, "forentity": { "allOf": [ { "$ref": "#/$defs/revShareSchedulesModelForentity" }, { "description": "The Entities object which is paying the money." } ] }, "start": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "The start date of rev share. The format should be YYYY-MM-DD HH:MM:SS." }, "end": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "The end date of rev share. The format should be YYYY-MM-DD HH:MM:SS." }, "share": { "type": "integer", "description": "The percentage that payrix receives.", "contentEncoding": "int64" }, "event": { "allOf": [ { "$ref": "#/$defs/revShareScheduleEvent" }, { "description": "The bucket of rev share fees, comma-separated list with no spaces\n
\nValid Values\n\n- `1` - **DAYS.** Daily scheduled event (like a fee).\n- `2` - **WEEKS.** Weekly scheduled event.\n- `3` - **MONTHS.** Monthly scheduled event.\n- `4` - **YEARS.** Yearly scheduled event.\n- `5` - **SINGLE.** One-off event.\n- `6` - **AUTH.** Auth and sale transaction (types 1 and 2) authorization.\n- `7` - **CAPTURE.** Capture and sale transaction (types 1 and 3) capture (settlement to processor).\n- `8` - **REFUND.** Refund transaction capture (settlement to processor).\n- `9` - **BOARD.** Merchant boarding (mid stage entityRef creation).\n- `10` - **PAYOUT.** Disbursement creation.\n- `11` - **CHARGEBACK.** Chargeback creation for the following cycles: first, representment, preArbitration.\n- `12` - **OVERDRAFT.** Disbursement return due to insufficient funds.\n- `13` - **INTERCHANGE.** Transaction interchange fees assessment.\n- `14` - **PROCESSOR.** Transaction processed by a payment processor.\n- `15` - **ACHFAIL.** Disbursement return due to any failure other than insufficient funds.\n- `16` - **ACCOUNT.** Bank account verification.\n- `17` - **SIFT.** Transaction fraud score.\n- `18` - **ADJUSTMENT.** Adjusted funds.\n- `19` - **RETRIEVAL.** Retrieval chargeback creation (retrieval cycle).\n- `20` - **ARBITRATION.** Arbitration chargeback creation (arbitration cycle).\n- `21` - **ECSALE.** Transaction e-check Sale.\n- `22` - **ECREFUND.** Transaction e-check Refund.\n- `23` - **ECRETURN.** eCheck transaction return.\n- `24` - **SETTLEMENT.** Transaction settlement (processor to issuer, reported in processor’s settlement report).\n- `25` - **MISUSE.** Transaction misuse (transaction violated Visa authorization misuse rules or MasterCard’s integrity rules).\n- `26` - **PROFIT_SHARE.** Profit sharing entry event.\n- `27` - **UNAUTH.** Unauthorized entry.\n- `28` - **ACHNOC.** Disbursement notice of change (NOC).\n- `29` - **ECNOC.** eCheck transaction notice of change (NOC).\n- `30` - **ECFAIL.** eCheck transaction return due to any failure other than insufficient funds.\n- `31` - **ECNSF.** eCheck transaction return due to insufficient funds.\n- `32` - **CURRENCY_CONVERSION.** Currency conversion.\n- `33` - **TERMINAL_TXN.** Terminal transaction.\n- `34` - **REVERSE_PAYOUT.** Payout that has been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT.** Payout that has been partially reversed.\n- `43` - **PAYMENT_CHECK.** Account updater request sent (paymentUpdate status of processing).\n- `44` - **PAYMENT_UPDATE.** Account updater response processed (paymentUpdate status of processed).\n- `45` - **PAYMENT_GROUP_CHECK.** Account updater unique request sent (one paymentUpdate status of processing per entity of entire paymentUpdateGroup).\n- `46` - **PAYMENT_GROUP_UPDATE.** Account updater unique response processed (one paymentUpdate status of processed per entity for entire paymentUpdateGroup).\n- `47` - **ENTRY_REFUND.** Entry refunds.\n- `51` - **STATEMENT.** Billing statement (when paid by debit disbursement).\n- `52` - **MERCHANT_CREATION.** Merchant creation.\n- `53` - **REALTIME_BUSINESS_SEARCH.** Real time business search.\n- `54` - **REALTIME_MEMBER_SEARCH.** Real time member search.\n- `55` - **MASTER_CARD_MATCH.** Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID.** Business instant id.\n- `57` - **CONSUMER_INSTANT_ID.** Consumer instant id.\n- `58` - **THREAT_METRIX.** Threat metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER.** Legit script register.\n- `60` - **EQUIFAX_CONSUMER_REPORT.** Equifax consumer report.\n- `61` - **GUIDE_STAR.** Guidestar.\n- `62` - **PAYLOAD_ATTRIBUTE.** Internal Decision V2.\n- `63` - **TIN_CHECK.** Tin check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT.** Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT.** Legit script check merchant.\n- `66` - **PLAID.** Plaid.\n- `67` - **STATEMENT_REVERSAL.** Reversal of statement.\n- `68` - **GIACT_ECHECK.** GIACT call made to verify creator Echeck bank Account.\n- `69` - **GIACT_BANK_ACCOUNT.** Giact calls to verify merchant settlement account on sign up or post boarding account.\n- `70` - **BOARD_DECISION.** Process decision fee after board.\n- `71` - **TXN_RISK_DECISION.** Txn going through a risk decision.\n- `72` - **FANF.** FANF - External fees.\n- `73` - **MCLOCATION.** MCLOCATION - External fees.\n- `74` - **VISAINTEGRITY.** VISAINTEGRITY - External fees.\n- `75` - **SAFERPAYMENTS_BASIC.** External Fees.\n- `76` - **SAFERPAYMENTS_MANAGED.** External Fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION.** External Fees.\n- `78` - **OMNITOKENS_VOLUME.** External Fees.\n- `79` - **PAYOUT_RETURN.** Payout Return.\n- `80` - **PAYOUT_PARTIAL_RETURN.** Payout Partial Return.\n- `81` - **REV_SHARE.** Rev share.\n- `82` - **CARD_SETTLEMENT.** Transaction card settlement.\n- `83` - **ECHECK_SETTLEMENT.** Transaction e-check settlement.\n- `84` - **REV_SHARE_CARD.** Rev share card Schedules.\n- `85` - **REV_SHARE_ECHECK.** Rev share e-chek Schedules.\n- `86` - **REV_SHARE_DBM.** Rev share DBM Schedules.\n- `87` - **PREARBITRATION.** Chargeback PreArbitration.\n- `88` - **PLAID_IDENTITY_MACH.** Plaid.\n- `89` - **TXN_PLAID_IDENTITY_MACH.** Txns Plaid.\n- `90` - **PLAID_GET_IDENTITY.** Plaid.\n- `91` - **TXN_PLAID_GET_IDENTITY.** Txns Plaid.\n- `92` - **PLAID_GET_AUTH.** Plaid.\n- `93` - **TXN_PLAID_GET_AUTH.** Txns Plaid.\n- `94` - **REVERSAL.** Chargeback Reversal.\n- `95` - **REPRESENTMENT.** Chargeback Representment.\n- `96` - **OMNITOKENS_MONTHLY.** Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND.** Interchange retain pass on refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT.** External Fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN.** External Fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE.** External Fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN.** External Fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE.** External Fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN.** External Fees.\n- `206` - **VALUTEC_TRANSACTION_FEE.** External Fees.\n- `207` - **VALUTEC_SETUP_FEE.** External Fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING.** External Fees.\n- `209` - **VALUTEC_JUMP_START_KIT.** External Fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT.** External Fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS.** External Fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE.** External Fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME.** External Fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO.** EFE External Fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN.** EFE External Fees.\n- `216` - **EFE_MWC_BILLING.** EFE External Fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION.** External Fees.\n- `218` - **FRAUDSIGHT_CP_DECISION.** External Fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY.** External Fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT.** External Fees.\n- `402` - **TXN_THREAT_METRIX.** External Fees.\n- `403` - **THREAT_METRIX_EMAILAGE.** External Fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT.** External Fees.\n- `405` - **GIACT_INQUIRY.** External Fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE.** External Fees.\n- `407` - **TRULIOO_IDV.** External Fees.\n- `408` - **TRULIOO_AMLLDV.** External Fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION.** External Fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER.** External Fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT.** Risk Based Tier Fees.\n- `602` - **TIER_QUALIFIED_COUNT.** Risk Based Tier Fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT.** Risk Based Tier Fees.\n- `604` - **TIER_HIGH_RISK_COUNT.** Risk Based Tier Fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME.** Risk Based Tier Fees.\n- `606` - **TIER_QUALIFIED_VOLUME.** Risk Based Tier Fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME.** Risk Based Tier Fees.\n- `608` - **TIER_HIGH_RISK_VOLUME.** Risk Based Tier Fees." } ] }, "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
" } ] } } }, "revShareStatmentsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The Entities object which is collecting the money." }, "revShareStatmentsModelForentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The Entities object which is paying the money." }, "revShareStatmentsModelRevShareSchedule": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/revShareSchedulesResponse" } ], "description": "The RevShareSchedule object defines specific income sharing rules." }, "revShareStatmentsResponse": { "title": "revShareStatmentsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "revShareSchedule": { "allOf": [ { "$ref": "#/$defs/revShareStatmentsModelRevShareSchedule" }, { "description": "The RevShareSchedule object defines specific income sharing rules." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/revShareStatmentsModelEntity" }, { "description": "The Entities object which is collecting the money." } ] }, "forentity": { "allOf": [ { "$ref": "#/$defs/revShareStatmentsModelForentity" }, { "description": "The Entities object which is paying the money." } ] }, "billing": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "The billing date of rev share statement. The format should be YYYY-MM-DD HH:MM:SS." }, "revenueShare": { "type": "number", "description": "The cost to the partner for rev share enabled items, This field is specified in cents(up to three decimal points)" } } }, "revenueBoostsEnableRevenueBoost": { "title": "revenueBoostsEnableRevenueBoost", "enum": [ 0, 1 ], "type": "integer" }, "revenueBoostsModelDeleter": { "anyOf": [ { "type": [ "string", "null" ] }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The id of user who deleted the revenueBoost entity." }, "revenueBoostsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division that networkPaymentManager is associated with." }, "revenueBoostsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that networkPaymentManager is associated with." }, "revenueBoostsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org (group) that networkPaymentManager is associated with." }, "revenueBoostsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition that networkPaymentManager is associated with." }, "revenueBoostsPlatform": { "title": "revenueBoostsPlatform", "const": "VCORE", "type": "string" }, "revenueBoostsResponse": { "title": "revenueBoostsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/revenueBoostsModelEntity" }, { "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": { "allOf": [ { "$ref": "#/$defs/revenueBoostsModelOrg" }, { "description": "The identifier of the Org (group) that networkPaymentManager is associated with." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/revenueBoostsModelDivision" }, { "description": "The identifier of the Division that networkPaymentManager is associated with." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/revenueBoostsModelPartition" }, { "description": "The identifier of the Partition that networkPaymentManager is associated with." } ] }, "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 networkPaymentManager. The 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." }, "enableRevenueBoost": { "allOf": [ { "$ref": "#/$defs/revenueBoostsEnableRevenueBoost" }, { "description": "Flag to depict if entity was enabled for networkPaymentManager.\n
\nValid Values\n\n - `0` - **NotEnabled.**\n - `1` - **Enabled.**\n
" } ] }, "resourceId": { "type": "string", "description": "The identifier of the record created/updated in the original request." }, "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", "null" ], "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": { "allOf": [ { "$ref": "#/$defs/revenueBoostsModelDeleter" }, { "description": "The id of user who deleted the revenueBoost entity." } ] } } }, "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" }, "saferPaymentsModelDeleter": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The id of user who deleted the omniToken." }, "saferPaymentsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division that saferPayments is associated to." }, "saferPaymentsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that saferPayments is associated to." }, "saferPaymentsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org (group) that saferPayments is associated to." }, "saferPaymentsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition that saferPayments is associated to." }, "saferPaymentsResponse": { "title": "saferPaymentsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/saferPaymentsModelEntity" }, { "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": { "allOf": [ { "$ref": "#/$defs/saferPaymentsModelOrg" }, { "description": "The identifier of the Org (group) that saferPayments is associated to." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/saferPaymentsModelDivision" }, { "description": "The identifier of the Division that saferPayments is associated to." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/saferPaymentsModelPartition" }, { "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": { "allOf": [ { "$ref": "#/$defs/saferPaymentsModelDeleter" }, { "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" }, "secretsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "The identifier of the Division associated with this secret." }, "secretsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this secret." }, "secretsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The identifier of the Login that owns this secret resource." }, "secretsModelOrg": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/orgsResponse" } ], "description": "The identifier of the Org associated with this secret." }, "secretsModelPartition": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/partitionsResponse" } ], "description": "The identifier of the Partition associated with this secret." }, "secretsPlatform": { "title": "secretsPlatform", "enum": [ "APPLE", "ELAVON", "FIRSTDATA", "GOOGLE", "VANTIV", "VCORE", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY", "TDBANKCA" ], "type": "string" }, "secretsResponse": { "title": "secretsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/secretsModelLogin" }, { "description": "The identifier of the Login that owns this secret resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/secretsModelEntity" }, { "description": "The identifier of the Entity associated with this secret." } ] }, "org": { "allOf": [ { "$ref": "#/$defs/secretsModelOrg" }, { "description": "The identifier of the Org associated with this secret." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/secretsModelDivision" }, { "description": "The identifier of the Division associated with this secret." } ] }, "partition": { "allOf": [ { "$ref": "#/$defs/secretsModelPartition" }, { "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
" } ] } } }, "settlementStatus": { "title": "settlementStatus", "enum": [ "cancelled", "failed", "pending", "processed", "processing" ], "type": "string" }, "settlementsResponse": { "title": "settlementsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "type": "string", "description": "The identifier of the Login that owns this settlement." }, "payment": { "type": "string", "description": "The identifier of the Payment used with this settlement." }, "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
" } ] }, "ref": { "type": "string", "description": "The reference code used to identify the settlement in the platform." }, "status": { "allOf": [ { "$ref": "#/$defs/settlementStatus" }, { "description": "The current status of the settlement.\n\n
\nValid Values\n\n- `cancelled` - **Cancelled.**\n- `failed` - **Failed.**\n- `pending` - **Pending.**\n- `processed` - **Processed.**\n- `processing` - **Processing.**\n\n
" } ] }, "amount": { "type": "integer", "description": "The amount of the settlement.", "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
" } ] } } }, "simplifiedDepositEnabled": { "title": "simplifiedDepositEnabled", "const": 1, "type": "integer" }, "statementEntriesDeductedFromBalance": { "title": "statementEntriesDeductedFromBalance", "enum": [ 0, 1 ], "type": "integer" }, "statementEntriesModelBilling": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/billingsResponse" } ], "description": "The identifier of the Billing that this StatementEntry refers to." }, "statementEntriesModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The paying entity for which this statementEntry applies." }, "statementEntriesModelEventId": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the record that is associated with this StatementEntry." }, "statementEntriesModelFee": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/feesResponse" } ], "description": "If the activity that this StatementEntry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource." }, "statementEntriesModelForentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that will be paid for this charge." }, "statementEntriesModelOnentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity that triggered the charge." }, "statementEntriesModelProfitShare": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/profitSharesResponse" } ], "description": "If the activity that this StatementEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource." }, "statementEntriesModelRevShareStatement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/revShareStatmentsResponse" } ], "description": "If the activity that this StatementEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource" }, "statementEntriesModelStatement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/statementsResponse" } ], "description": "The identifier of the Statement that this StatementEntry refers to." }, "statementEntriesResponse": { "title": "statementEntriesResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelEntity" }, { "description": "The paying entity for which this statementEntry applies." } ] }, "onentity": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelOnentity" }, { "description": "The identifier of the Entity that triggered the charge." } ] }, "forentity": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelForentity" }, { "description": "The identifier of the Entity that will be paid for this charge." } ] }, "billing": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelBilling" }, { "description": "The identifier of the Billing that this StatementEntry refers to." } ] }, "statement": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelStatement" }, { "description": "The identifier of the Statement that this StatementEntry refers to." } ] }, "fee": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelFee" }, { "description": "If the activity that this StatementEntry refers to is the charging of a Fee, then this field stores the identifier of the corresponding Fee resource." } ] }, "profitShare": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelProfitShare" }, { "description": "If the activity that this StatementEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource." } ] }, "event": { "type": "integer", "description": "The type of original event that triggered this StatementEntry resource.\n\n
\nValid Values\n\n- `1` - **DAYS.** The StatementEntry is triggered by a daily event.\n- `2` - **WEEKS.** The StatementEntry is triggered by a weekly event.\n- `3` - **MONTHS.** The StatementEntry is triggered by a monthly event.\n- `4` - **YEARS.** The StatementEntry is triggered by an annual event.\n- `5` - **SINGLE.** The StatementEntry is triggered by a one-off event.\n- `6` - **AUTH.** The StatementEntry is triggered when a transaction has been authorized.\n- `7` - **CAPTURE.** The StatementEntry is triggered when a transaction has been captured.\n- `8` - **REFUND.** The StatementEntry is triggered when a refund transaction is processed.\n- `9` - **BOARD.** The StatementEntry is triggered when a Merchant is boarded.\n- `10` - **PAYOUT.** The StatementEntry is triggered when a payout is processed.\n- `11` - **CHARGEBACK.** The StatementEntry is triggered when a card chargeback occurs.\n- `12` - **OVERDRAFT.** The StatementEntry is triggered when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE.** The StatementEntry is triggered when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR.** The StatementEntry is triggered when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL.** The StatementEntry is triggered when an automated clearing house failure occurs.\n- `16` - **ACCOUNT.** The StatementEntry is triggered when a bank account is verified.\n- `17` - **SIFT.** The StatementEntry is triggered by a transaction's fraud Score.\n- `18` - **ADJUSTMENT.** The StatementEntry is triggered when there's an adjustment.\n- `19` - **RETRIEVAL.** The StatementEntry is triggered by a retrieval request chargeback.\n- `20` - **ARBITRATION.** The StatementEntry is triggered by an arbitration chargeback.\n- `21` - **ECSALE.** The StatementEntry is triggered by an eCheck sale transaction.\n- `22` - **ECREFUND.** The StatementEntry is triggered by an eCheck refund.\n- `23` - **ECRETURN.** The StatementEntry is triggered by an eCheck return.\n- `24` - **SETTLEMENT.** The StatementEntry triggers when a transaction has been settled.\n- `25` - **MISUSE.** The StatementEntry is triggered when there's been a Misuse of authorization.\n- `26` - **PROFIT_SHARE.** The StatementEntry is triggered by a profit sharing entry event.\n- `27` - **UNAUTH.** The StatementEntry is triggered when a transaction is unauthorized.\n- `28` - **ACHNOC.** The StatementEntry is triggered by a disbursement NOC (Notification of change).\n- `29` - **ECNOC.** The StatementEntry is triggered by an echeck transaction NOC (Notification of change).\n- `30` - **ECFAIL.** The StatementEntry is triggered by an echeck transaction failed.\n- `31` - **ECNSF.** The StatementEntry is triggered by an eCheck transaction NSF (Non-sufficient funds) return.\n- `32` - **CURRENCY_CONVERSION.** This StatementEntry is triggered by a currency conversion.\n- `33` - **TERMINAL_TXN.** This StatementEntry is triggered by a terminal transaction.\n- `34` - **REVERSE_PAYOUT.** This StatementEntry is triggered by a payout that has been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT.** This StatementEntry is triggered by a payout that has been partially reversed.\n- `43` - **PAYMENT_CHECK.** This StatementEntry is triggered by a payment check for Account Updater.\n- `44` - **PAYMENT_UPDATE.** This StatementEntry is triggered by a payment update for Account Updater.\n- `45` - **PAYMENT_GROUP_CHECK.** This StatementEntry is triggered by a payment group check for Account Updater.\n- `46` - **PAYMENT_GROUP_UPDATE.** This StatementEntry is triggered by a payment group update for Account Updater.\n- `47` - **ENTRY_REFUND.** This StatementEntry is triggered by an entry refund.\n- `51` - **STATEMENT.** The StatementEntry for an Entry related to the payment of a statement.\n- `52` - **MERCHANT_CREATION.** The StatementEntry for an Entry related to a merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH.** The StatementEntry for an Entry related to a real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH.** The StatementEntry for an Entry related to a real-time member search.\n- `55` - **MASTER_CARD_MATCH.** The StatementEntry for an Entry related to Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID.** The StatementEntry for an Entry related to a business instant ID.\n- `57` - **CONSUMER_INSTANT_ID.** The StatementEntry for an Entry related to a consumer instant ID.\n- `58` - **THREAT_METRIX.** The StatementEntry for an Entry related to Threat Metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER.** The StatementEntry for an Entry related to Legit Script Register.\n- `60` - **EQUIFAX_CONSUMER_REPORT.** The StatementEntry for an Entry related to Equifax consumer report.\n- `61` - **GUIDE_STAR.** The StatementEntry for an Entry related to Guide Star.\n- `62` - **PAYLOAD_ATTRIBUTE.** The StatementEntry for an Entry related to internal decision V2.\n- `63` - **TIN_CHECK.** The StatementEntry for an Entry related to a Tin Check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT.** The StatementEntry for an Entry related to Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT.** The StatementEntry for an Entry related to Legit Script Check Merchant.\n- `66` - **PLAID.** The StatementEntry for an Entry related to Plaid.\n- `67` - **STATEMENT_REVERSAL.** The StatementEntry for an Entry related to the reversal of a statement.\n- `68` - **GIACT_ECHECK.** The StatementEntry for an Entry related to GIACT call made to verify creator Echeck bank account.\n- `69` - **GIACT_BANK_ACCOUNT.** The StatementEntry for an Entry related to Giact calls to verify merchant settlement account.\n- `70` - **BOARD_DECISION.** The StatementEntry for an Entry related to process decision fee after board.\n- `71` - **TXN_RISK_DECISION.** The StatementEntry for an Entry related to a transaction going through a risk decision.\n- `72` - **FANF.** The StatementEntry for an Entry related to external fees.\n- `73` - **MCLOCATION.** The StatementEntry for an Entry related to external fees.\n- `74` - **VISAINTEGRITY.** The StatementEntry for an Entry related to external fees.\n- `75` - **SAFERPAYMENTS_BASIC.** The StatementEntry for an Entry related to external fees.\n- `76` - **SAFERPAYMENTS_MANAGED.** The StatementEntry for an Entry related to external fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION.** The StatementEntry for an Entry related to external fees.\n- `78` - **OMNITOKENS_VOLUME.** The StatementEntry for an Entry related to external fees.\n- `79` - **PAYOUT_RETURN.** The StatementEntry for an Entry related to a payout return.\n- `80` - **PAYOUT_PARTIAL_RETURN.** The StatementEntry for an Entry related to a partial payout return.\n- `81` - **REV_SHARE.** The StatementEntry for an Entry related to revenue sharing.\n- `82` - **CARD_SETTLEMENT.** The StatementEntry for an Entry related to card settlement.\n- `83` - **ECHECK_SETTLEMENT.** The StatementEntry for an Entry related to e-check settlement.\n- `84` - **REV_SHARE_CARD.** The StatementEntry for an Entry related to revenue sharing for cards.\n- `85` - **REV_SHARE_ECHECK.** The StatementEntry for an Entry related to revenue sharing for e-checks.\n- `86` - **REV_SHARE_DBM.** The StatementEntry for an Entry related to revenue sharing for DBM.\n- `87` - **PREARBITRATION.** The StatementEntry for an Entry related to chargeback pre-arbitration.\n- `88` - **PLAID_IDENTITY_MACH.** The StatementEntry for an Entry related to Plaid Identity Mach.\n- `89` - **TXN_PLAID_IDENTITY_MACH.** The StatementEntry for an Entry related to transactions with Plaid Identity Mach.\n- `90` - **PLAID_GET_IDENTITY.** The StatementEntry for an Entry related to Plaid Get Identity.\n- `91` - **TXN_PLAID_GET_IDENTITY.** The StatementEntry for an Entry related to transactions with Plaid Get Identity.\n- `92` - **PLAID_GET_AUTH.** The StatementEntry for an Entry related to Plaid Get Auth.\n- `93` - **TXN_PLAID_GET_AUTH.** The StatementEntry for an Entry related to transactions with Plaid Get Auth.\n- `94` - **REVERSAL.** The StatementEntry for an Entry related to chargeback reversal.\n- `95` - **REPRESENTMENT.** The StatementEntry for an Entry related to chargeback representment.\n- `96` - **OMNITOKENS_MONTHLY.** The StatementEntry for an Entry related to Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND.** The StatementEntry for an Entry related to interchange retain pass-through refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT.** The StatementEntry for an Entry related to external fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN.** The StatementEntry for an Entry related to external fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE.** The StatementEntry for an Entry related to external fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN.** The StatementEntry for an Entry related to external fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE.** The StatementEntry for an Entry related to external fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN.** The StatementEntry for an Entry related to external fees.\n- `206` - **VALUTEC_TRANSACTION_FEE.** The StatementEntry for an Entry related to external fees.\n- `207` - **VALUTEC_SETUP_FEE.** The StatementEntry for an Entry related to external fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING.** The StatementEntry for an Entry related to external fees.\n- `209` - **VALUTEC_JUMP_START_KIT.** The StatementEntry for an Entry related to external fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT.** The StatementEntry for an Entry related to external fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS.** The StatementEntry for an Entry related to external fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE.** The StatementEntry for an Entry related to external fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME.** The StatementEntry for an Entry related to external fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO.** The StatementEntry for an Entry related to EFE external fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN.** The StatementEntry for an Entry related to EFE external fees.\n- `216` - **EFE_MWC_BILLING.** The StatementEntry for an Entry related to EFE external fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION.** The StatementEntry for an Entry related to external fees.\n- `218` - **FRAUDSIGHT_CP_DECISION.** The StatementEntry for an Entry related to external fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY.** The StatementEntry for an Entry related to external fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT.** The StatementEntry for an Entry related to external fees.\n- `402` - **TXN_THREAT_METRIX.** The StatementEntry for an Entry related to external fees.\n- `403` - **THREAT_METRIX_EMAILAGE.** The StatementEntry for an Entry related to external fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT.** The StatementEntry for an Entry related to external fees.\n- `405` - **GIACT_INQUIRY.** The StatementEntry for an Entry related to external fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE.** The StatementEntry for an Entry related to external fees.\n- `407` - **TRULIOO_IDV.** The StatementEntry for an Entry related to external fees.\n- `408` - **TRULIOO_AMLLDV.** The StatementEntry for an Entry related to external fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION.** The StatementEntry for an Entry related to external fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER.** The StatementEntry for an Entry related to external fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.\n- `602` - **TIER_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.\n- `604` - **TIER_HIGH_RISK_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.\n- `606` - **TIER_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.\n- `608` - **TIER_HIGH_RISK_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.", "contentEncoding": "int32" }, "eventId": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelEventId" }, { "description": "The identifier of the record that is associated with this StatementEntry." } ] }, "originalEventId": { "type": "string", "description": "ID of the original event." }, "originalEvent": { "type": "integer", "description": "The type of original event that triggered this StatementEntry resource.\n\n
\nValid Values\n\n- `1` - **DAYS.** The StatementEntry is triggered by a daily event.\n- `2` - **WEEKS.** The StatementEntry is triggered by a weekly event.\n- `3` - **MONTHS.** The StatementEntry is triggered by a monthly event.\n- `4` - **YEARS.** The StatementEntry is triggered by an annual event.\n- `5` - **SINGLE.** The StatementEntry is triggered by a one-off event.\n- `6` - **AUTH.** The StatementEntry is triggered when a transaction has been authorized.\n- `7` - **CAPTURE.** The StatementEntry is triggered when a transaction has been captured.\n- `8` - **REFUND.** The StatementEntry is triggered when a refund transaction is processed.\n- `9` - **BOARD.** The StatementEntry is triggered when a Merchant is boarded.\n- `10` - **PAYOUT.** The StatementEntry is triggered when a payout is processed.\n- `11` - **CHARGEBACK.** The StatementEntry is triggered when a card chargeback occurs.\n- `12` - **OVERDRAFT.** The StatementEntry is triggered when an overdraft usage charge from a bank is levied.\n- `13` - **INTERCHANGE.** The StatementEntry is triggered when interchange Fees are assessed for the Transactions of this Merchant.\n- `14` - **PROCESSOR.** The StatementEntry is triggered when the Transactions of this Merchant are processed by a payment processor.\n- `15` - **ACHFAIL.** The StatementEntry is triggered when an automated clearing house failure occurs.\n- `16` - **ACCOUNT.** The StatementEntry is triggered when a bank account is verified.\n- `17` - **SIFT.** The StatementEntry is triggered by a transaction's fraud Score.\n- `18` - **ADJUSTMENT.** The StatementEntry is triggered when there's an adjustment.\n- `19` - **RETRIEVAL.** The StatementEntry is triggered by a retrieval request chargeback.\n- `20` - **ARBITRATION.** The StatementEntry is triggered by an arbitration chargeback.\n- `21` - **ECSALE.** The StatementEntry is triggered by an eCheck sale transaction.\n- `22` - **ECREFUND.** The StatementEntry is triggered by an eCheck refund.\n- `23` - **ECRETURN.** The StatementEntry is triggered by an eCheck return.\n- `24` - **SETTLEMENT.** The StatementEntry triggers when a transaction has been settled.\n- `25` - **MISUSE.** The StatementEntry is triggered when there's been a Misuse of authorization.\n- `26` - **PROFIT_SHARE.** The StatementEntry is triggered by a profit sharing entry event.\n- `27` - **UNAUTH.** The StatementEntry is triggered when a transaction is unauthorized.\n- `28` - **ACHNOC.** The StatementEntry is triggered by a disbursement NOC (Notification of change).\n- `29` - **ECNOC.** The StatementEntry is triggered by an echeck transaction NOC (Notification of change).\n- `30` - **ECFAIL.** The StatementEntry is triggered by an echeck transaction failed.\n- `31` - **ECNSF.** The StatementEntry is triggered by an eCheck transaction NSF (Non-sufficient funds) return.\n- `32` - **CURRENCY_CONVERSION.** This StatementEntry is triggered by a currency conversion.\n- `33` - **TERMINAL_TXN.** This StatementEntry is triggered by a terminal transaction.\n- `34` - **REVERSE_PAYOUT.** This StatementEntry is triggered by a payout that has been reversed.\n- `35` - **PARTIAL_REVERSE_PAYOUT.** This StatementEntry is triggered by a payout that has been partially reversed.\n- `43` - **PAYMENT_CHECK.** This StatementEntry is triggered by a payment check for Account Updater.\n- `44` - **PAYMENT_UPDATE.** This StatementEntry is triggered by a payment update for Account Updater.\n- `45` - **PAYMENT_GROUP_CHECK.** This StatementEntry is triggered by a payment group check for Account Updater.\n- `46` - **PAYMENT_GROUP_UPDATE.** This StatementEntry is triggered by a payment group update for Account Updater.\n- `47` - **ENTRY_REFUND.** This StatementEntry is triggered by an entry refund.\n- `51` - **STATEMENT.** The StatementEntry for an Entry related to the payment of a statement.\n- `52` - **MERCHANT_CREATION.** The StatementEntry for an Entry related to a merchant fee upon creation.\n- `53` - **REALTIME_BUSINESS_SEARCH.** The StatementEntry for an Entry related to a real-time business search.\n- `54` - **REALTIME_MEMBER_SEARCH.** The StatementEntry for an Entry related to a real-time member search.\n- `55` - **MASTER_CARD_MATCH.** The StatementEntry for an Entry related to Mastercard match.\n- `56` - **BUSINESS_INSTANT_ID.** The StatementEntry for an Entry related to a business instant ID.\n- `57` - **CONSUMER_INSTANT_ID.** The StatementEntry for an Entry related to a consumer instant ID.\n- `58` - **THREAT_METRIX.** The StatementEntry for an Entry related to Threat Metrix.\n- `59` - **LEGIT_SCRIPT_REGISTER.** The StatementEntry for an Entry related to Legit Script Register.\n- `60` - **EQUIFAX_CONSUMER_REPORT.** The StatementEntry for an Entry related to Equifax consumer report.\n- `61` - **GUIDE_STAR.** The StatementEntry for an Entry related to Guide Star.\n- `62` - **PAYLOAD_ATTRIBUTE.** The StatementEntry for an Entry related to internal decision V2.\n- `63` - **TIN_CHECK.** The StatementEntry for an Entry related to a Tin Check.\n- `64` - **EQUIFAX_COMMERCIAL_REPORT.** The StatementEntry for an Entry related to Equifax commercial report.\n- `65` - **LEGIT_SCRIPT_CHECK_MERCHANT.** The StatementEntry for an Entry related to Legit Script Check Merchant.\n- `66` - **PLAID.** The StatementEntry for an Entry related to Plaid.\n- `67` - **STATEMENT_REVERSAL.** The StatementEntry for an Entry related to the reversal of a statement.\n- `68` - **GIACT_ECHECK.** The StatementEntry for an Entry related to GIACT call made to verify creator Echeck bank account.\n- `69` - **GIACT_BANK_ACCOUNT.** The StatementEntry for an Entry related to Giact calls to verify merchant settlement account.\n- `70` - **BOARD_DECISION.** The StatementEntry for an Entry related to process decision fee after board.\n- `71` - **TXN_RISK_DECISION.** The StatementEntry for an Entry related to a transaction going through a risk decision.\n- `72` - **FANF.** The StatementEntry for an Entry related to external fees.\n- `73` - **MCLOCATION.** The StatementEntry for an Entry related to external fees.\n- `74` - **VISAINTEGRITY.** The StatementEntry for an Entry related to external fees.\n- `75` - **SAFERPAYMENTS_BASIC.** The StatementEntry for an Entry related to external fees.\n- `76` - **SAFERPAYMENTS_MANAGED.** The StatementEntry for an Entry related to external fees.\n- `77` - **SAFERPAYMENTS_PCI_NONVALIDATION.** The StatementEntry for an Entry related to external fees.\n- `78` - **OMNITOKENS_VOLUME.** The StatementEntry for an Entry related to external fees.\n- `79` - **PAYOUT_RETURN.** The StatementEntry for an Entry related to a payout return.\n- `80` - **PAYOUT_PARTIAL_RETURN.** The StatementEntry for an Entry related to a partial payout return.\n- `81` - **REV_SHARE.** The StatementEntry for an Entry related to revenue sharing.\n- `82` - **CARD_SETTLEMENT.** The StatementEntry for an Entry related to card settlement.\n- `83` - **ECHECK_SETTLEMENT.** The StatementEntry for an Entry related to e-check settlement.\n- `84` - **REV_SHARE_CARD.** The StatementEntry for an Entry related to revenue sharing for cards.\n- `85` - **REV_SHARE_ECHECK.** The StatementEntry for an Entry related to revenue sharing for e-checks.\n- `86` - **REV_SHARE_DBM.** The StatementEntry for an Entry related to revenue sharing for DBM.\n- `87` - **PREARBITRATION.** The StatementEntry for an Entry related to chargeback pre-arbitration.\n- `88` - **PLAID_IDENTITY_MACH.** The StatementEntry for an Entry related to Plaid Identity Mach.\n- `89` - **TXN_PLAID_IDENTITY_MACH.** The StatementEntry for an Entry related to transactions with Plaid Identity Mach.\n- `90` - **PLAID_GET_IDENTITY.** The StatementEntry for an Entry related to Plaid Get Identity.\n- `91` - **TXN_PLAID_GET_IDENTITY.** The StatementEntry for an Entry related to transactions with Plaid Get Identity.\n- `92` - **PLAID_GET_AUTH.** The StatementEntry for an Entry related to Plaid Get Auth.\n- `93` - **TXN_PLAID_GET_AUTH.** The StatementEntry for an Entry related to transactions with Plaid Get Auth.\n- `94` - **REVERSAL.** The StatementEntry for an Entry related to chargeback reversal.\n- `95` - **REPRESENTMENT.** The StatementEntry for an Entry related to chargeback representment.\n- `96` - **OMNITOKENS_MONTHLY.** The StatementEntry for an Entry related to Omnitokens Monthly Fee.\n- `101` - **IC_RETAIN_PASSTHRU_REFUND.** The StatementEntry for an Entry related to interchange retain pass-through refund.\n- `200` - **VALUTEC_ESSENTIAL_GIFT.** The StatementEntry for an Entry related to external fees.\n- `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN.** The StatementEntry for an Entry related to external fees.\n- `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE.** The StatementEntry for an Entry related to external fees.\n- `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN.** The StatementEntry for an Entry related to external fees.\n- `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE.** The StatementEntry for an Entry related to external fees.\n- `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN.** The StatementEntry for an Entry related to external fees.\n- `206` - **VALUTEC_TRANSACTION_FEE.** The StatementEntry for an Entry related to external fees.\n- `207` - **VALUTEC_SETUP_FEE.** The StatementEntry for an Entry related to external fees.\n- `208` - **VALUTEC_GIFT_ACH_POOLING.** The StatementEntry for an Entry related to external fees.\n- `209` - **VALUTEC_JUMP_START_KIT.** The StatementEntry for an Entry related to external fees.\n- `210` - **VALUTEC_LAUNCH_BOX_KIT.** The StatementEntry for an Entry related to external fees.\n- `211` - **VALUTEC_500_CUSTOM_CARDS.** The StatementEntry for an Entry related to external fees.\n- `212` - **VALUTEC_MAINTENANCE_FEE.** The StatementEntry for an Entry related to external fees.\n- `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME.** The StatementEntry for an Entry related to external fees.\n- `214` - **EFE_MWC_RESIDUAL_ATELIO.** The StatementEntry for an Entry related to EFE external fees.\n- `215` - **EFE_MWC_RESIDUAL_PARAFIN.** The StatementEntry for an Entry related to EFE external fees.\n- `216` - **EFE_MWC_BILLING.** The StatementEntry for an Entry related to EFE external fees.\n- `217` - **FRAUDSIGHT_CNP_DECISION.** The StatementEntry for an Entry related to external fees.\n- `218` - **FRAUDSIGHT_CP_DECISION.** The StatementEntry for an Entry related to external fees.\n- `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY.** The StatementEntry for an Entry related to external fees.\n- `401` - **REVBOOST_EMBEDDED_TMS_PPT.** The StatementEntry for an Entry related to external fees.\n- `402` - **TXN_THREAT_METRIX.** The StatementEntry for an Entry related to external fees.\n- `403` - **THREAT_METRIX_EMAILAGE.** The StatementEntry for an Entry related to external fees.\n- `404` - **THREAT_METRIX_FRAUD_POINT.** The StatementEntry for an Entry related to external fees.\n- `405` - **GIACT_INQUIRY.** The StatementEntry for an Entry related to external fees.\n- `406` - **GIACT_TXN_GAUTHENTICATE.** The StatementEntry for an Entry related to external fees.\n- `407` - **TRULIOO_IDV.** The StatementEntry for an Entry related to external fees.\n- `408` - **TRULIOO_AMLLDV.** The StatementEntry for an Entry related to external fees.\n- `409` - **TRULIOO_BUSINESS_VERIFICATION.** The StatementEntry for an Entry related to external fees.\n- `410` - **THREAT_METRIX_PHONE_FINDER.** The StatementEntry for an Entry related to external fees.\n- `601` - **TIER_NON_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.\n- `602` - **TIER_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.\n- `603` - **TIER_MID_QUALIFIED_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.\n- `604` - **TIER_HIGH_RISK_COUNT.** The StatementEntry for an Entry related to risk-based tier fees.\n- `605` - **TIER_NON_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.\n- `606` - **TIER_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.\n- `607` - **TIER_MID_QUALIFIED_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.\n- `608` - **TIER_HIGH_RISK_VOLUME.** The StatementEntry for an Entry related to risk-based tier fees.", "contentEncoding": "int32" }, "description": { "type": "string", "description": "A description of this StatementEntry." }, "amount": { "type": "number", "description": "The amount involved in this StatementEntry. It refers to the amount charged, transferred, or disbursed. This field is specified in cents(up to three decimal points)." }, "deductedFromBalance": { "allOf": [ { "$ref": "#/$defs/statementEntriesDeductedFromBalance" }, { "description": "Whether or not the amount was deducted from the paying entity's balance and is already paid for. \n\n
\n Valid Values\n\n - `0` - **Not deducted from balance.** \n\n - `1` - **Deducted from balance.**\n\n
" } ] }, "revShareStatement": { "allOf": [ { "$ref": "#/$defs/statementEntriesModelRevShareStatement" }, { "description": "If the activity that this StatementEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource" } ] } } }, "statementStatus": { "title": "statementStatus", "enum": [ "pending", "processing", "partiallyPaid", "paid", "partiallyCancelled", "cancelled" ], "type": "string" }, "statementsModelBilling": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/billingsResponse" } ], "description": "The identifier of the Billing of this statement resource." }, "statementsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The paying entity for which this statement applies." }, "statementsModelForentity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The payee entity of the statement." }, "statementsResponse": { "title": "statementsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "billing": { "allOf": [ { "$ref": "#/$defs/statementsModelBilling" }, { "description": "The identifier of the Billing of this statement resource." } ] }, "entity": { "allOf": [ { "$ref": "#/$defs/statementsModelEntity" }, { "description": "The paying entity for which this statement applies." } ] }, "start": { "type": "integer", "description": "The date on which this Statement period should start. 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 Statement period should finish. The date is specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016.", "contentEncoding": "int32" }, "status": { "allOf": [ { "$ref": "#/$defs/statementStatus" }, { "description": "The current status of the statement.\n\n
\nValid Values\n\n- `pending` - **Statement amount is owed and is pending payment.**\n- `processing` - **A payment is processing for this statement, pending completion.**\n- `partiallyPaid` - **The statement was partially paid, some amount is still outstanding.**\n- `paid` - **The statement was paid in full.**\n- `partiallyCancelled` - **The statement was partially cancelled, some amount is still outstanding.**\n- `cancelled` - **The statement was completely cancelled and is no longer due for payment.**\n\n
" } ] }, "totalPaid": { "type": "integer", "description": "The total paid amount for this statement, specified as an integer in cents.", "contentEncoding": "int64" }, "total": { "type": "integer", "description": "The total amount for this statement. This field is specified as an integer in cents.", "contentEncoding": "int64" }, "currency": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/currency" } ] }, { "description": "The currency for this statement. See Currency codes for all valid values." } ] }, "forentity": { "allOf": [ { "$ref": "#/$defs/statementsModelForentity" }, { "description": "The payee entity of the statement." } ] }, "disbursements": { "type": "array", "items": { "$ref": "#/$defs/disbursementsResponse" }, "description": "" }, "entries": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" }, "pendingEntries": { "type": "array", "items": { "$ref": "#/$defs/pendingEntriesResponse" }, "description": "" }, "statementEntries": { "type": "array", "items": { "$ref": "#/$defs/statementEntriesResponse" }, "description": "" }, "txns": { "type": "array", "items": { "$ref": "#/$defs/txnsResponse" }, "description": "" } } }, "status": { "title": "status", "enum": [ "0", "1", "2" ], "type": "string" }, "subscriptionOrigin": { "title": "subscriptionOrigin", "enum": [ 2, 3, 4, 5, 6, 8 ], "type": "integer" }, "subscriptionTokensModelSubscription": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/subscriptionsResponse" } ], "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." }, "subscriptionTokensModelToken": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/tokensResponse" } ], "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." }, "subscriptionTokensResponse": { "title": "subscriptionTokensResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "subscription": { "allOf": [ { "$ref": "#/$defs/subscriptionTokensModelSubscription" }, { "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/subscriptionTokensModelToken" }, { "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
" } ] } } }, "subscriptionsModelFirstTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identification of the first transaction processed through this subscription. This is used internally to process subsequent transactions." }, "subscriptionsModelPlan": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/plansResponse" } ], "description": "The identifier of the Plan that this Subscription is associated with. The Plan determines the frequency and amount of each payment." }, "subscriptionsModelStatementEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "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." }, "subscriptionsResponse": { "title": "subscriptionsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "plan": { "allOf": [ { "$ref": "#/$defs/subscriptionsModelPlan" }, { "description": "The identifier of the Plan that this Subscription is associated with. The Plan determines the frequency and amount of each payment." } ] }, "statementEntity": { "allOf": [ { "$ref": "#/$defs/subscriptionsModelStatementEntity" }, { "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": { "allOf": [ { "$ref": "#/$defs/subscriptionsModelFirstTxn" }, { "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
" } ] }, "invoices": { "type": "array", "items": { "$ref": "#/$defs/invoicesResponse" }, "description": "" }, "subscriptionTokens": { "type": "array", "items": { "$ref": "#/$defs/subscriptionTokensResponse" }, "description": "" } } }, "teamLoginCreate": { "title": "teamLoginCreate", "enum": [ 0, 1 ], "type": "integer" }, "teamLoginDelete": { "title": "teamLoginDelete", "enum": [ 0, 1 ], "type": "integer" }, "teamLoginModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this resource." }, "teamLoginModelTeam": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/teamsResponse" } ], "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" }, "teamLoginResponse": { "title": "teamLoginResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/teamLoginModelLogin" }, { "description": "The Login that owns this resource." } ] }, "team": { "allOf": [ { "$ref": "#/$defs/teamLoginModelTeam" }, { "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
" } ] } } }, "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" }, "teamsModelLogin": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/loginsResponse" } ], "description": "The Login that owns this Team." }, "teamsResponse": { "title": "teamsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "allOf": [ { "$ref": "#/$defs/teamsModelLogin" }, { "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
" } ] }, "aggregations": { "type": "array", "items": { "$ref": "#/$defs/aggregationsResponse" }, "description": "" }, "alerts": { "type": "array", "items": { "$ref": "#/$defs/alertsResponse" }, "description": "" }, "teamLogins": { "type": "array", "items": { "$ref": "#/$defs/loginsResponse" }, "description": "" }, "orgFlows": { "type": "array", "items": { "$ref": "#/$defs/orgFlowsResponse" }, "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" }, "terminalRefsProcessor": { "title": "terminalRefsProcessor", "enum": [ "APPLE", "ELAVON", "FIRSTDATA", "GOOGLE", "VANTIV", "VCORE", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY", "TDBANKCA" ], "type": "string" }, "terminalRefsResponse": { "title": "terminalRefsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "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
" } ] } } }, "terminalStatus": { "title": "terminalStatus", "enum": [ 0, 1 ], "type": "integer" }, "terminalTxnMetadataType": { "title": "terminalTxnMetadataType", "enum": [ "amounts", "emv", "network", "timeout", "firstTxn", "discretionary" ], "type": "string" }, "terminalTxnOrigin": { "title": "terminalTxnOrigin", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer" }, "terminalTxnPaymentMethod": { "title": "terminalTxnPaymentMethod", "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" }, "terminalTxnRefStage": { "title": "terminalTxnRefStage", "enum": [ "activation", "auth", "draft", "file", "retrieval", "acquirerTxnId", "origTxnId" ], "type": "string" }, "terminalTxnRefsResponse": { "title": "terminalTxnRefsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "terminalTxn": { "type": "string", "description": "The parent terminalTxn that owns this terminalTxnRef and to which this reference applies A single terminalTxn may have many terminalTxnRef records." }, "ref": { "type": "string", "description": "The reference value retrieved from the third party." }, "stage": { "allOf": [ { "$ref": "#/$defs/terminalTxnRefStage" }, { "description": "An indicator showing what this terminalTxnRef refers to.\n\n
\nValid Values\n\n- `activation` - **Terminal Activation**\n- `auth` - **Transaction Authorization**\n- `draft` - **Transaction Draft Number**\n- `file` - **Import File Ref**\n- `retrieval` - **Transaction Retrieval Number**\n- `acquirerTxnId` - **A unique identifier created by the acquirer to track and reconcile a specific transaction throughout its lifecycle.**\n- `origTxnId` - **The identifier of the original transaction, used to link related actions such as refunds, reversals, or adjustments back to the initial payment.**\n\n
" } ] }, "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
" } ] } } }, "terminalTxnReserved": { "title": "terminalTxnReserved", "const": 0, "type": "integer" }, "terminalTxnResultType": { "title": "terminalTxnResultType", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer" }, "terminalTxnResultsBankCode": { "title": "terminalTxnResultsBankCode", "enum": [ "accepted_but_not_yet_processed", "account_blocked", "account_is_purged", "account_locked", "account_on_hold_or_not_active", "account_not_activated", "account_reloads_exceeded", "account_row_locked", "account_status_is_void_lock", "ach_payment_not_accepted", "acquirer_channel_unavailable", "activation_failed", "additive_limit_exceeded", "zip_match_address_mismatch", "zip_match_address_not_verified", "already_redeemed", "already_reversed", "amount_limit_exceeded", "amount_too_large", "approve_with_id", "approved", "approved_emv_key_load", "approved_with_no_cash", "approved_with_overdraft", "authorization_id_needed", "bad_account", "bad_checksum", "bad_close", "bad_mag_stripe", "bad_post_date", "bad_repay_date", "balance_not_available", "bill_to_ship_to_mismatch", "bin_blocked", "blocked_by_cardholder", "bulk_activation_error", "bulk_activation_package_amount_error", "call_acquirer", "call_for_authorization", "call_issuer", "call_telecheck", "cannot_find_network", "card_already_active", "card_already_closed", "card_not_active", "card_not_supported", "card_velocity_amount_exceeded", "card_velocity_count_exceeded", "card_velocity_exceeded", "cashback_greater_than_transaction_amount", "cash_limit_exceeded", "center_closed", "checker/manager_not_found", "chip_failure", "close_unavailable", "close_not_valid", "closed_account", "count_exceeds_limit", "counterfeit_card", "counter_offer_to_supply_personal_guaranty", "cryptogram_decryption_error", "crypto_box_is_offline", "currency_conversion_complete", "currency_conversion_error", "currency_not_supported", "customer_cancellation", "customer_opt_out", "cut_time_close_to_1400", "cvv_declined", "cvv_failed", "daily_limit_exceeded", "date_of_birth_error", "debit_gateway_unavailable", "declined", "declined_due_to_stand_in_rules", "deconverted_bin", "do_not_honor", "do_not_try_again", "do_not_try_again_subsequent_may_continue", "drivers_license_or_id_required", "duplicate_capture", "duplicate_return", "duplicate_reversal", "duplicate_transaction", "edit_honor", "email_no_match", "email_unavailable", "emv_key_download_error", "enter_lesser_amount", "error_processing_pin_block", "exceeds_global_amount_for_period_pay_inside", "exceeds_global_count_for_period_pay_inside", "exceeds_global_limits_for_period_pay_inside", "exceeds_limit", "exceeds_merchant_amount_for_period_pay_inside", "exceeds_merchant_count_for_period_pay_inside", "exceeds_merchant_limits_for_period_pay_inside", "exceeds_state_amount_for_period_pay_inside", "exceeds_state_count_for_period_pay_inside", "exceeds_state_limits_for_period_pay_inside", "exceeds_transaction_count_or_amount_limit_in_24_hours", "exceeds_transaction_count_or_amount_limit_in_7_days", "exceeds_transaction_count_or_amount_limit_in_30_days", "exceeds_zip_code_amount_for_period_pay_inside", "exceeds_zip_code_count_for_period_pay_inside", "exceeds_zip_code_limits_for_period_pay_inside", "expired_card", "expired_lock", "fraudulent", "file_temporarily_unavailable", "file_update_error", "file_update_unavailable", "format_error", "forward_to_issuer", "fuel_limit_exceeded", "fuel_only", "fuel_price_error", "full_ssn_required", "function_not_supported", "funds_on_hold", "general", "general_error", "generic_decline", "hard_capture_pickup_card", "hard_negative_info_on_file", "high_risk", "hold_shipping_for_24h", "honor_with_authentication", "illegal_transaction", "imprint_card", "incorrect_cvv", "incorrect_number", "incorrect_pin", "incorrect_merchant_location", "incorrect_transaction_version", "inquiry_declined", "insufficient_data", "insufficient_funds", "insufficient_security", "internet_access_disabled", "invalid_3d_password", "invalid_account", "invalid_account/date", "invalid_account_type", "invalid_activate", "invalid_amount", "invalid_authorization_code", "invalid_batch_number/id", "invalid_cashback", "invalid_checking_account", "invalid_checking_account_number", "invalid_credit_account", "invalid_clerk", "invalid_currency", "invalid_cvv", "invalid_date_or_time", "invalid_driver", "invalid_ean_or_scv", "invalid_effective_date", "invalid_email_address", "invalid_entry", "invalid_expiry_date", "invalid_expiry_year", "invalid_host", "invalid_location", "invalid_maiden_name", "invalid_mcc", "invalid_merchant", "invalid_merchant_id", "invalid_merchant_id/se", "invalid_merchant_setup", "invalid_micr_data", "invalid_new_password", "invalid_not_present", "invalid_number", "invalid_odometer", "invalid_password", "invalid_pin", "invalid_pos", "invalid_preapproval_number", "invalid_prefix", "invalid_product", "invalid_prompt_entry", "invalid_request", "invalid_response", "invalid_response_date", "invalid_restriction_code", "invalid_savings_account", "invalid_secure_payment_data", "invalid_sku", "invalid_ssn", "invalid_state_code", "invalid_status_change", "invalid_terminal", "invalid_tgn_cic", "invalid_timezone", "invalid_tppid", "invalid_track_data", "invalid_transaction", "invalid_transarmor_transaction", "invalid_user", "invalid_value_in_the_field", "invalid_vehicle", "invalid_void_of_activation", "invalid_zip_code", "issuance_under_minimum_amount", "issuer_not_available", "issuer_processor_or_switch_not_available", "issuer_special_conditions", "issuer_velocity_amount_exceeded", "issuer_velocity_count_exceeded", "late_reversal", "law_violation", "limit_check_failed", "lost_card", "maiden_name_unavailable", "manual_tries_exceeded", "match", "max_balance_exceeded", "merchant_depleted", "merchant_has_mail_pending", "message_format_error", "minus2_debit", "missing_conditional_data", "missing_customer_service_phone", "missing_from_account", "missing_to_account", "multi_currency_dcc_fail", "multi_currency_invert_fail", "multiple_accounts_for_type", "name_email_no_match", "name_email_unavailable", "name_no_match", "name_phone_no_match", "name_phone_unavailable", "name_unavailable", "negative_file_exception", "new_account_information_available", "new_card_issued", "new_password_required", "no_account_link", "no_action_taken", "no_card_record", "no_chain_id", "no_checking_account", "mismatch", "no_messages_pending", "no_open_batch", "no_phone_service", "no_previous_transaction", "no_reason_to_decline", "no_savings_account", "no_such_issuer", "no_to_account", "no_transactions_available", "no_transaction_security_record", "not_accepted", "not_active", "not_lost_or_stolen", "not_on_file", "not_permitted", "not_performed", "not_processed", "not_supported", "nsf", "one_time_stop_payment", "original_authorization_mismatch", "original_authorization_not_found", "original_repeated", "original_transaction_not_approved", "over_chain_daily_velocity_amount", "over_chain_daily_velocity_count", "over_chain_daily_velocity_limits", "over_chain_product_velocity_amount", "over_chain_product_velocity_count", "over_chain_product_velocity_limits", "over_max_balance", "over_merchandise_limit", "over_merchant_daily_velocity_amount", "over_merchant_daily_velocity_count", "over_merchant_daily_velocity_limits", "over_merchant_product_velocity_amount", "over_merchant_product_velocity_count", "over_merchant_product_velocity_limits", "over_monthly_limit", "over_non_fuel_limit", "pan_trans_error", "partial_auth_not_allowed", "partial_reversal", "partially_approved", "password_retries_exceeded", "pay_at_pump_not_allowed", "phone_email_no_match", "phone_email_unavailable", "phone_no_match", "phone_unavailable", "pickup_card", "pin_already_exists", "pin_key_error", "pin_key_sychronization_error", "pin_try_exceeded", "please_retry", "process_as_debit", "processing_error", "product_code_restricted", "promo_location_restricted", "quantity_exceeded", "reauthorization_timeframe_expired", "recharge_amount_exceeded", "recharge_count_exceeded", "reenter_transaction", "referral", "reject_message", "rejected_lost/stolen_checks", "repair_limit_exceeded", "request_in_progress", "response_received_late", "restricted_card", "resubmission_violates_network_frequency", "retain_card", "reversal", "reversal_no_match", "reversal_unsuccessful", "revocation_of_all_authorizations", "revocation_of_authorization", "secure_code_not_enabled", "security_error", "security_error_try_again", "security_violation", "see_attendant", "see_exhibit_for_error", "service_not_allowed", "signature_required", "skip_trace_info", "soft_descriptor_not_enabled", "ssn_not_available", "stolen_card", "stop_payment_order", "stop_recurring_payment_requests", "store_location_zero_not_allowed", "subsystem_unavailable", "surcharge_limit_exceeded", "system_error", "target_card_and_transaction_count_mismatch", "terminal_transaction_number_mismatch", "testmode_decline", "ticket_limit_exceeded", "timeout", "timeout_reversal_not_supported", "too_many_transactions_requested", "totals_unavailable", "transaction_count_or_withdrawal_limit_exceeded", "transaction_destination_not_found_for_routing", "transaction_history_unavailable", "transaction_not_allowed", "transaction_not_permitted", "transaction_not_supported", "transaction_total_limit_per_product_class_exceeded", "transarmor_invalid_token_or_account_number", "transarmor_key_error", "transarmor_service_unavailable", "try_again_later", "unable_to_locate_previous_message", "unable_to_locate_record", "unable_to_process", "unable_to_verify_pin", "unauthorized", "unavailable", "undefined_card", "underage_customer", "unknown_velocity_error_pay_inside", "unsuccessful", "unsupported_message", "validation_error", "velocity_error_pay_inside", "verification_transaction", "violation_of_business_arrangement", "visa_oct/mastercard_moneysend_transactions_blocked", "void_captured_item", "voyager_id_problem", "y_or_n_required", "wait_2_pm_eastern", "withdrawal_count_limit_exceeded", "withdrawal_limit_exceeded", "zip_address_not_verified", "zip_and_address_not_verified", "zip_no_match", "address_match_zip_mismatch", "zip_not_verified", "3ds_authentication_successful", "3ds_authentication_invalid", "3ds_authentication_failed", "3ds_authentication_not_validated", "3ds_authentication_successful_without_liability_shift" ], "type": "string" }, "terminalTxnResultsModelTerminalTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/terminalTxnsResponse" } ], "description": "The identifier of the TerminalTxn associated with this terminalTxnResults resource." }, "terminalTxnResultsResponse": { "title": "terminalTxnResultsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "terminalTxn": { "allOf": [ { "$ref": "#/$defs/terminalTxnResultsModelTerminalTxn" }, { "description": "The identifier of the TerminalTxn associated with this terminalTxnResults resource." } ] }, "type": { "allOf": [ { "$ref": "#/$defs/terminalTxnResultType" }, { "description": "The type of this terminalTxnResult.\n\n
\nValid Values\n\n- `1` - **A general type of result.**\n- `2` - **Fraud prevention alert.**\n- `3` - **Processor error.**\n- `4` - **CVV matching alert.**\n- `5` - **AVS check alert.**\n- `6` - **AAVS check alert.**\n- `7` - **Network error.**\n- `8` - **3DS check alert.**\n\n
" } ] }, "message": { "type": "string", "description": "A message that accompanies and describes this Transaction result." }, "code": { "allOf": [ { "$ref": "#/$defs/terminalTxnsResultCode" }, { "description": "The result code that is associated with this terminal TxnResult. \n
\nValid Values \n- `0` - **Transaction approved.**\n- `1` - **Partially approved. The processor has only approved a portion of the total transaction amount.**\n- `2` - **Declined. The processor has declined the Transaction.**\n- `3` - **Verification successful, values provided matched.**\n- `4` - **Verification unsuccessful, values provided did not match.**\n- `5` - **The ZIP code in the Transaction data does not match the customer details held by the card issuer.**\n- `6` - **The address in the Transaction data does not match the customer details held by the card issuer.**\n- `7` - **The name in the Transaction data does not match the customer details held by the card issuer.**\n- `8` - **The name and phone number in the Transaction data do not match the details held by the card issuer.**\n- `9` - **The name and email address in the Transaction data do not match the customer details held by the card issuer.**\n- `10` - **The phone number in the Transaction data does not match the customer details held by the card issuer.**\n- `11` - **The phone number and email address in the Transaction data do not match the customer details held by the card issuer.**\n- `12` - **The email address in the Transaction data does not match the customer details held by the card issuer.**\n- `13` - **The customer name could not be found in the Transaction data.**\n- `14` - **The customer name and phone number were not found in the Transaction data.**\n- `15` - **The customer name and email address were not found in the Transaction data.**\n- `16` - **The customer phone number was not found in the Transaction data.**\n- `17` - **The customer phone number and email address were not found in the Transaction data.**\n- `18` - **The customer email address was not found in the Transaction data.**\n- `19` - **Information about the customer was not found in the Transaction data.**\n- `20` - **Non-sufficient funds. The customer did not have sufficient credit or balance to cover the Transaction.**\n- `21` - **The account in the Transaction data is not valid.**\n- `22` - **The account is unauthorized.**\n- `23` - **General error.**\n- `24` - **The ZIP code in the Transaction data was not verified.**\n- `25` - **The ZIP code and the Address in the Transaction data were not verified.**\n- `26` - **The Address in the Transaction data was not verified.**\n- `27` - **Txn did not fail but was not captured.**\n- `28` - **3DS authentication passed.**\n- `29` - **3DS authentication is invalid.**\n- `30` - **3DS authentication failed.**\n- `31` - **3DS authentication was not validated.**\n- `32` - **3DS authentication passed without liability shift.**\n- `33` - **Transaction processing timed out.**\n- `34` - **Transaction cancelled \n
" } ] }, "originalCode": { "type": "string", "description": "Exact message code as received from the activation integration or from the processor for the resulting transaction." }, "bankCode": { "allOf": [ { "$ref": "#/$defs/terminalTxnResultsBankCode" }, { "description": "Exact message code as received from the activation integration or\nfrom the processor for the resulting transaction.\n\n
\nValid Values\n\n- `ACCEPTED_BUT_NOT_YET_PROCESSED` - **accepted_but_not_yet_processed**\n- `ACCOUNT_BLOCKED` - **account_blocked**\n- `ACCOUNT_IS_PURGED` - **account_is_purged**\n- `ACCOUNT_LOCKED` - **account_locked**\n- `ACCOUNT_ON_HOLD_OR_NOT_ACTIVE` - **account_on_hold_or_not_active**\n- `ACCOUNT_NOT_ACTIVATED` - **account_not_activated**\n- `ACCOUNT_RELOADS_EXCEEDED` - **account_reloads_exceeded**\n- `ACCOUNT_ROW_LOCKED` - **account_row_locked**\n- `ACCOUNT_STATUS_IS_VOID_LOCK` - **account_status_is_void_lock**\n- `ACH_PAYMENT_NOT_ACCEPTED` - **ach_payment_not_accepted**\n- `ACQUIRER_CHANNEL_UNAVAILABLE` - **acquirer_channel_unavailable**\n- `ACTIVATION_FAILED` - **activation_failed**\n- `ADDITIVE_LIMIT_EXCEEDED` - **additive_limit_exceeded**\n- `ADDRESS_NO_MATCH` - **zip_match_address_mismatch**\n- `ADDRESS_NOT_VERIFIED` - **zip_match_address_not_verified**\n- `ALREADY_REDEEMED` - **already_redeemed**\n- `ALREADY_REVERSED` - **already_reversed**\n- `AMOUNT_LIMIT_EXCEEDED` - **amount_limit_exceeded**\n- `AMOUNT_TOO_LARGE` - **amount_too_large**\n- `APPROVE_WITH_ID` - **approve_with_id**\n- `APPROVED` - **approved**\n- `APPROVED_EMV_KEY_LOAD` - **approved_emv_key_load**\n- `APPROVED_WITH_NO_CASH` - **approved_with_no_cash**\n- `APPROVED_WITH_OVERDRAFT` - **approved_with_overdraft**\n- `AUTHORIZATION_ID_NEEDED` - **authorization_id_needed**\n- `BAD_ACCOUNT` - **bad_account**\n- `BAD_CHECKSUM` - **bad_checksum**\n- `BAD_CLOSE` - **bad_close**\n- `BAD_MAG_STRIPE` - **bad_mag_stripe**\n- `BAD_POST_DATE` - **bad_post_date**\n- `BAD_REPAY_DATE` - **bad_repay_date**\n- `BALANCE_NOT_AVAILABLE` - **balance_not_available**\n- `BILL_TO_SHIP_TO_MISMATCH` - **bill_to_ship_to_mismatch**\n- `BIN_BLOCKED` - **bin_blocked**\n- `BLOCKED_BY_CARDHOLDER` - **blocked_by_cardholder**\n- `BULK_ACTIVATION_ERROR` - **bulk_activation_error**\n- `BULK_ACTIVATION_PACKAGE_AMOUNT_ERROR` - **bulk_activation_package_amount_error**\n- `CALL_ACQUIRER` - **call_acquirer**\n- `CALL_FOR_AUTHORIZATION` - **call_for_authorization**\n- `CALL_ISSUER` - **call_issuer**\n- `CALL_TELECHECK` - **call_telecheck**\n- `CANNOT_FIND_NETWORK` - **cannot_find_network**\n- `CARD_ALREADY_ACTIVE` - **card_already_active**\n- `CARD_ALREADY_CLOSED` - **card_already_closed**\n- `CARD_NOT_ACTIVE` - **card_not_active**\n- `CARD_NOT_SUPPORTED` - **card_not_supported**\n- `CARD_VELOCITY_AMOUNT_EXCEEDED` - **card_velocity_amount_exceeded**\n- `CARD_VELOCITY_COUNT_EXCEEDED` - **card_velocity_count_exceeded**\n- `CARD_VELOCITY_EXCEEDED` - **card_velocity_exceeded**\n- `CASHBACK_GREATER_THAN_TRANSACTION_AMOUNT` - **cashback_greater_than_transaction_amount**\n- `CASH_LIMIT_EXCEEDED` - **cash_limit_exceeded**\n- `CENTER_CLOSED` - **center_closed**\n- `CHECKER/MANAGER_NOT_FOUND` - **checker/manager_not_found**\n- `CHIP_FAILURE` - **chip_failure**\n- `CLOSE_UNAVAILABLE` - **close_unavailable**\n- `CLOSE_NOT_VALID` - **close_not_valid**\n- `CLOSED_ACCOUNT` - **closed_account**\n- `COUNT_EXCEEDS_LIMIT` - **count_exceeds_limit**\n- `COUNTERFEIT_CARD` - **counterfeit_card**\n- `COUNTER_OFFER_TO_SUPPLY_PERSONAL_GUARANTY` - **counter_offer_to_supply_personal_guaranty**\n- `CRYPTOGRAM_DECRYPTION_ERROR` - **cryptogram_decryption_error**\n- `CRYPTO_BOX_IS_OFFLINE` - **crypto_box_is_offline**\n- `CURRENCY_CONVERSION_COMPLETE` - **currency_conversion_complete**\n- `CURRENCY_CONVERSION_ERROR` - **currency_conversion_error**\n- `CURRENCY_NOT_SUPPORTED` - **currency_not_supported**\n- `CUSTOMER_CANCELLATION` - **customer_cancellation**\n- `CUSTOMER_OPT_OUT` - **customer_opt_out**\n- `CUT_TIME_CLOSE_TO_1400` - **cut_time_close_to_1400**\n- `CVV_DECLINED` - **cvv_declined**\n- `CVV_FAILED` - **cvv_failed**\n- `DAILY_LIMIT_EXCEEDED` - **daily_limit_exceeded**\n- `DATE_OF_BIRTH_ERROR` - **date_of_birth_error**\n- `DEBIT_GATEWAY_UNAVAILABLE` - **debit_gateway_unavailable**\n- `DECLINED` - **declined**\n- `DECLINED_DUE_TO_STAND_IN_RULES` - **declined_due_to_stand_in_rules**\n- `DECONVERTED_BIN` - **deconverted_bin**\n- `DO_NOT_HONOR` - **do_not_honor**\n- `DO_NOT_TRY_AGAIN` - **do_not_try_again**\n- `DO_NOT_TRY_AGAIN_SUBSEQUENT_MAY_CONTINUE` - **do_not_try_again_subsequent_may_continue**\n- `DRIVERS_LICENSE_OR_ID_REQUIRED` - **drivers_license_or_id_required**\n- `DUPLICATE_CAPTURE` - **duplicate_capture**\n- `DUPLICATE_RETURN` - **duplicate_return**\n- `DUPLICATE_REVERSAL` - **duplicate_reversal**\n- `DUPLICATE_TRANSACTION` - **duplicate_transaction**\n- `EDIT_HONOR` - **edit_honor**\n- `EMAIL_NO_MATCH` - **email_no_match**\n- `EMAIL_UNAVAILABLE` - **email_unavailable**\n- `EMV_KEY_DOWNLOAD_ERROR` - **emv_key_download_error**\n- `ENTER_LESSER_AMOUNT` - **enter_lesser_amount**\n- `ERROR_PROCESSING_PIN_BLOCK` - **error_processing_pin_block**\n- `EXCEEDS_GLOBAL_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_amount_for_period_pay_inside**\n- `EXCEEDS_GLOBAL_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_count_for_period_pay_inside**\n- `EXCEEDS_GLOBAL_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_limits_for_period_pay_inside**\n- `EXCEEDS_LIMIT` - **exceeds_limit**\n- `EXCEEDS_MERCHANT_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_amount_for_period_pay_inside**\n- `EXCEEDS_MERCHANT_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_count_for_period_pay_inside**\n- `EXCEEDS_MERCHANT_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_limits_for_period_pay_inside**\n- `EXCEEDS_STATE_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_amount_for_period_pay_inside**\n- `EXCEEDS_STATE_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_count_for_period_pay_inside**\n- `EXCEEDS_STATE_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_limits_for_period_pay_inside**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_24_HOURS` - **exceeds_transaction_count_or_amount_limit_in_24_hours**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_7_DAYS` - **exceeds_transaction_count_or_amount_limit_in_7_days**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_30_DAYS` - **exceeds_transaction_count_or_amount_limit_in_30_days**\n- `EXCEEDS_ZIP_CODE_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_amount_for_period_pay_inside**\n- `EXCEEDS_ZIP_CODE_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_count_for_period_pay_inside**\n- `EXCEEDS_ZIP_CODE_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_limits_for_period_pay_inside**\n- `EXPIRED_CARD` - **expired_card**\n- `EXPIRED_LOCK` - **expired_lock**\n- `FRAUDULENT` - **fraudulent**\n- `FILE_TEMPORARILY_UNAVAILABLE` - **file_temporarily_unavailable**\n- `FILE_UPDATE_ERROR` - **file_update_error**\n- `FILE_UPDATE_UNAVAILABLE` - **file_update_unavailable**\n- `FORMAT_ERROR` - **format_error**\n- `FORWARD_TO_ISSUER` - **forward_to_issuer**\n- `FUEL_LIMIT_EXCEEDED` - **fuel_limit_exceeded**\n- `FUEL_ONLY` - **fuel_only**\n- `FUEL_PRICE_ERROR` - **fuel_price_error**\n- `FULL_SSN_REQUIRED` - **full_ssn_required**\n- `FUNCTION_NOT_SUPPORTED` - **function_not_supported**\n- `FUNDS_ON_HOLD` - **funds_on_hold**\n- `GENERAL` - **general**\n- `GENERAL_ERROR` - **general_error**\n- `GENERIC_DECLINE` - **generic_decline**\n- `HARD_CAPTURE_PICKUP_CARD` - **hard_capture_pickup_card**\n- `HARD_NEGATIVE_INFO_ON_FILE` - **hard_negative_info_on_file**\n- `HIGH_RISK` - **high_risk**\n- `HOLD_SHIPPING_FOR_24H` - **hold_shipping_for_24h**\n- `HONOR_WITH_AUTHENTICATION` - **honor_with_authentication**\n- `ILLEGAL_TRANSACTION` - **illegal_transaction**\n- `IMPRINT_CARD` - **imprint_card**\n- `INCORRECT_CVV` - **incorrect_cvv**\n- `INCORRECT_NUMBER` - **incorrect_number**\n- `INCORRECT_PIN` - **incorrect_pin**\n- `INCORRECT_MERCHANT_LOCATION` - **incorrect_merchant_location**\n- `INCORRECT_TRANSACTION_VERSION` - **incorrect_transaction_version**\n- `INQUIRY_DECLINED` - **inquiry_declined**\n- `INSUFFICIENT_DATA` - **insufficient_data**\n- `INSUFFICIENT_FUNDS` - **insufficient_funds**\n- `INSUFFICIENT_SECURITY` - **insufficient_security**\n- `INTERNET_ACCESS_DISABLED` - **internet_access_disabled**\n- `INVALID_3D_PASSWORD` - **invalid_3d_password**\n- `INVALID_ACCOUNT` - **invalid_account**\n- `INVALID_ACCOUNT/DATE` - **invalid_account/date**\n- `INVALID_ACCOUNT_TYPE` - **invalid_account_type**\n- `INVALID_ACTIVATE` - **invalid_activate**\n- `INVALID_AMOUNT` - **invalid_amount**\n- `INVALID_AUTHORIZATION_CODE` - **invalid_authorization_code**\n- `INVALID_BATCH_NUMBER/ID` - **invalid_batch_number/id**\n- `INVALID_CASHBACK` - **invalid_cashback**\n- `INVALID_CHECKING_ACCOUNT` - **invalid_checking_account**\n- `INVALID_CHECKING_ACCOUNT_NUMBER` - **invalid_checking_account_number**\n- `INVALID_CLERK` - **invalid_clerk**\n- `INVALID_CREDIT_ACCOUNT` - **invalid_credit_account**\n- `INVALID_CURRENCY` - **invalid_currency**\n- `INVALID_CVV` - **invalid_cvv**\n- `INVALID_DATE_OR_TIME` - **invalid_date_or_time**\n- `INVALID_DRIVER` - **invalid_driver**\n- `INVALID_EAN_OR_SCV` - **invalid_ean_or_scv**\n- `INVALID_EFFECTIVE_DATE` - **invalid_effective_date**\n- `INVALID_EMAIL_ADDRESS` - **invalid_email_address**\n- `INVALID_ENTRY` - **invalid_entry**\n- `INVALID_EXPIRY_DATE` - **invalid_expiry_date**\n- `INVALID_EXPIRY_YEAR` - **invalid_expiry_year**\n- `INVALID_HOST` - **invalid_host**\n- `INVALID_LOCATION` - **invalid_location**\n- `INVALID_MAIDEN_NAME` - **invalid_maiden_name**\n- `INVALID_MCC` - **invalid_mcc**\n- `INVALID_MERCHANT` - **invalid_merchant**\n- `INVALID_MERCHANT_ID` - **invalid_merchant_id**\n- `INVALID_MERCHANT_ID/SE` - **invalid_merchant_id/se**\n- `INVALID_MERCHANT_SETUP` - **invalid_merchant_setup**\n- `INVALID_MICR_DATA` - **invalid_micr_data**\n- `INVALID_NEW_PASSWORD` - **invalid_new_password**\n- `INVALID_NOT_PRESENT` - **invalid_not_present**\n- `INVALID_NUMBER` - **invalid_number**\n- `INVALID_ODOMETER` - **invalid_odometer**\n- `INVALID_PASSWORD` - **invalid_password**\n- `INVALID_PIN` - **invalid_pin**\n- `INVALID_POS` - **invalid_pos**\n- `INVALID_PREAPPROVAL_NUMBER` - **invalid_preapproval_number**\n- `INVALID_PREFIX` - **invalid_prefix**\n- `INVALID_PRODUCT` - **invalid_product**\n- `INVALID_PROMPT_ENTRY` - **invalid_prompt_entry**\n- `INVALID_REQUEST` - **invalid_request**\n- `INVALID_RESPONSE` - **invalid_response**\n- `INVALID_RESPONSE_DATE` - **invalid_response_date**\n- `INVALID_RESTRICTION_CODE` - **invalid_restriction_code**\n- `INVALID_SAVINGS_ACCOUNT` - **invalid_savings_account**\n- `INVALID_SECURE_PAYMENT_DATA` - **invalid_secure_payment_data**\n- `INVALID_SKU` - **invalid_sku**\n- `INVALID_SSN` - **invalid_ssn**\n- `INVALID_STATE_CODE` - **invalid_state_code**\n- `INVALID_STATUS_CHANGE` - **invalid_status_change**\n- `INVALID_TERMINAL` - **invalid_terminal**\n- `INVALID_TGN_CIC` - **invalid_tgn_cic**\n- `INVALID_TIMEZONE` - **invalid_timezone**\n- `INVALID_TPPID` - **invalid_tppid**\n- `INVALID_TRACK_DATA` - **invalid_track_data**\n- `INVALID_TRANSACTION` - **invalid_transaction**\n- `INVALID_TRANSARMOR_TRANSACTION` - **invalid_transarmor_transaction**\n- `INVALID_USER` - **invalid_user**\n- `INVALID_VALUE_IN_THE_FIELD` - **invalid_value_in_the_field**\n- `INVALID_VEHICLE` - **invalid_vehicle**\n- `INVALID_VOID_OF_ACTIVATION` - **invalid_void_of_activation**\n- `INVALID_ZIP_CODE` - **invalid_zip_code**\n- `ISSUANCE_UNDER_MINIMUM_AMOUNT` - **issuance_under_minimum_amount**\n- `ISSUER_NOT_AVAILABLE` - **issuer_not_available**\n- `ISSUER_PROCESSOR_OR_SWITCH_NOT_AVAILABLE` - **issuer_processor_or_switch_not_available**\n- `ISSUER_SPECIAL_CONDITIONS` - **issuer_special_conditions**\n- `ISSUER_VELOCITY_AMOUNT_EXCEEDED` - **issuer_velocity_amount_exceeded**\n- `ISSUER_VELOCITY_COUNT_EXCEEDED` - **issuer_velocity_count_exceeded**\n- `LATE_REVERSAL` - **late_reversal**\n- `LAW_VIOLATION` - **law_violation**\n- `LIMIT_CHECK_FAILED` - **limit_check_failed**\n- `LOST_CARD` - **lost_card**\n- `MAIDEN_NAME_UNAVAILABLE` - **maiden_name_unavailable**\n- `MANUAL_TRIES_EXCEEDED` - **manual_tries_exceeded**\n- `MATCH` - **match**\n- `MAX_BALANCE_EXCEEDED` - **max_balance_exceeded**\n- `MERCHANT_DEPLETED` - **merchant_depleted**\n- `MERCHANT_HAS_MAIL_PENDING` - **merchant_has_mail_pending**\n- `MESSAGE_FORMAT_ERROR` - **message_format_error**\n- `MINUS2_DEBIT` - **minus2_debit**\n- `MISSING_CONDITIONAL_DATA` - **missing_conditional_data**\n- `MISSING_CUSTOMER_SERVICE_PHONE` - **missing_customer_service_phone**\n- `MISSING_FROM_ACCOUNT` - **missing_from_account**\n- `MISSING_TO_ACCOUNT` - **missing_to_account**\n- `MULTI_CURRENCY_DCC_FAIL` - **multi_currency_dcc_fail**\n- `MULTI_CURRENCY_INVERT_FAIL` - **multi_currency_invert_fail**\n- `MULTIPLE_ACCOUNTS_FOR_TYPE` - **multiple_accounts_for_type**\n- `NAME_EMAIL_NO_MATCH` - **name_email_no_match**\n- `NAME_EMAIL_UNAVAILABLE` - **name_email_unavailable**\n- `NAME_NO_MATCH` - **name_no_match**\n- `NAME_PHONE_NO_MATCH` - **name_phone_no_match**\n- `NAME_PHONE_UNAVAILABLE` - **name_phone_unavailable**\n- `NAME_UNAVAILABLE` - **name_unavailable**\n- `NEGATIVE_FILE_EXCEPTION` - **negative_file_exception**\n- `NEW_ACCOUNT_INFORMATION_AVAILABLE` - **new_account_information_available**\n- `NEW_CARD_ISSUED` - **new_card_issued**\n- `NEW_PASSWORD_REQUIRED` - **new_password_required**\n- `NO_ACCOUNT_LINK` - **no_account_link**\n- `NO_ACTION_TAKEN` - **no_action_taken**\n- `NO_CARD_RECORD` - **no_card_record**\n- `NO_CHAIN_ID` - **no_chain_id**\n- `NO_CHECKING_ACCOUNT` - **no_checking_account**\n- `NO_MATCH` - **mismatch**\n- `NO_MESSAGES_PENDING` - **no_messages_pending**\n- `NO_OPEN_BATCH` - **no_open_batch**\n- `NO_PHONE_SERVICE` - **no_phone_service**\n- `NO_PREVIOUS_TRANSACTION` - **no_previous_transaction**\n- `NO_REASON_TO_DECLINE` - **no_reason_to_decline**\n- `NO_SAVINGS_ACCOUNT` - **no_savings_account**\n- `NO_SUCH_ISSUER` - **no_such_issuer**\n- `NO_TO_ACCOUNT` - **no_to_account**\n- `NO_TRANSACTIONS_AVAILABLE` - **no_transactions_available**\n- `NO_TRANSACTION_SECURITY_RECORD` - **no_transaction_security_record**\n- `NOT_ACCEPTED` - ** not_accepted**\n- `NOT_ACTIVE` - **not_active**\n- `NOT_LOST_OR_STOLEN` - **not_lost_or_stolen**\n- `NOT_ON_FILE` - **not_on_file**\n- `NOT_PERMITTED` - **not_permitted**\n- `NOT_PERFORMED` - **not_performed**\n- `NOT_PROCESSED` - **not_processed**\n- `NOT_SUPPORTED` - **not_supported**\n- `NSF` - **nsf**\n- `ONE_TIME_STOP_PAYMENT` - **one_time_stop_payment**\n- `ORIGINAL_AUTHORIZATION_MISMATCH` - **original_authorization_mismatch**\n- `ORIGINAL_AUTHORIZATION_NOT_FOUND` - **original_authorization_not_found**\n- `ORIGINAL_REPEATED` - **original_repeated**\n- `ORIGINAL_TRANSACTION_NOT_APPROVED` - **original_transaction_not_approved**\n- `OVER_CHAIN_DAILY_VELOCITY_AMOUNT` - **over_chain_daily_velocity_amount**\n- `OVER_CHAIN_DAILY_VELOCITY_COUNT` - **over_chain_daily_velocity_count**\n- `OVER_CHAIN_DAILY_VELOCITY_LIMITS` - **over_chain_daily_velocity_limits**\n- `OVER_CHAIN_PRODUCT_VELOCITY_AMOUNT` - **over_chain_product_velocity_amount**\n- `OVER_CHAIN_PRODUCT_VELOCITY_COUNT` - **over_chain_product_velocity_count**\n- `OVER_CHAIN_PRODUCT_VELOCITY_LIMITS` - **over_chain_product_velocity_limits**\n- `OVER_MAX_BALANCE` - **over_max_balance**\n- `OVER_MERCHANDISE_LIMIT` - **over_merchandise_limit**\n- `OVER_MERCHANT_DAILY_VELOCITY_AMOUNT` - **over_merchant_daily_velocity_amount**\n- `OVER_MERCHANT_DAILY_VELOCITY_COUNT` - **over_merchant_daily_velocity_count**\n- `OVER_MERCHANT_DAILY_VELOCITY_LIMITS` - **over_merchant_daily_velocity_limits**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_AMOUNT` - **over_merchant_product_velocity_amount**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_COUNT` - **over_merchant_product_velocity_count**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_LIMITS` - **over_merchant_product_velocity_limits**\n- `OVER_MONTHLY_LIMIT` - **over_monthly_limit**\n- `OVER_NON_FUEL_LIMIT` - **over_non_fuel_limit**\n- `PAN_TRANS_ERROR` - **pan_trans_error**\n- `PARTIAL_AUTH_NOT_ALLOWED` - **partial_auth_not_allowed**\n- `PARTIAL_REVERSAL` - **partial_reversal**\n- `PARTIALLY_APPROVED` - **partially_approved**\n- `PASSWORD_RETRIES_EXCEEDED` - **password_retries_exceeded**\n- `PAY_AT_PUMP_NOT_ALLOWED` - **pay_at_pump_not_allowed**\n- `PHONE_EMAIL_NO_MATCH` - **phone_email_no_match**\n- `PHONE_EMAIL_UNAVAILABLE` - **phone_email_unavailable**\n- `PHONE_NO_MATCH` - **phone_no_match**\n- `PHONE_UNAVAILABLE` - **phone_unavailable**\n- `PICKUP_CARD` - **pickup_card**\n- `PIN_ALREADY_EXISTS` - **pin_already_exists**\n- `PIN_KEY_ERROR` - **pin_key_error**\n- `PIN_KEY_SYNCHRONIZATION_ERROR` - **pin_key_sychronization_error**\n- `PIN_TRY_EXCEEDED` - **pin_try_exceeded**\n- `PLEASE_RETRY` - **please_retry**\n- `PROCESS_AS_DEBIT` - **process_as_debit**\n- `PROCESSING_ERROR` - **processing_error**\n- `PRODUCT_CODE_RESTRICTED` - **product_code_restricted**\n- `PROMO_LOCATION_RESTRICTED` - **promo_location_restricted**\n- `QUANTITY_EXCEEDED` - **quantity_exceeded**\n- `REAUTHORIZATION_TIMEFRAME_EXPIRED` - **reauthorization_timeframe_expired**\n- `RECHARGE_AMOUNT_EXCEEDED` - **recharge_amount_exceeded**\n- `RECHARGE_COUNT_EXCEEDED` - **recharge_count_exceeded**\n- `REENTER_TRANSACTION` - **reenter_transaction**\n- `REFERRAL` - **referral**\n- `REJECT_MESSAGE` - **reject_message**\n- `REJECTED_LOST/STOLEN_CHECKS` - **rejected_lost/stolen_checks**\n- `REPAIR_LIMIT_EXCEEDED` - **repair_limit_exceeded**\n- `REQUEST_IN_PROGRESS` - **request_in_progress**\n- `RESPONSE_RECEIVED_LATE` - **response_received_late**\n- `RESTRICTED_CARD` - **restricted_card**\n- `RESUBMISSION_VIOLATES_NETWORK_FREQUENCY` - **resubmission_violates_network_frequency**\n- `RETAIN_CARD` - **retain_card**\n- `REVERSAL` - **reversal**\n- `REVERSAL_NO_MATCH` - **reversal_no_match**\n- `REVERSAL_UNSUCCESSFUL` - **reversal_unsuccessful**\n- `REVOCATION_OF_ALL_AUTHORIZATIONS` - **revocation_of_all_authorizations**\n- `REVOCATION_OF_AUTHORIZATION` - **revocation_of_authorization**\n- `SECURE_CODE_NOT_ENABLED` - **secure_code_not_enabled**\n- `SECURITY_ERROR` - **security_error**\n- `SECURITY_ERROR_TRY_AGAIN` - **security_error_try_again**\n- `SECURITY_VIOLATION` - **security_violation**\n- `SEE_ATTENDANT` - **see_attendant**\n- `SEE_EXHIBIT_FOR_ERROR` - **see_exhibit_for_error**\n- `SERVICE_NOT_ALLOWED` - **service_not_allowed**\n- `SIGNATURE_REQUIRED` - **signature_required**\n- `SKIP_TRACE_INFO` - **skip_trace_info**\n- `SOFT_DESCRIPTOR_NOT_ENABLED` - **soft_descriptor_not_enabled**\n- `SSN_NOT_AVAILABLE` - **ssn_not_available**\n- `STOLEN_CARD` - **stolen_card**\n- `STOP_PAYMENT_ORDER` - **stop_payment_order**\n- `STOP_RECURRING_PAYMENT_REQUESTS` - **stop_recurring_payment_requests**\n- `STORE_LOCATION_ZERO_NOT_ALLOWED` - **store_location_zero_not_allowed**\n- `SUBSYSTEM_UNAVAILABLE` - **subsystem_unavailable**\n- `SURCHARGE_LIMIT_EXCEEDED` - **surcharge_limit_exceeded**\n- `SYSTEM_ERROR` - **system_error**\n- `TARGET_CARD_AND_TRANSACTION_COUNT_MISMATCH` - **target_card_and_transaction_count_mismatch**\n- `TERMINAL_TRANSACTION_NUMBER_MISMATCH` - **terminal_transaction_number_mismatch**\n- `TESTMODE_DECLINE` - **testmode_decline**\n- `TICKET_LIMIT_EXCEEDED` - **ticket_limit_exceeded**\n- `TIMEOUT` - **timeout**\n- `TIMEOUT_REVERSAL_NOT_SUPPORTED` - **timeout_reversal_not_supported**\n- `TOO_MANY_TRANSACTIONS_REQUESTED` - **too_many_transactions_requested**\n- `TOTALS_UNAVAILABLE` - **totals_unavailable**\n- `TRANSACTION_COUNT_OR_WITHDRAWAL_LIMIT_EXCEEDED` - **transaction_count_or_withdrawal_limit_exceeded**\n- `TRANSACTION_DESTINATION_NOT_FOUND_FOR_ROUTING` - **transaction_destination_not_found_for_routing**\n- `TRANSACTION_HISTORY_UNAVAILABLE` - **transaction_history_unavailable**\n- `TRANSACTION_NOT_ALLOWED` - **transaction_not_allowed**\n- `TRANSACTION_NOT_PERMITTED` - **transaction_not_permitted**\n- `TRANSACTION_NOT_SUPPORTED` - **transaction_not_supported**\n- `TRANSACTION_TOTAL_LIMIT_PER_PRODUCT_CLASS_EXCEEDED` - **transaction_total_limit_per_product_class_exceeded**\n- `TRANSARMOR_INVALID_TOKEN_OR_ACCOUNT_NUMBER` - **transarmor_invalid_token_or_account_number**\n- `TRANSARMOR_KEY_ERROR` - **transarmor_key_error**\n- `TRANSARMOR_SERVICE_UNAVAILABLE` - **transarmor_service_unavailable**\n- `TRY_AGAIN_LATER` - **try_again_later**\n- `UNABLE_TO_LOCATE_PREVIOUS_MESSAGE` - **unable_to_locate_previous_message**\n- `UNABLE_TO_LOCATE_RECORD` - **unable_to_locate_record**\n- `UNABLE_TO_PROCESS` - **unable_to_process**\n- `UNABLE_TO_VERIFY_PIN` - **unable_to_verify_pin**\n- `UNAUTHORIZED` - **unauthorized**\n- `UNAVAILABLE` - **unavailable**\n- `UNDEFINED_CARD` - **undefined_card**\n- `UNDERAGE_CUSTOMER` - **underage_customer**\n- `UNKNOWN_VELOCITY_ERROR_PAY_INSIDE` - **unknown_velocity_error_pay_inside**\n- `UNSUCCESSFUL` - **unsuccessful**\n- `UNSUPPORTED_MESSAGE` - **unsupported_message**\n- `VALIDATION_ERROR` - **validation_error**\n- `VELOCITY_ERROR_PAY_INSIDE` - **velocity_error_pay_inside**\n- `VERIFICATION_TRANSACTION` - **verification_transaction**\n- `VIOLATION_OF_BUSINESS_ARRANGEMENT` - **violation_of_business_arrangement**\n- `VISA_OCT/MASTERCARD_MONEYSEND_TRANSACTIONS_BLOCKED` - **visa_oct/mastercard_moneysend_transactions_blocked**\n- `VOID_CAPTURED_ITEM` - **void_captured_item**\n- `VOYAGER_ID_PROBLEM` - **voyager_id_problem**\n- `Y_OR_N_REQUIRED` - **y_or_n_required**\n- `WAIT_2_PM_EASTERN` - **wait_2_pm_eastern**\n- `WITHDRAWAL_COUNT_LIMIT_EXCEEDED` - **withdrawal_count_limit_exceeded**\n- `WITHDRAWAL_LIMIT_EXCEEDED` - **withdrawal_limit_exceeded**\n- `ZIP_ADDRESS_NOT_VERIFIED` - **zip_and_address_not_verified**\n- `ZIP_NO_MATCH` - **address_match_zip_mismatch**\n- `ZIP_NOT_VERIFIED` - **zip_not_verified**\n- `3DS_AUTHENTICATION_SUCCESSFUL` - **3ds_authentication_successful**\n- `3DS_AUTHENTICATION_INVALID` - **3ds_authentication_invalid**\n- `3DS_AUTHENTICATION_FAILED` - **3ds_authentication_failed**\n- `3DS_AUTHENTICATION_NOT_VALIDATED` - **3ds_authentication_not_validated**\n- `3DS_AUTHENTICATION_SUCCESSFUL_WITHOUT_LIABILITY_SHIFT` - **3ds_authentication_successful_without_liability_shift** \n\n
" } ] } } }, "terminalTxnStatus": { "title": "terminalTxnStatus", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "terminalTxnType": { "title": "terminalTxnType", "enum": [ 1, 2, 4, 5, 13 ], "type": "integer" }, "terminalTxnsBinType": { "title": "terminalTxnsBinType", "enum": [ "CREDIT", "DEBIT", "PREPAID" ], "type": "string" }, "terminalTxnsCvvStatus": { "title": "terminalTxnsCvvStatus", "enum": [ "notPresent", "illegible", "notProvided" ], "type": "string" }, "terminalTxnsDatasModelTerminalTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/terminalTxnsResponse" } ], "description": "The identifier of the TerminalTxn associated with this TerminalTxnDatas resource." }, "terminalTxnsDatasResponse": { "title": "terminalTxnsDatasResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "terminalTxn": { "allOf": [ { "$ref": "#/$defs/terminalTxnsDatasModelTerminalTxn" }, { "description": "The identifier of the TerminalTxn associated with this TerminalTxnDatas resource." } ] }, "signature": { "type": "string", "description": "The Base64 encoded image of the signature captured at the time of entering the TerminalTxn." } } }, "terminalTxnsEmv": { "title": "terminalTxnsEmv", "enum": [ 0, 1 ], "type": "integer" }, "terminalTxnsHsaFsaCardIndicator": { "title": "terminalTxnsHsaFsaCardIndicator", "enum": [ 0, 1 ], "type": "integer" }, "terminalTxnsMetadatasField": { "title": "terminalTxnsMetadatasField", "enum": [ "discretionary1", "discretionary2", "discretionary3", "clinical", "copay", "dental", "healthCare", "rx", "vision", "applicationId", "terminalTransactionCurrency", "cardSequenceNumber", "applicationPreferredName", "applicationLabel", "issuerScript1", "issuerScript2", "applicationInterchangeProfile", "dedicatedFileName", "authorizationCode", "authorizationResponseCode", "cardRiskManagementDataObjectList2", "issuerAuthData", "terminalVerificationResults", "transactionStatusInformation", "transactionType", "otherAmount", "applicationUsageControl", "applicationVersionNumber", "issuerActionCodeDefault", "issuerActionCodeDenial", "issuerActionCodeOnline", "issuerApplicationData", "applicationIdName", "terminalTransactionCountryCode", "applicationCryptogram", "cryptogramInformationData", "capabilityProfile", "cardHolderVerificationMethod", "applicationTransactionCounter", "unpredictableNumber", "issuerScriptResults", "formFactorIndicator", "authCharacteristcs", "authNetworkId", "authResponseCode", "authSource", "banknetDate", "cardCaptureCapability", "cardDataInputMode", "cardDataOutputCapability", "cardholderAuthentication", "cardholderPresent", "cardInputCapability", "cardLevelResult", "cardmemberAuthentication", "cardmemberEntity", "cardPresent", "cvvErrorCode", "discoverResponseCode", "ecommerceIndicator", "entryMode", "entryModeChange", "goodsSoldCode", "marketSpecificIndicator", "merchantVerificationValue", "motoIndicator", "networkResultIndicator", "operatingEnvironment", "partialApprovalIndicator", "pinCaptureCapability", "posAttendanceIndicator", "posAuthLifecycle", "posData", "posEcommerceIndicator", "posLocation", "posTransactionSecurity", "posTransactionStatus", "processingCode", "stan", "statusCode", "terminalOutputCapability", "track1Indicator", "track2Indicator", "transactionEditErrorCode", "transactionIntegrityClass", "transactionQualifier", "validationCode", "visaSpendIndicator", "reversals", "firstTxn", "posTerminalID", "pinlessConversionFlag" ], "type": "string" }, "terminalTxnsMetadatasModelTerminalTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/terminalTxnsResponse" } ], "description": "The identifier of the Terminal Transaction associated with this TerminalTxnMetadatas resource." }, "terminalTxnsMetadatasResponse": { "title": "terminalTxnsMetadatasResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "terminalTxn": { "allOf": [ { "$ref": "#/$defs/terminalTxnsMetadatasModelTerminalTxn" }, { "description": "The identifier of the Terminal Transaction associated with this TerminalTxnMetadatas resource." } ] }, "type": { "allOf": [ { "$ref": "#/$defs/terminalTxnMetadataType" }, { "description": "The type of metadata associated with the Terminal transaction.\n\n
\nValid Values\n\n- `amounts` - **Transaction Amounts**\n- `emv` - **EuroPay, Mastercard, Visa Transactions**\n- `network` - **Network Transactions**\n- `timeout` - **Transaction Timeouts**\n- `firstTxn` - **First Transaction**\n- `discretionary` - **Custom Transaction Field Value**\n\n
" } ] }, "field": { "allOf": [ { "$ref": "#/$defs/terminalTxnsMetadatasField" }, { "description": "The discretionary field being stored.\n\n
\nValid Values\n\n- `discretionary1` - **Custom Field 1**\n- `discretionary2` - **Custom Field 2**\n- `discretionary3` - **Custom Field 3**\n- `clinical` - **Clinical amount**\n- `copay` - **Copay amount**\n- `dental` - **Dental amount**\n- `healthCare` - **Health Care amount**\n- `rx` - **RX amount**\n- `vision` - **Vision amount**\n- `applicationId` - **Application ID (AID)**\n- `terminalTransactionCurrency` - **Terminal Transaction Currency**\n- `cardSequenceNumber` - **Card Sequence Number**\n- `applicationPreferredName` - **Application Preferred Name (APPN)**\n- `applicationLabel` - **Application Label (APPLAB)**\n- `issuerScript1` - **Issuer Script 1**\n- `issuerScript2` - **Issuer Script 2**\n- `applicationInterchangeProfile` - **Application Interchange Profile**\n- `dedicatedFileName` - **Dedicated File Name**\n- `authorizationCode` - **Authorization Code (AC)**\n- `authorizationResponseCode` - **Authorization Response Code (ARC)**\n- `cardRiskManagementDataObjectList2` - **Card Risk Management Data Object List 2 (CDOL2)**\n- `issuerAuthData` - **Issuer Authentication Data (IAUTHD)**\n- `terminalVerificationResults` - **Terminal Verification Results (TVR)**\n- `transactionStatusInformation` - **Transaction Status Information (TSI)**\n- `transactionType` - **Transaction Type**\n- `otherAmount` - **Other Amount**\n- `applicationUsageControl` - **Application Usage Control (AUC)**\n- `applicationVersionNumber` - **Application Version Number (AVN)**\n- `issuerActionCodeDefault` - **Issuer Action Code Default (IACDefault)**\n- `issuerActionCodeDenial` - **Issuer Action Code Denial (IACDenial)**\n- `issuerActionCodeOnline` - **Issuer Action Code Online (IACOnline)**\n- `issuerApplicationData` - **Issuer Application Data**\n- `applicationIdName` - **Application ID Name (AID Name)**\n- `terminalTransactionCountryCode` - **Terminal Transaction Country Code**\n- `applicationCryptogram` - **Application Cryptogram (TC)**\n- `cryptogramInformationData` - **Cryptogram Information Data**\n- `capabilityProfile` - **Capability Profile**\n- `cardHolderVerificationMethod` - **Cardholder Verification Method Results (CVM)**\n- `applicationTransactionCounter` - **App Transaction Counter**\n- `unpredictableNumber` - **Unpredictable Number**\n- `issuerScriptResults` - **Issuer Script Results**\n- `formFactorIndicator` - **Form Factor Indicator**\n- `authCharacteristcs` - **Authorization Characteristics Indicator**\n- `authNetworkId` - **Authorizing Network ID**\n- `authResponseCode` - **Authorization Response Code**\n- `authSource` - **Point Of Authorization**\n- `banknetDate` - **MasterCard Banknet Settlement Date**\n- `cardCaptureCapability` - **Card Capture Capability**\n- `cardDataInputMode` - **Amex Card Data Input Mode**\n- `cardDataOutputCapability` - **Amex Card Data Output Capability**\n- `cardholderAuthentication` - **Amex Cardholder Authentication**\n- `cardholderPresent` - **Cardholder Presence**\n- `cardInputCapability` - **Card Data Input Capability**\n- `cardLevelResult` - **Visa Card Level Products Result**\n- `cardmemberAuthentication` - **Amex Cardmember Authentication**\n- `cardmemberEntity` - **Amex Cardmember Authentication Entity**\n- `cardPresent` - **Card Presence**\n- `cvvErrorCode` - **CVV Error Code**\n- `discoverResponseCode` - **Discover Response Code**\n- `ecommerceIndicator` - **Ecommerce Indicator**\n- `entryMode` - **POS Entry Mode**\n- `entryModeChange` - **POS Entry Mode changed by the issuer**\n- `goodsSoldCode` - **Amex Goods Sold Code**\n- `marketSpecificIndicator` - **Visa Market Specific Indicator**\n- `merchantVerificationValue` - **Visa MVV/Mastercard MAID**\n- `motoIndicator` - **Mail/Telephone Order Indicator**\n- `networkResultIndicator` - **Discover Network Result Indicator**\n- `operatingEnvironment` - **Amex Operating Environment**\n- `partialApprovalIndicator` - **Discover Partial Approval Indicator**\n- `pinCaptureCapability` - **PIN Capture Capability**\n- `posAttendanceIndicator` - **POS Attendance Indicator**\n- `posAuthLifecycle` - **Discover POS Auth Lifecycle**\n- `posData` - **Network POS Data**\n- `posEcommerceIndicator` - **Discover POS Ecommerce Indicator**\n- `posLocation` - **Discover POS Location**\n- `posTransactionSecurity` - **Discover POS Transaction Security**\n- `posTransactionStatus` - **Discover POS Transaction Status**\n- `processingCode` - **Discover Processing Code**\n- `stan` - **System Trace Audit Number**\n- `statusCode` - **Network status code**\n- `terminalOutputCapability` - **Amex Terminal Output Capability**\n- `track1Indicator` - **Discover Track 1 Data Indicator**\n- `track2Indicator` - **Discover Track 2 Data Indicator**\n- `transactionEditErrorCode` - **Mastercard track data error code**\n- `transactionIntegrityClass` - **Transaction Integrity Class**\n- `transactionQualifier` - **Discover Transaction Qualifier**\n- `validationCode` - **Visa Validation Code**\n- `visaSpendIndicator` - **Visa Spend Qualified Indicator**\n- `reversals` - **Reversals**\n- `firstTxn` - **First Transaction**\n- `posTerminalID` - **POS Terminal ID**\n- `pinlessConversionFlag` - **Pinless Conversion Flag**\n\n
" } ] }, "value": { "type": "string", "description": "The value of the field. This field is stored as a text string and must be between 1 and 500 characters long." } } }, "terminalTxnsModelForterminalTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/terminalTxnsResponse" } ], "description": "If this Terminal Transaction is related to another Terminal Transaction, then this field is set to the identifier of the other Terminal Transaction. For example, if this Terminal Transaction is a Refund, this field could be set to the identifier of the original Sale Terminal Transaction." }, "terminalTxnsModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant associated with this Transaction." }, "terminalTxnsModelToken": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/tokensResponse" } ], "description": "The ID of the token record to associate with this terminal transaction request." }, "terminalTxnsModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The related txn this terminalTxn belongs to." }, "terminalTxnsPin": { "title": "terminalTxnsPin", "enum": [ 0, 1 ], "type": "integer" }, "terminalTxnsPos": { "title": "terminalTxnsPos", "enum": [ 0, 1 ], "type": "integer" }, "terminalTxnsReceipt": { "title": "terminalTxnsReceipt", "enum": [ "noReceipt", "merchant", "customer", "both" ], "type": "string" }, "terminalTxnsResponse": { "title": "terminalTxnsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "ipCreated": { "type": "string", "description": "The incoming ip address from which this Transaction was created." }, "ipModified": { "type": "string", "description": "The incoming ip address from which this Transaction was last modified." }, "merchant": { "allOf": [ { "$ref": "#/$defs/terminalTxnsModelMerchant" }, { "description": "The identifier of the Merchant associated with this Transaction." } ] }, "mid": { "type": "string", "description": "The Merchant ID, as set by the processor, is stored as a text string and must be between 0 and 50 characters long." }, "txn": { "allOf": [ { "$ref": "#/$defs/terminalTxnsModelTxn" }, { "description": "The related txn this terminalTxn belongs to." } ] }, "token": { "allOf": [ { "$ref": "#/$defs/terminalTxnsModelToken" }, { "description": "The ID of the token record to associate with this terminal transaction request." } ] }, "paymentNumber": { "type": "integer", "description": "The last four numbers of the credit card associated with this Transaction.", "contentEncoding": "int32" }, "paymentMethod": { "allOf": [ { "$ref": "#/$defs/terminalTxnPaymentMethod" }, { "description": "The payment method for this Transaction." } ] }, "forterminalTxn": { "allOf": [ { "$ref": "#/$defs/terminalTxnsModelForterminalTxn" }, { "description": "If this Terminal Transaction is related to another Terminal Transaction, then this field is set to the identifier of the other Terminal Transaction. For example, if this Terminal Transaction is a Refund, this field could be set to the identifier of the original Sale Terminal Transaction." } ] }, "type": { "allOf": [ { "$ref": "#/$defs/terminalTxnType" }, { "description": "The type of Transaction.\n\n
\nValid Values\n\n- `1` - **Credit Card Only: Sale Transaction.** This is the most common type of Transaction, it 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- `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- `13` - **Batch out terminal.**\n\n
" } ] }, "expiration": { "type": "string", "description": "The expiration date of this Transaction. 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." }, "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." } ] }, "fee": { "type": "number", "description": "Optional calculated fee amount indicator, which should be used in conjunction with txnFee setting on Fees resource, This field is specified in cents(up to three decimal points)." }, "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
" } ] }, "authDate": { "type": "integer", "description": "The date on which the Transaction was authorized, specified as an eight digit string in YYYYMMDD format, for example, '20160120' for January 20, 2016, and the value of this field must represent a date in the past.", "contentEncoding": "int32" }, "authCode": { "type": "string", "description": "The authorization code for this Transaction. This field is stored as a text string and must be between 0 and 20 characters long." }, "order": { "type": "string", "description": "The identifier of the Order associated with this Transaction, This field is stored as a text string and must be between 0 and 1000 characters long." }, "description": { "type": "string", "description": "A description of this Transaction. This field is stored as a text string and must be between 0 and 1000 characters long." }, "traceNumber": { "type": "integer", "description": "Sequencial number that uniquely identifies the terminalTxn.", "contentEncoding": "int64" }, "discount": { "type": "integer", "description": "The discount applied to the transaction.", "contentEncoding": "int64" }, "shipping": { "type": "integer", "description": "The shipping fee pertaining to this transaction.", "contentEncoding": "int64" }, "duty": { "type": "integer", "description": "The duty fee applicable to this transaction.", "contentEncoding": "int64" }, "terminal": { "type": "string", "description": "The identifier of the terminal that processed this Transaction, which is taken from the terminal system and varies in format according to the type of terminal, is stored as a text string and must be between 0 and 50 characters long." }, "tid": { "type": "string", "description": "The Terminal ID as set by the platform activating the terminal, 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
" } ] }, "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
" } ] }, "origin": { "allOf": [ { "$ref": "#/$defs/terminalTxnOrigin" }, { "description": "The origin of this Transaction.\n\n
\nValid Values\n\n- `1` - **Credit Card Terminal.**\n- `2` - **eCommerce System.**\n- `3` - **Mail or Telephone Order Transaction.**\n- `4` - **Apple Pay (deprecated).**\n- `5` - **Successful 3D Secure Transaction.**\n- `6` - **Attempted 3D Secure Transaction.**\n- `7` - **Deprecated. Recurring Card Transaction.**\n- `8` - **Payframe.**\n- `9` - **Writing.**\n\n
" } ] }, "tax": { "type": "integer", "description": "The amount of the total sum of this Transaction that is made up of tax, This field is specified as an integer in cents.", "contentEncoding": "int64" }, "total": { "type": "integer", "description": "The total amount of this Transaction, This field is specified as an integer in cents.", "contentEncoding": "int64" }, "tip": { "type": "integer", "description": "This field indicates the tip amount associated with a transaction. This value is for reporting purposes only, because transaction amount includes this amount in the total.", "contentEncoding": "int64" }, "cashback": { "type": "integer", "description": "The amount of the total sum of this Transaction that is given as cash back, specified as an integer in cents.", "contentEncoding": "int64" }, "authorization": { "type": "string", "description": "The authorization code for this Transaction, as returned by the network." }, "approved": { "type": "integer", "description": "The total amount that was approved for this Transaction by the processor, which is specified as an integer in cents.", "contentEncoding": "int64" }, "cvv": { "type": "integer", "description": "Whether correct cvv was sent during this Transaction.", "contentEncoding": "int32" }, "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
" } ] }, "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
" } ] }, "emv": { "allOf": [ { "$ref": "#/$defs/terminalTxnsEmv" }, { "description": "Whether the card was dipped (using the EMV chip) during this Transaction.\n\n
\nValid Values\n\n- `0` - **Not dipped.**\n- `1` - **Dipped.**\n\n
" } ] }, "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
" } ] }, "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
" } ] }, "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
" } ] }, "pos": { "allOf": [ { "$ref": "#/$defs/terminalTxnsPos" }, { "description": "Whether the terminalTxn is coming from a POS system that needs terminal activation.\n\n
\nValid Values\n\n- `0` - **POS Terminal Activation.** (Internal)\n- `1` - **External Terminal Activation.**\n\n
" } ] }, "binType": { "allOf": [ { "$ref": "#/$defs/terminalTxnsBinType" }, { "description": "The type of bank issuer number (BIN) that allows for resulting transactions.\n\n
\nValid Values\n\n- `CREDIT` - **Credit BIN Type.**\n- `DEBIT` - **Debit BIN Type.**\n- `PREPAID` - **Prepaid BIN Type.**\n\n
" } ] }, "receipt": { "allOf": [ { "$ref": "#/$defs/terminalTxnsReceipt" }, { "description": "Whether the terminal should print a receipt or not.\n\n
\nValid Values\n\n- `noReceipt` - **No Receipt.**\n- `merchant` - **Merchant copy only.**\n- `customer` - **Customer copy only.**\n- `both` - **Merchant and Customer copy.**\n\n
" } ] }, "clientIp": { "type": "string", "description": "The client IP address from which the transaction was created, valid values are any IPv4 or IPv6 address." }, "first": { "type": "string", "description": "The first name associated with this Transaction. For eCheck transactions, either first or last is required." }, "middle": { "type": "string", "description": "The middle name associated with this Transaction." }, "last": { "type": "string", "description": "The last name associated with this Transaction. For eCheck transactions, either first or last is required." }, "company": { "type": "string", "description": "The name of the company associated with this Transaction, setting this field is especially important when processing an eCheck from a company." }, "email": { "type": "string", "description": "The email associated with this Transaction." }, "address1": { "type": "string", "description": "The first line of the address associated with this Transaction. 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 Transaction. This field is stored as a text string and must be between 1 and 500 characters long." }, "city": { "type": "string", "description": "The city in the address associated with this Transaction, which 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, 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 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, stored as a text string and must be between 10 and 15 characters long." }, "status": { "allOf": [ { "$ref": "#/$defs/terminalTxnStatus" }, { "description": "The status of the Transaction.\n\n
\nValid Values\n\n- `0` - **Pending.**\n- `1` - **Approved.** Payments can be voided or cancelled.\n- `2` - **Failed.**\n- `3` - **Captured.** Payments can be refunded.\n- `4` - **Settled.** Payments can be refunded.\n- `5` - **Returned.** Payments have been successfully refunded.\n\n
" } ] }, "reserved": { "allOf": [ { "$ref": "#/$defs/terminalTxnReserved" }, { "description": "Indicates whether the Transaction is reserved and the action that will be taken as a result.\n\n
\nValid Values\n\n- `0` - **No reserve.**\n\n
" } ] }, "checkStage": { "type": "string", "description": "The last transaction stage check for risk." }, "originatingApp": { "type": "string", "description": "Field identifying Payrix PAX terminal originating app." }, "OEMTTxnRefNumber": { "type": "string", "description": "Field identifying original Payrix Verifone transaction reference number, used for refunds and cancellation request." }, "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/inactive" }, { "description": "Whether this resource is marked as inactive.\n\n
\nValid Values\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n
" } ] }, "posApplicationId": { "type": "string", "description": "Express assigned identifier i.e. Software Id being used in express terminal." }, "posApplicationName": { "type": "string", "description": "Software Name being used in express terminal." }, "posApplicationVersion": { "type": "string", "description": "Software version being used in express terminal." }, "customerReferenceNumber": { "type": "string", "description": "Express Reference Number." }, "gatewayTransactionId": { "type": "string", "description": "The gateway transaction ID relates to Express Transaction ID." }, "customerTicketNumber": { "type": "string", "description": "Express ticket Number." }, "cardNetworkTransactionId": { "type": "string", "description": "Card network transaction ID associated with this transaction." }, "omnitoken": { "type": "string", "description": "The OmniToken associated with this Transaction." }, "convenienceFee": { "type": "integer", "description": "The amount of the total sum of this Transaction that is made up of convenience fee. Fee charged when card payment is an alternative form of payment not ordinarily accepted by a merchant or service provider. This field is specified as an integer in cents. [currently not active]", "contentEncoding": "int32" }, "surcharge": { "type": "integer", "description": "Surcharge amount included in the total amount of the transaction. A surcharge fee is an additional charge added to the price of a purchase when a customer pays with a credit card. This field is specified as an integer in cents.", "contentEncoding": "int32" }, "softPosDeviceTypeIndicator": { "type": "string", "description": "The device type indicator for the terminal.\n\n
\nValid Values\n\n - `1` - **Apple (Worldpay as PSP)**\n - `2` - **Android (Worldpay as PSP)**\n - `3` - **Apple (Worldpay not PSP)**\n - `4` - **Android (Worldpay not PSP)**\n \n
" }, "terminalClassificationCode": { "type": "string", "description": "The terminal classification code.\n\n
\nValid Values\n\n - `AC` - **ATap with Accessory/dongle.**\n - `AS` - **Tap with PIN on Glass option on Accessory/dongle.**\n - `CC` - **Tap on Mobile device.**\n - `CS` - **Tap with PIN on Glass option on Mobile device.**\n \n
" }, "softPosId": { "type": "string", "description": "The software POS ID." }, "hsaFsaCardIndicator": { "allOf": [ { "$ref": "#/$defs/terminalTxnsHsaFsaCardIndicator" }, { "description": "Indicates if the card is a Flexible Spending Account (FSA) or Health Savings Account (HSA) card.\n
\nValid Values\n\n- `0` - **Not an HSA/FSA card.**\n- `1` - **HSA/FSA card.**\n\n
" } ] }, "gatewayTerminalId": { "type": "string", "description": "The gateway terminal ID." }, "descriptor": { "type": "string", "description": "The billing Descriptor that is used when the transaction is part of a subscription." }, "cardNetworkBankNetReferenceNumber": { "type": "string", "description": "The reference number associated with the card network." }, "cardNetworkBankNetSettlementDate": { "type": "string", "description": "The settlement date associated with the card network." }, "forterminalTxns": { "type": "array", "items": { "$ref": "#/$defs/terminalTxnsResponse" }, "description": "" }, "holds": { "type": "array", "items": { "$ref": "#/$defs/terminalTxnsResponse" }, "description": "" }, "notes": { "type": "array", "items": { "$ref": "#/$defs/notesResponse" }, "description": "" }, "pendingEntries": { "type": "array", "items": { "$ref": "#/$defs/pendingEntriesResponse" }, "description": "" }, "terminalTxnData": { "$ref": "#/$defs/terminalTxnsDatasResponse" }, "terminalTxnMetadatas": { "type": "array", "items": { "$ref": "#/$defs/terminalTxnsMetadatasResponse" }, "description": "" }, "terminalTxnRefs": { "type": "array", "items": { "$ref": "#/$defs/terminalTxnRefsResponse" }, "description": "" }, "terminalTxnResults": { "type": "array", "items": { "$ref": "#/$defs/terminalTxnResultsResponse" }, "description": "" }, "verifications": { "type": "array", "items": { "$ref": "#/$defs/verificationsResponse" }, "description": "" } } }, "terminalTxnsResultCode": { "title": "terminalTxnsResultCode", "enum": [ 0, 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 ], "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" }, "terminalsModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant that owns this terminals resource." }, "terminalsResponse": { "title": "terminalsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "merchant": { "allOf": [ { "$ref": "#/$defs/terminalsModelMerchant" }, { "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
" } ] }, "capability": { "allOf": [ { "$ref": "#/$defs/terminalsCapability" }, { "description": "The credit card terminal’s capabilities.\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" }, "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/terminalRefsResponse" }, "description": "" } } }, "terminalsTimezone": { "title": "terminalsTimezone", "enum": [ "est", "cst", "pst", "mst", "akst", "hst", "sst", "chst", "ast", "pwt", "mht", "chut", "nst" ], "type": "string" }, "tokenStatus": { "title": "tokenStatus", "enum": [ "pending", "ready" ], "type": "string" }, "tokensModelCustomer": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/customersResponse" } ], "description": "The Customer that this Token is associated with." }, "tokensModelPayment": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/paymentResponse" } ], "description": "The payment method that is associated with this Token." }, "tokensResponse": { "title": "tokensResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "customer": { "allOf": [ { "$ref": "#/$defs/tokensModelCustomer" }, { "description": "The Customer that this Token is associated with." } ] }, "payment": { "allOf": [ { "$ref": "#/$defs/tokensModelPayment" }, { "description": "The payment method that is associated with this Token." } ] }, "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
" } ] }, "token": { "type": "string", "description": "The auto-generated token identifier." }, "track": { "type": "string", "description": "The magnetic stripe track data for the payment record for use in a transaction." }, "cvv": { "type": "string", "description": "The CVV (Card Verification Value) for the payment record for use in a transaction" }, "expiration": { "type": "string", "description": "The expiry month for the payment method associated with this Token.\n 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. \nThe value must reflect a future date." }, "name": { "type": "string", "description": "The name of this Token. \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 Token. \nThis 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": "string", "description": "The origin of the token." }, "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." }, "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
" } ] }, "paymentUpdates": { "type": "array", "items": { "$ref": "#/$defs/paymentUpdatesResponse" }, "description": "" }, "subscriptionTokens": { "type": "array", "items": { "$ref": "#/$defs/subscriptionTokensResponse" }, "description": "" }, "txns": { "type": "array", "items": { "$ref": "#/$defs/txnsResponse" }, "description": "" } } }, "txnCheckStage": { "title": "txnCheckStage", "enum": [ "activation", "auth", "postauth", "capture", "refund" ], "type": "string" }, "txnMetadatasModelTxn": { "anyOf": [ { "type": "string" } ], "description": "The identifier of the Transaction associated with this TxnMetadatas resource." }, "txnMetadatasResponse": { "title": "txnMetadatasResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "txn": { "allOf": [ { "$ref": "#/$defs/txnMetadatasModelTxn" }, { "description": "The identifier of the Transaction associated with this TxnMetadatas resource." } ] }, "type": { "allOf": [ { "$ref": "#/$defs/terminalTxnMetadataType" }, { "description": "The type of metadata associated with the Terminal transaction.\n\n
\nValid Values\n\n- `amounts` - **Transaction Amounts**\n- `emv` - **EuroPay, Mastercard, Visa Transactions**\n- `network` - **Network Transactions**\n- `timeout` - **Transaction Timeouts**\n- `firstTxn` - **First Transaction**\n- `discretionary` - **Custom Transaction Field Value**\n\n
" } ] }, "field": { "allOf": [ { "$ref": "#/$defs/terminalTxnsMetadatasField" }, { "description": "The discretionary field being stored.\n\n
\nValid Values\n\n- `discretionary1` - **Custom Field 1**\n- `discretionary2` - **Custom Field 2**\n- `discretionary3` - **Custom Field 3**\n- `clinical` - **Clinical amount**\n- `copay` - **Copay amount**\n- `dental` - **Dental amount**\n- `healthCare` - **Health Care amount**\n- `rx` - **RX amount**\n- `vision` - **Vision amount**\n- `applicationId` - **Application ID (AID)**\n- `terminalTransactionCurrency` - **Terminal Transaction Currency**\n- `cardSequenceNumber` - **Card Sequence Number**\n- `applicationPreferredName` - **Application Preferred Name (APPN)**\n- `applicationLabel` - **Application Label (APPLAB)**\n- `issuerScript1` - **Issuer Script 1**\n- `issuerScript2` - **Issuer Script 2**\n- `applicationInterchangeProfile` - **Application Interchange Profile**\n- `dedicatedFileName` - **Dedicated File Name**\n- `authorizationCode` - **Authorization Code (AC)**\n- `authorizationResponseCode` - **Authorization Response Code (ARC)**\n- `cardRiskManagementDataObjectList2` - **Card Risk Management Data Object List 2 (CDOL2)**\n- `issuerAuthData` - **Issuer Authentication Data (IAUTHD)**\n- `terminalVerificationResults` - **Terminal Verification Results (TVR)**\n- `transactionStatusInformation` - **Transaction Status Information (TSI)**\n- `transactionType` - **Transaction Type**\n- `otherAmount` - **Other Amount**\n- `applicationUsageControl` - **Application Usage Control (AUC)**\n- `applicationVersionNumber` - **Application Version Number (AVN)**\n- `issuerActionCodeDefault` - **Issuer Action Code Default (IACDefault)**\n- `issuerActionCodeDenial` - **Issuer Action Code Denial (IACDenial)**\n- `issuerActionCodeOnline` - **Issuer Action Code Online (IACOnline)**\n- `issuerApplicationData` - **Issuer Application Data**\n- `applicationIdName` - **Application ID Name (AID Name)**\n- `terminalTransactionCountryCode` - **Terminal Transaction Country Code**\n- `applicationCryptogram` - **Application Cryptogram (TC)**\n- `cryptogramInformationData` - **Cryptogram Information Data**\n- `capabilityProfile` - **Capability Profile**\n- `cardHolderVerificationMethod` - **Cardholder Verification Method Results (CVM)**\n- `applicationTransactionCounter` - **App Transaction Counter**\n- `unpredictableNumber` - **Unpredictable Number**\n- `issuerScriptResults` - **Issuer Script Results**\n- `formFactorIndicator` - **Form Factor Indicator**\n- `authCharacteristcs` - **Authorization Characteristics Indicator**\n- `authNetworkId` - **Authorizing Network ID**\n- `authResponseCode` - **Authorization Response Code**\n- `authSource` - **Point Of Authorization**\n- `banknetDate` - **MasterCard Banknet Settlement Date**\n- `cardCaptureCapability` - **Card Capture Capability**\n- `cardDataInputMode` - **Amex Card Data Input Mode**\n- `cardDataOutputCapability` - **Amex Card Data Output Capability**\n- `cardholderAuthentication` - **Amex Cardholder Authentication**\n- `cardholderPresent` - **Cardholder Presence**\n- `cardInputCapability` - **Card Data Input Capability**\n- `cardLevelResult` - **Visa Card Level Products Result**\n- `cardmemberAuthentication` - **Amex Cardmember Authentication**\n- `cardmemberEntity` - **Amex Cardmember Authentication Entity**\n- `cardPresent` - **Card Presence**\n- `cvvErrorCode` - **CVV Error Code**\n- `discoverResponseCode` - **Discover Response Code**\n- `ecommerceIndicator` - **Ecommerce Indicator**\n- `entryMode` - **POS Entry Mode**\n- `entryModeChange` - **POS Entry Mode changed by the issuer**\n- `goodsSoldCode` - **Amex Goods Sold Code**\n- `marketSpecificIndicator` - **Visa Market Specific Indicator**\n- `merchantVerificationValue` - **Visa MVV/Mastercard MAID**\n- `motoIndicator` - **Mail/Telephone Order Indicator**\n- `networkResultIndicator` - **Discover Network Result Indicator**\n- `operatingEnvironment` - **Amex Operating Environment**\n- `partialApprovalIndicator` - **Discover Partial Approval Indicator**\n- `pinCaptureCapability` - **PIN Capture Capability**\n- `posAttendanceIndicator` - **POS Attendance Indicator**\n- `posAuthLifecycle` - **Discover POS Auth Lifecycle**\n- `posData` - **Network POS Data**\n- `posEcommerceIndicator` - **Discover POS Ecommerce Indicator**\n- `posLocation` - **Discover POS Location**\n- `posTransactionSecurity` - **Discover POS Transaction Security**\n- `posTransactionStatus` - **Discover POS Transaction Status**\n- `processingCode` - **Discover Processing Code**\n- `stan` - **System Trace Audit Number**\n- `statusCode` - **Network status code**\n- `terminalOutputCapability` - **Amex Terminal Output Capability**\n- `track1Indicator` - **Discover Track 1 Data Indicator**\n- `track2Indicator` - **Discover Track 2 Data Indicator**\n- `transactionEditErrorCode` - **Mastercard track data error code**\n- `transactionIntegrityClass` - **Transaction Integrity Class**\n- `transactionQualifier` - **Discover Transaction Qualifier**\n- `validationCode` - **Visa Validation Code**\n- `visaSpendIndicator` - **Visa Spend Qualified Indicator**\n- `reversals` - **Reversals**\n- `firstTxn` - **First Transaction**\n- `posTerminalID` - **POS Terminal ID**\n- `pinlessConversionFlag` - **Pinless Conversion Flag**\n\n
" } ] }, "value": { "type": "string", "description": "The value of the field. \nThis field is stored as a text string and must be between 1 and 500 characters long." } } }, "txnOrigin": { "title": "txnOrigin", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer" }, "txnPinlessDebitConversion": { "title": "txnPinlessDebitConversion", "enum": [ 0, 1 ], "type": "integer" }, "txnProcessedMethod": { "title": "txnProcessedMethod", "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" }, "txnRefStage": { "title": "txnRefStage", "enum": [ "auth", "capture", "draft", "file", "network", "refund", "retrieval", "threatMetrix", "txnHash", "ARN", "acquirerTxnId", "origTxnId" ], "type": "string" }, "txnRefsResponse": { "title": "txnRefsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "txn": { "type": "string", "description": "The parent transaction that owns this txnRef and to which this reference applies." }, "ref": { "type": "string", "description": "The reference value retrieved from the third party (platform)." }, "stage": { "allOf": [ { "$ref": "#/$defs/txnRefStage" }, { "description": "An indicator showing what this txnRef refers to, such as auth, capture, draft, file, refund, or an unknown value.\n\n
\nValid Values\n\n- `auth` - **Related to transaction authorization stage.**\n- `capture` - **Related to transaction capture stage.**\n- `draft` - **Transaction is in draft stage. Draft locator for transaction.**\n- `file` - **Import Transaction Reference file.**\n- `refund` - **Related to transaction refund stage.**\n- `retrieval` - **A reference to the retrieval number (a reference exchanged with the processor for later cross-reference).**\n- `threatMetrix` - **Threat Matrix.**\n- `acquirerTxnId` - **A unique identifier created by the acquirer to track and reconcile a specific transaction throughout its lifecycle.**\n- `origTxnId` - **The identifier of the original transaction, used to link related actions such as refunds, reversals, or adjustments back to the initial payment.**\n\n
" } ] }, "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
" } ] } } }, "txnReportsResponse": { "title": "txnReportsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "txn": { "type": "string", "description": "The identifier of the Transaction resource associated with this txnReports resource." }, "interchangeType": { "type": "string", "description": "The type of interchange used by the Transaction." }, "issuingBank": { "type": "string", "description": "The name of the bank that issued the card used in the Transaction." }, "flatRateFee": { "type": "integer", "description": "If the fee charged by the Processor was a flat rate, then this field specifies its absolute amount. \nThis field is specified as an integer in cents.", "contentEncoding": "int32" }, "percentFee": { "type": "integer", "description": "If the fee charged by the Processor was a percentage of the Transaction value, then this field specifies the percentage, expressed in basis points. \nFor example, 25.3% is expressed as '2530'.", "contentEncoding": "int32" }, "feeTotal": { "type": "integer", "description": "This is the total amount charged in interchange fees. \nThis field is specified as an integer in cents.", "contentEncoding": "int32" } } }, "txnResultType": { "title": "txnResultType", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer" }, "txnResultsBankCode": { "title": "txnResultsBankCode", "enum": [ "accepted_but_not_yet_processed", "account_blocked", "account_is_purged", "account_locked", "account_on_hold_or_not_active", "account_not_activated", "account_reloads_exceeded", "account_row_locked", "account_status_is_void_lock", "ach_payment_not_accepted", "acquirer_channel_unavailable", "activation_failed", "additive_limit_exceeded", "zip_match_address_mismatch", "zip_match_address_not_verified", "already_redeemed", "already_reversed", "amount_limit_exceeded", "amount_too_large", "approve_with_id", "approved", "approved_emv_key_load", "approved_with_no_cash", "approved_with_overdraft", "authorization_id_needed", "bad_account", "bad_checksum", "bad_close", "bad_mag_stripe", "bad_post_date", "bad_repay_date", "balance_not_available", "bill_to_ship_to_mismatch", "bin_blocked", "blocked_by_cardholder", "bulk_activation_error", "bulk_activation_package_amount_error", "call_acquirer", "call_for_authorization", "call_issuer", "call_telecheck", "cannot_find_network", "card_already_active", "card_already_closed", "card_not_active", "card_not_supported", "card_velocity_amount_exceeded", "card_velocity_count_exceeded", "card_velocity_exceeded", "cashback_greater_than_transaction_amount", "cash_limit_exceeded", "center_closed", "checker/manager_not_found", "chip_failure", "close_unavailable", "close_not_valid", "closed_account", "count_exceeds_limit", "counterfeit_card", "counter_offer_to_supply_personal_guaranty", "cryptogram_decryption_error", "crypto_box_is_offline", "currency_conversion_complete", "currency_conversion_error", "currency_not_supported", "customer_cancellation", "customer_opt_out", "cut_time_close_to_1400", "cvv_declined", "cvv_failed", "daily_limit_exceeded", "date_of_birth_error", "debit_gateway_unavailable", "declined", "declined_due_to_stand_in_rules", "deconverted_bin", "do_not_honor", "do_not_try_again", "do_not_try_again_subsequent_may_continue", "drivers_license_or_id_required", "duplicate_capture", "duplicate_return", "duplicate_reversal", "duplicate_transaction", "edit_honor", "email_no_match", "email_unavailable", "emv_key_download_error", "enter_lesser_amount", "error_processing_pin_block", "exceeds_global_amount_for_period_pay_inside", "exceeds_global_count_for_period_pay_inside", "exceeds_global_limits_for_period_pay_inside", "exceeds_limit", "exceeds_merchant_amount_for_period_pay_inside", "exceeds_merchant_count_for_period_pay_inside", "exceeds_merchant_limits_for_period_pay_inside", "exceeds_state_amount_for_period_pay_inside", "exceeds_state_count_for_period_pay_inside", "exceeds_state_limits_for_period_pay_inside", "exceeds_transaction_count_or_amount_limit_in_24_hours", "exceeds_transaction_count_or_amount_limit_in_7_days", "exceeds_transaction_count_or_amount_limit_in_30_days", "exceeds_zip_code_amount_for_period_pay_inside", "exceeds_zip_code_count_for_period_pay_inside", "exceeds_zip_code_limits_for_period_pay_inside", "expired_card", "expired_lock", "fraudulent", "file_temporarily_unavailable", "file_update_error", "file_update_unavailable", "format_error", "forward_to_issuer", "fuel_limit_exceeded", "fuel_only", "fuel_price_error", "full_ssn_required", "function_not_supported", "funds_on_hold", "general", "general_error", "generic_decline", "hard_capture_pickup_card", "hard_negative_info_on_file", "high_risk", "hold_shipping_for_24h", "honor_with_authentication", "illegal_transaction", "imprint_card", "incorrect_cvv", "incorrect_number", "incorrect_pin", "incorrect_merchant_location", "incorrect_transaction_version", "inquiry_declined", "insufficient_data", "insufficient_funds", "insufficient_security", "internet_access_disabled", "invalid_3d_password", "invalid_account", "invalid_account/date", "invalid_account_type", "invalid_activate", "invalid_amount", "invalid_authorization_code", "invalid_batch_number/id", "invalid_cashback", "invalid_checking_account", "invalid_checking_account_number", "invalid_credit_account", "invalid_clerk", "invalid_currency", "invalid_cvv", "invalid_date_or_time", "invalid_driver", "invalid_ean_or_scv", "invalid_effective_date", "invalid_email_address", "invalid_entry", "invalid_expiry_date", "invalid_expiry_year", "invalid_host", "invalid_location", "invalid_maiden_name", "invalid_mcc", "invalid_merchant", "invalid_merchant_id", "invalid_merchant_id/se", "invalid_merchant_setup", "invalid_micr_data", "invalid_new_password", "invalid_not_present", "invalid_number", "invalid_odometer", "invalid_password", "invalid_pin", "invalid_pos", "invalid_preapproval_number", "invalid_prefix", "invalid_product", "invalid_prompt_entry", "invalid_request", "invalid_response", "invalid_response_date", "invalid_restriction_code", "invalid_savings_account", "invalid_secure_payment_data", "invalid_sku", "invalid_ssn", "invalid_state_code", "invalid_status_change", "invalid_terminal", "invalid_tgn_cic", "invalid_timezone", "invalid_tppid", "invalid_track_data", "invalid_transaction", "invalid_transarmor_transaction", "invalid_user", "invalid_value_in_the_field", "invalid_vehicle", "invalid_void_of_activation", "invalid_zip_code", "issuance_under_minimum_amount", "issuer_not_available", "issuer_processor_or_switch_not_available", "issuer_special_conditions", "issuer_velocity_amount_exceeded", "issuer_velocity_count_exceeded", "late_reversal", "law_violation", "limit_check_failed", "lost_card", "maiden_name_unavailable", "manual_tries_exceeded", "match", "max_balance_exceeded", "merchant_depleted", "merchant_has_mail_pending", "message_format_error", "minus2_debit", "missing_conditional_data", "missing_customer_service_phone", "missing_from_account", "missing_to_account", "multi_currency_dcc_fail", "multi_currency_invert_fail", "multiple_accounts_for_type", "name_email_no_match", "name_email_unavailable", "name_no_match", "name_phone_no_match", "name_phone_unavailable", "name_unavailable", "negative_file_exception", "new_account_information_available", "new_card_issued", "new_password_required", "no_account_link", "no_action_taken", "no_card_record", "no_chain_id", "no_checking_account", "mismatch", "no_messages_pending", "no_open_batch", "no_phone_service", "no_previous_transaction", "no_reason_to_decline", "no_savings_account", "no_such_issuer", "no_to_account", "no_transactions_available", "no_transaction_security_record", "not_accepted", "not_active", "not_lost_or_stolen", "not_on_file", "not_permitted", "not_performed", "not_processed", "not_supported", "nsf", "one_time_stop_payment", "original_authorization_mismatch", "original_authorization_not_found", "original_repeated", "original_transaction_not_approved", "over_chain_daily_velocity_amount", "over_chain_daily_velocity_count", "over_chain_daily_velocity_limits", "over_chain_product_velocity_amount", "over_chain_product_velocity_count", "over_chain_product_velocity_limits", "over_max_balance", "over_merchandise_limit", "over_merchant_daily_velocity_amount", "over_merchant_daily_velocity_count", "over_merchant_daily_velocity_limits", "over_merchant_product_velocity_amount", "over_merchant_product_velocity_count", "over_merchant_product_velocity_limits", "over_monthly_limit", "over_non_fuel_limit", "pan_trans_error", "partial_auth_not_allowed", "partial_reversal", "partially_approved", "password_retries_exceeded", "pay_at_pump_not_allowed", "phone_email_no_match", "phone_email_unavailable", "phone_no_match", "phone_unavailable", "pickup_card", "pin_already_exists", "pin_key_error", "pin_key_sychronization_error", "pin_try_exceeded", "please_retry", "process_as_debit", "processing_error", "product_code_restricted", "promo_location_restricted", "quantity_exceeded", "reauthorization_timeframe_expired", "recharge_amount_exceeded", "recharge_count_exceeded", "reenter_transaction", "referral", "reject_message", "rejected_lost/stolen_checks", "repair_limit_exceeded", "request_in_progress", "response_received_late", "restricted_card", "resubmission_violates_network_frequency", "retain_card", "reversal", "reversal_no_match", "reversal_unsuccessful", "revocation_of_all_authorizations", "revocation_of_authorization", "secure_code_not_enabled", "security_error", "security_error_try_again", "security_violation", "see_attendant", "see_exhibit_for_error", "service_not_allowed", "signature_required", "skip_trace_info", "soft_descriptor_not_enabled", "ssn_not_available", "stolen_card", "stop_payment_order", "stop_recurring_payment_requests", "store_location_zero_not_allowed", "subsystem_unavailable", "surcharge_limit_exceeded", "system_error", "target_card_and_transaction_count_mismatch", "transaction_number_mismatch", "testmode_decline", "ticket_limit_exceeded", "timeout", "timeout_reversal_not_supported", "too_many_transactions_requested", "totals_unavailable", "transaction_count_or_withdrawal_limit_exceeded", "transaction_destination_not_found_for_routing", "transaction_history_unavailable", "transaction_not_allowed", "transaction_not_permitted", "transaction_not_supported", "transaction_total_limit_per_product_class_exceeded", "transarmor_invalid_token_or_account_number", "transarmor_key_error", "transarmor_service_unavailable", "try_again_later", "unable_to_locate_previous_message", "unable_to_locate_record", "unable_to_process", "unable_to_verify_pin", "unauthorized", "unavailable", "undefined_card", "underage_customer", "unknown_velocity_error_pay_inside", "unsuccessful", "unsupported_message", "validation_error", "velocity_error_pay_inside", "verification_transaction", "violation_of_business_arrangement", "visa_oct/mastercard_moneysend_transactions_blocked", "void_captured_item", "voyager_id_problem", "y_or_n_required", "wait_2_pm_eastern", "withdrawal_count_limit_exceeded", "withdrawal_limit_exceeded", "zip_address_not_verified", "zip_and_address_not_verified", "zip_no_match", "address_match_zip_mismatch", "zip_not_verified", "3ds_authentication_successful", "3ds_authentication_invalid", "3ds_authentication_failed", "3ds_authentication_not_validated", "3ds_authentication_successful_without_liability_shift" ], "type": "string" }, "txnResultsCode": { "title": "txnResultsCode", "enum": [ 0, 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 ], "type": "integer" }, "txnResultsModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the Transaction associated with this txnResults resource." }, "txnResultsResponse": { "title": "txnResultsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "txn": { "allOf": [ { "$ref": "#/$defs/txnResultsModelTxn" }, { "description": "The identifier of the Transaction associated with this txnResults resource." } ] }, "type": { "allOf": [ { "$ref": "#/$defs/txnResultType" }, { "description": "The type of this txnResult is the type of this txnResult.\n\n
\nValid Values\n\n- `1` - **A general type of result.**\n- `2` - **Fraud prevention alert.**\n- `3` - **Processor error.**\n- `4` - **CVV matching alert.**\n- `5` - **AVS check alert.**\n- `6` - **AAVS check alert.**\n- `7` - **Network error.**\n- `8` - **3DS check alert.**\n- `9` - **Pinless Debit conversion failed attempt.**\n\n
" } ] }, "message": { "type": "string", "description": "A message that accompanies and describes this Transaction result." }, "code": { "allOf": [ { "$ref": "#/$defs/txnResultsCode" }, { "description": "TxnResult is the result code that is associated with this terminal \n\n
\nValid Values \n\n- `0` - **Transaction approved.**\n- `1` - **Partially approved. The processor has only approved a portion of the total transaction amount.**\n- `2` - **Declined. The processor has declined the Transaction.**\n- `3` - **Verification successful, values provided matched.**\n- `4` - **Verification unsuccessful, values provided did not match.**\n- `5` - **The ZIP code in the Transaction data does not match the customer details held by the card issuer.**\n- `6` - **The address in the Transaction data does not match the customer details held by the card issuer.**\n- `7` - **The name in the Transaction data does not match the customer details held by the card issuer.**\n- `8` - **The name and phone number in the Transaction data do not match the details held by the card issuer.**\n- `9` - **The name and email address in the Transaction data do not match the customer details held by the card issuer.**\n- `10` - **The phone number in the Transaction data does not match the customer details held by the card issuer.**\n- `11` - **The phone number and email address in the Transaction data do not match the customer details held by the card issuer.**\n- `12` - **The email address in the Transaction data does not match the customer details held by the card issuer.**\n- `13` - **The customer name could not be found in the Transaction data.**\n- `14` - **The customer name and phone number were not found in the Transaction data.**\n- `15` - **The customer name and email address were not found in the Transaction data.**\n- `16` - **The customer phone number was not found in the Transaction data.**\n- `17` - **The customer phone number and email address were not found in the Transaction data.**\n- `18` - **The customer email address was not found in the Transaction data.**\n- `19` - **Information about the customer was not found in the Transaction data.**\n- `20` - **Non-sufficient funds. The customer did not have sufficient credit or balance to cover the Transaction.**\n- `21` - **The account in the Transaction data is not valid.**\n- `22` - **The account is unauthorized.**\n- `23` - **General error.**\n- `24` - **The ZIP code in the Transaction data was not verified.**\n- `25` - **The ZIP code and the Address in the Transaction data were not verified.**\n- `26` - **The Address in the Transaction data was not verified.**\n- `27` - **Txn did not fail but was not captured.**\n- `28` - **3DS authentication passed.**\n- `29` - **3DS authentication is invalid.**\n- `30` - **3DS authentication failed.**\n- `31` - **3DS authentication was not validated.**\n- `32` - **3DS authentication passed without liability shift.**\n- `33` - **Transaction processing timed out.**\n- `34` - **Transaction cancelled \n\n
" } ] }, "originalCode": { "type": "string", "description": "Exact message code as received from the activation integration or from the processor for the resulting transaction." }, "bankCode": { "allOf": [ { "$ref": "#/$defs/txnResultsBankCode" }, { "description": "Exact message code as received from the activation integration or\nfrom the processor for the resulting transaction.\n\n
\nValid Values\n\n- `ACCEPTED_BUT_NOT_YET_PROCESSED` - **accepted_but_not_yet_processed**\n- `ACCOUNT_BLOCKED` - **account_blocked**\n- `ACCOUNT_IS_PURGED` - **account_is_purged**\n- `ACCOUNT_LOCKED` - **account_locked**\n- `ACCOUNT_ON_HOLD_OR_NOT_ACTIVE` - **account_on_hold_or_not_active**\n- `ACCOUNT_NOT_ACTIVATED` - **account_not_activated**\n- `ACCOUNT_RELOADS_EXCEEDED` - **account_reloads_exceeded**\n- `ACCOUNT_ROW_LOCKED` - **account_row_locked**\n- `ACCOUNT_STATUS_IS_VOID_LOCK` - **account_status_is_void_lock**\n- `ACH_PAYMENT_NOT_ACCEPTED` - **ach_payment_not_accepted**\n- `ACQUIRER_CHANNEL_UNAVAILABLE` - **acquirer_channel_unavailable**\n- `ACTIVATION_FAILED` - **activation_failed**\n- `ADDITIVE_LIMIT_EXCEEDED` - **additive_limit_exceeded**\n- `ADDRESS_NO_MATCH` - **zip_match_address_mismatch**\n- `ADDRESS_NOT_VERIFIED` - **zip_match_address_not_verified**\n- `ALREADY_REDEEMED` - **already_redeemed**\n- `ALREADY_REVERSED` - **already_reversed**\n- `AMOUNT_LIMIT_EXCEEDED` - **amount_limit_exceeded**\n- `AMOUNT_TOO_LARGE` - **amount_too_large**\n- `APPROVE_WITH_ID` - **approve_with_id**\n- `APPROVED` - **approved**\n- `APPROVED_EMV_KEY_LOAD` - **approved_emv_key_load**\n- `APPROVED_WITH_NO_CASH` - **approved_with_no_cash**\n- `APPROVED_WITH_OVERDRAFT` - **approved_with_overdraft**\n- `AUTHORIZATION_ID_NEEDED` - **authorization_id_needed**\n- `BAD_ACCOUNT` - **bad_account**\n- `BAD_CHECKSUM` - **bad_checksum**\n- `BAD_CLOSE` - **bad_close**\n- `BAD_MAG_STRIPE` - **bad_mag_stripe**\n- `BAD_POST_DATE` - **bad_post_date**\n- `BAD_REPAY_DATE` - **bad_repay_date**\n- `BALANCE_NOT_AVAILABLE` - **balance_not_available**\n- `BILL_TO_SHIP_TO_MISMATCH` - **bill_to_ship_to_mismatch**\n- `BIN_BLOCKED` - **bin_blocked**\n- `BLOCKED_BY_CARDHOLDER` - **blocked_by_cardholder**\n- `BULK_ACTIVATION_ERROR` - **bulk_activation_error**\n- `BULK_ACTIVATION_PACKAGE_AMOUNT_ERROR` - **bulk_activation_package_amount_error**\n- `CALL_ACQUIRER` - **call_acquirer**\n- `CALL_FOR_AUTHORIZATION` - **call_for_authorization**\n- `CALL_ISSUER` - **call_issuer**\n- `CALL_TELECHECK` - **call_telecheck**\n- `CANNOT_FIND_NETWORK` - **cannot_find_network**\n- `CARD_ALREADY_ACTIVE` - **card_already_active**\n- `CARD_ALREADY_CLOSED` - **card_already_closed**\n- `CARD_NOT_ACTIVE` - **card_not_active**\n- `CARD_NOT_SUPPORTED` - **card_not_supported**\n- `CARD_VELOCITY_AMOUNT_EXCEEDED` - **card_velocity_amount_exceeded**\n- `CARD_VELOCITY_COUNT_EXCEEDED` - **card_velocity_count_exceeded**\n- `CARD_VELOCITY_EXCEEDED` - **card_velocity_exceeded**\n- `CASHBACK_GREATER_THAN_TRANSACTION_AMOUNT` - **cashback_greater_than_transaction_amount**\n- `CASH_LIMIT_EXCEEDED` - **cash_limit_exceeded**\n- `CENTER_CLOSED` - **center_closed**\n- `CHECKER/MANAGER_NOT_FOUND` - **checker/manager_not_found**\n- `CHIP_FAILURE` - **chip_failure**\n- `CLOSE_UNAVAILABLE` - **close_unavailable**\n- `CLOSE_NOT_VALID` - **close_not_valid**\n- `CLOSED_ACCOUNT` - **closed_account**\n- `COUNT_EXCEEDS_LIMIT` - **count_exceeds_limit**\n- `COUNTERFEIT_CARD` - **counterfeit_card**\n- `COUNTER_OFFER_TO_SUPPLY_PERSONAL_GUARANTY` - **counter_offer_to_supply_personal_guaranty**\n- `CRYPTOGRAM_DECRYPTION_ERROR` - **cryptogram_decryption_error**\n- `CRYPTO_BOX_IS_OFFLINE` - **crypto_box_is_offline**\n- `CURRENCY_CONVERSION_COMPLETE` - **currency_conversion_complete**\n- `CURRENCY_CONVERSION_ERROR` - **currency_conversion_error**\n- `CURRENCY_NOT_SUPPORTED` - **currency_not_supported**\n- `CUSTOMER_CANCELLATION` - **customer_cancellation**\n- `CUSTOMER_OPT_OUT` - **customer_opt_out**\n- `CUT_TIME_CLOSE_TO_1400` - **cut_time_close_to_1400**\n- `CVV_DECLINED` - **cvv_declined**\n- `CVV_FAILED` - **cvv_failed**\n- `DAILY_LIMIT_EXCEEDED` - **daily_limit_exceeded**\n- `DATE_OF_BIRTH_ERROR` - **date_of_birth_error**\n- `DEBIT_GATEWAY_UNAVAILABLE` - **debit_gateway_unavailable**\n- `DECLINED` - **declined**\n- `DECLINED_DUE_TO_STAND_IN_RULES` - **declined_due_to_stand_in_rules**\n- `DECONVERTED_BIN` - **deconverted_bin**\n- `DO_NOT_HONOR` - **do_not_honor**\n- `DO_NOT_TRY_AGAIN` - **do_not_try_again**\n- `DO_NOT_TRY_AGAIN_SUBSEQUENT_MAY_CONTINUE` - **do_not_try_again_subsequent_may_continue**\n- `DRIVERS_LICENSE_OR_ID_REQUIRED` - **drivers_license_or_id_required**\n- `DUPLICATE_CAPTURE` - **duplicate_capture**\n- `DUPLICATE_RETURN` - **duplicate_return**\n- `DUPLICATE_REVERSAL` - **duplicate_reversal**\n- `DUPLICATE_TRANSACTION` - **duplicate_transaction**\n- `EDIT_HONOR` - **edit_honor**\n- `EMAIL_NO_MATCH` - **email_no_match**\n- `EMAIL_UNAVAILABLE` - **email_unavailable**\n- `EMV_KEY_DOWNLOAD_ERROR` - **emv_key_download_error**\n- `ENTER_LESSER_AMOUNT` - **enter_lesser_amount**\n- `ERROR_PROCESSING_PIN_BLOCK` - **error_processing_pin_block**\n- `EXCEEDS_GLOBAL_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_amount_for_period_pay_inside**\n- `EXCEEDS_GLOBAL_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_count_for_period_pay_inside**\n- `EXCEEDS_GLOBAL_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_global_limits_for_period_pay_inside**\n- `EXCEEDS_LIMIT` - **exceeds_limit**\n- `EXCEEDS_MERCHANT_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_amount_for_period_pay_inside**\n- `EXCEEDS_MERCHANT_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_count_for_period_pay_inside**\n- `EXCEEDS_MERCHANT_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_merchant_limits_for_period_pay_inside**\n- `EXCEEDS_STATE_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_amount_for_period_pay_inside**\n- `EXCEEDS_STATE_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_count_for_period_pay_inside**\n- `EXCEEDS_STATE_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_state_limits_for_period_pay_inside**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_24_HOURS` - **exceeds_transaction_count_or_amount_limit_in_24_hours**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_7_DAYS` - **exceeds_transaction_count_or_amount_limit_in_7_days**\n- `EXCEEDS_TRANSACTION_COUNT_OR_AMOUNT_LIMIT_IN_30_DAYS` - **exceeds_transaction_count_or_amount_limit_in_30_days**\n- `EXCEEDS_ZIP_CODE_AMOUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_amount_for_period_pay_inside**\n- `EXCEEDS_ZIP_CODE_COUNT_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_count_for_period_pay_inside**\n- `EXCEEDS_ZIP_CODE_LIMITS_FOR_PERIOD_PAY_INSIDE` - **exceeds_zip_code_limits_for_period_pay_inside**\n- `EXPIRED_CARD` - **expired_card**\n- `EXPIRED_LOCK` - **expired_lock**\n- `FRAUDULENT` - **fraudulent**\n- `FILE_TEMPORARILY_UNAVAILABLE` - **file_temporarily_unavailable**\n- `FILE_UPDATE_ERROR` - **file_update_error**\n- `FILE_UPDATE_UNAVAILABLE` - **file_update_unavailable**\n- `FORMAT_ERROR` - **format_error**\n- `FORWARD_TO_ISSUER` - **forward_to_issuer**\n- `FUEL_LIMIT_EXCEEDED` - **fuel_limit_exceeded**\n- `FUEL_ONLY` - **fuel_only**\n- `FUEL_PRICE_ERROR` - **fuel_price_error**\n- `FULL_SSN_REQUIRED` - **full_ssn_required**\n- `FUNCTION_NOT_SUPPORTED` - **function_not_supported**\n- `FUNDS_ON_HOLD` - **funds_on_hold**\n- `GENERAL` - **general**\n- `GENERAL_ERROR` - **general_error**\n- `GENERIC_DECLINE` - **generic_decline**\n- `HARD_CAPTURE_PICKUP_CARD` - **hard_capture_pickup_card**\n- `HARD_NEGATIVE_INFO_ON_FILE` - **hard_negative_info_on_file**\n- `HIGH_RISK` - **high_risk**\n- `HOLD_SHIPPING_FOR_24H` - **hold_shipping_for_24h**\n- `HONOR_WITH_AUTHENTICATION` - **honor_with_authentication**\n- `ILLEGAL_TRANSACTION` - **illegal_transaction**\n- `IMPRINT_CARD` - **imprint_card**\n- `INCORRECT_CVV` - **incorrect_cvv**\n- `INCORRECT_NUMBER` - **incorrect_number**\n- `INCORRECT_PIN` - **incorrect_pin**\n- `INCORRECT_MERCHANT_LOCATION` - **incorrect_merchant_location**\n- `INCORRECT_TRANSACTION_VERSION` - **incorrect_transaction_version**\n- `INQUIRY_DECLINED` - **inquiry_declined**\n- `INSUFFICIENT_DATA` - **insufficient_data**\n- `INSUFFICIENT_FUNDS` - **insufficient_funds**\n- `INSUFFICIENT_SECURITY` - **insufficient_security**\n- `INTERNET_ACCESS_DISABLED` - **internet_access_disabled**\n- `INVALID_3D_PASSWORD` - **invalid_3d_password**\n- `INVALID_ACCOUNT` - **invalid_account**\n- `INVALID_ACCOUNT/DATE` - **invalid_account/date**\n- `INVALID_ACCOUNT_TYPE` - **invalid_account_type**\n- `INVALID_ACTIVATE` - **invalid_activate**\n- `INVALID_AMOUNT` - **invalid_amount**\n- `INVALID_AUTHORIZATION_CODE` - **invalid_authorization_code**\n- `INVALID_BATCH_NUMBER/ID` - **invalid_batch_number/id**\n- `INVALID_CASHBACK` - **invalid_cashback**\n- `INVALID_CHECKING_ACCOUNT` - **invalid_checking_account**\n- `INVALID_CHECKING_ACCOUNT_NUMBER` - **invalid_checking_account_number**\n- `INVALID_CLERK` - **invalid_clerk**\n- `INVALID_CREDIT_ACCOUNT` - **invalid_credit_account**\n- `INVALID_CURRENCY` - **invalid_currency**\n- `INVALID_CVV` - **invalid_cvv**\n- `INVALID_DATE_OR_TIME` - **invalid_date_or_time**\n- `INVALID_DRIVER` - **invalid_driver**\n- `INVALID_EAN_OR_SCV` - **invalid_ean_or_scv**\n- `INVALID_EFFECTIVE_DATE` - **invalid_effective_date**\n- `INVALID_EMAIL_ADDRESS` - **invalid_email_address**\n- `INVALID_ENTRY` - **invalid_entry**\n- `INVALID_EXPIRY_DATE` - **invalid_expiry_date**\n- `INVALID_EXPIRY_YEAR` - **invalid_expiry_year**\n- `INVALID_HOST` - **invalid_host**\n- `INVALID_LOCATION` - **invalid_location**\n- `INVALID_MAIDEN_NAME` - **invalid_maiden_name**\n- `INVALID_MCC` - **invalid_mcc**\n- `INVALID_MERCHANT` - **invalid_merchant**\n- `INVALID_MERCHANT_ID` - **invalid_merchant_id**\n- `INVALID_MERCHANT_ID/SE` - **invalid_merchant_id/se**\n- `INVALID_MERCHANT_SETUP` - **invalid_merchant_setup**\n- `INVALID_MICR_DATA` - **invalid_micr_data**\n- `INVALID_NEW_PASSWORD` - **invalid_new_password**\n- `INVALID_NOT_PRESENT` - **invalid_not_present**\n- `INVALID_NUMBER` - **invalid_number**\n- `INVALID_ODOMETER` - **invalid_odometer**\n- `INVALID_PASSWORD` - **invalid_password**\n- `INVALID_PIN` - **invalid_pin**\n- `INVALID_POS` - **invalid_pos**\n- `INVALID_PREAPPROVAL_NUMBER` - **invalid_preapproval_number**\n- `INVALID_PREFIX` - **invalid_prefix**\n- `INVALID_PRODUCT` - **invalid_product**\n- `INVALID_PROMPT_ENTRY` - **invalid_prompt_entry**\n- `INVALID_REQUEST` - **invalid_request**\n- `INVALID_RESPONSE` - **invalid_response**\n- `INVALID_RESPONSE_DATE` - **invalid_response_date**\n- `INVALID_RESTRICTION_CODE` - **invalid_restriction_code**\n- `INVALID_SAVINGS_ACCOUNT` - **invalid_savings_account**\n- `INVALID_SECURE_PAYMENT_DATA` - **invalid_secure_payment_data**\n- `INVALID_SKU` - **invalid_sku**\n- `INVALID_SSN` - **invalid_ssn**\n- `INVALID_STATE_CODE` - **invalid_state_code**\n- `INVALID_STATUS_CHANGE` - **invalid_status_change**\n- `INVALID_TERMINAL` - **invalid_terminal**\n- `INVALID_TGN_CIC` - **invalid_tgn_cic**\n- `INVALID_TIMEZONE` - **invalid_timezone**\n- `INVALID_TPPID` - **invalid_tppid**\n- `INVALID_TRACK_DATA` - **invalid_track_data**\n- `INVALID_TRANSACTION` - **invalid_transaction**\n- `INVALID_TRANSARMOR_TRANSACTION` - **invalid_transarmor_transaction**\n- `INVALID_USER` - **invalid_user**\n- `INVALID_VALUE_IN_THE_FIELD` - **invalid_value_in_the_field**\n- `INVALID_VEHICLE` - **invalid_vehicle**\n- `INVALID_VOID_OF_ACTIVATION` - **invalid_void_of_activation**\n- `INVALID_ZIP_CODE` - **invalid_zip_code**\n- `ISSUANCE_UNDER_MINIMUM_AMOUNT` - **issuance_under_minimum_amount**\n- `ISSUER_NOT_AVAILABLE` - **issuer_not_available**\n- `ISSUER_PROCESSOR_OR_SWITCH_NOT_AVAILABLE` - **issuer_processor_or_switch_not_available**\n- `ISSUER_SPECIAL_CONDITIONS` - **issuer_special_conditions**\n- `ISSUER_VELOCITY_AMOUNT_EXCEEDED` - **issuer_velocity_amount_exceeded**\n- `ISSUER_VELOCITY_COUNT_EXCEEDED` - **issuer_velocity_count_exceeded**\n- `LATE_REVERSAL` - **late_reversal**\n- `LAW_VIOLATION` - **law_violation**\n- `LIMIT_CHECK_FAILED` - **limit_check_failed**\n- `LOST_CARD` - **lost_card**\n- `MAIDEN_NAME_UNAVAILABLE` - **maiden_name_unavailable**\n- `MANUAL_TRIES_EXCEEDED` - **manual_tries_exceeded**\n- `MATCH` - **match**\n- `MAX_BALANCE_EXCEEDED` - **max_balance_exceeded**\n- `MERCHANT_DEPLETED` - **merchant_depleted**\n- `MERCHANT_HAS_MAIL_PENDING` - **merchant_has_mail_pending**\n- `MESSAGE_FORMAT_ERROR` - **message_format_error**\n- `MINUS2_DEBIT` - **minus2_debit**\n- `MISSING_CONDITIONAL_DATA` - **missing_conditional_data**\n- `MISSING_CUSTOMER_SERVICE_PHONE` - **missing_customer_service_phone**\n- `MISSING_FROM_ACCOUNT` - **missing_from_account**\n- `MISSING_TO_ACCOUNT` - **missing_to_account**\n- `MULTI_CURRENCY_DCC_FAIL` - **multi_currency_dcc_fail**\n- `MULTI_CURRENCY_INVERT_FAIL` - **multi_currency_invert_fail**\n- `MULTIPLE_ACCOUNTS_FOR_TYPE` - **multiple_accounts_for_type**\n- `NAME_EMAIL_NO_MATCH` - **name_email_no_match**\n- `NAME_EMAIL_UNAVAILABLE` - **name_email_unavailable**\n- `NAME_NO_MATCH` - **name_no_match**\n- `NAME_PHONE_NO_MATCH` - **name_phone_no_match**\n- `NAME_PHONE_UNAVAILABLE` - **name_phone_unavailable**\n- `NAME_UNAVAILABLE` - **name_unavailable**\n- `NEGATIVE_FILE_EXCEPTION` - **negative_file_exception**\n- `NEW_ACCOUNT_INFORMATION_AVAILABLE` - **new_account_information_available**\n- `NEW_CARD_ISSUED` - **new_card_issued**\n- `NEW_PASSWORD_REQUIRED` - **new_password_required**\n- `NO_ACCOUNT_LINK` - **no_account_link**\n- `NO_ACTION_TAKEN` - **no_action_taken**\n- `NO_CARD_RECORD` - **no_card_record**\n- `NO_CHAIN_ID` - **no_chain_id**\n- `NO_CHECKING_ACCOUNT` - **no_checking_account**\n- `NO_MATCH` - **mismatch**\n- `NO_MESSAGES_PENDING` - **no_messages_pending**\n- `NO_OPEN_BATCH` - **no_open_batch**\n- `NO_PHONE_SERVICE` - **no_phone_service**\n- `NO_PREVIOUS_TRANSACTION` - **no_previous_transaction**\n- `NO_REASON_TO_DECLINE` - **no_reason_to_decline**\n- `NO_SAVINGS_ACCOUNT` - **no_savings_account**\n- `NO_SUCH_ISSUER` - **no_such_issuer**\n- `NO_TO_ACCOUNT` - **no_to_account**\n- `NO_TRANSACTIONS_AVAILABLE` - **no_transactions_available**\n- `NO_TRANSACTION_SECURITY_RECORD` - **no_transaction_security_record**\n- `NOT_ACCEPTED` - ** not_accepted**\n- `NOT_ACTIVE` - **not_active**\n- `NOT_LOST_OR_STOLEN` - **not_lost_or_stolen**\n- `NOT_ON_FILE` - **not_on_file**\n- `NOT_PERMITTED` - **not_permitted**\n- `NOT_PERFORMED` - **not_performed**\n- `NOT_PROCESSED` - **not_processed**\n- `NOT_SUPPORTED` - **not_supported**\n- `NSF` - **nsf**\n- `ONE_TIME_STOP_PAYMENT` - **one_time_stop_payment**\n- `ORIGINAL_AUTHORIZATION_MISMATCH` - **original_authorization_mismatch**\n- `ORIGINAL_AUTHORIZATION_NOT_FOUND` - **original_authorization_not_found**\n- `ORIGINAL_REPEATED` - **original_repeated**\n- `ORIGINAL_TRANSACTION_NOT_APPROVED` - **original_transaction_not_approved**\n- `OVER_CHAIN_DAILY_VELOCITY_AMOUNT` - **over_chain_daily_velocity_amount**\n- `OVER_CHAIN_DAILY_VELOCITY_COUNT` - **over_chain_daily_velocity_count**\n- `OVER_CHAIN_DAILY_VELOCITY_LIMITS` - **over_chain_daily_velocity_limits**\n- `OVER_CHAIN_PRODUCT_VELOCITY_AMOUNT` - **over_chain_product_velocity_amount**\n- `OVER_CHAIN_PRODUCT_VELOCITY_COUNT` - **over_chain_product_velocity_count**\n- `OVER_CHAIN_PRODUCT_VELOCITY_LIMITS` - **over_chain_product_velocity_limits**\n- `OVER_MAX_BALANCE` - **over_max_balance**\n- `OVER_MERCHANDISE_LIMIT` - **over_merchandise_limit**\n- `OVER_MERCHANT_DAILY_VELOCITY_AMOUNT` - **over_merchant_daily_velocity_amount**\n- `OVER_MERCHANT_DAILY_VELOCITY_COUNT` - **over_merchant_daily_velocity_count**\n- `OVER_MERCHANT_DAILY_VELOCITY_LIMITS` - **over_merchant_daily_velocity_limits**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_AMOUNT` - **over_merchant_product_velocity_amount**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_COUNT` - **over_merchant_product_velocity_count**\n- `OVER_MERCHANT_PRODUCT_VELOCITY_LIMITS` - **over_merchant_product_velocity_limits**\n- `OVER_MONTHLY_LIMIT` - **over_monthly_limit**\n- `OVER_NON_FUEL_LIMIT` - **over_non_fuel_limit**\n- `PAN_TRANS_ERROR` - **pan_trans_error**\n- `PARTIAL_AUTH_NOT_ALLOWED` - **partial_auth_not_allowed**\n- `PARTIAL_REVERSAL` - **partial_reversal**\n- `PARTIALLY_APPROVED` - **partially_approved**\n- `PASSWORD_RETRIES_EXCEEDED` - **password_retries_exceeded**\n- `PAY_AT_PUMP_NOT_ALLOWED` - **pay_at_pump_not_allowed**\n- `PHONE_EMAIL_NO_MATCH` - **phone_email_no_match**\n- `PHONE_EMAIL_UNAVAILABLE` - **phone_email_unavailable**\n- `PHONE_NO_MATCH` - **phone_no_match**\n- `PHONE_UNAVAILABLE` - **phone_unavailable**\n- `PICKUP_CARD` - **pickup_card**\n- `PIN_ALREADY_EXISTS` - **pin_already_exists**\n- `PIN_KEY_ERROR` - **pin_key_error**\n- `PIN_KEY_SYNCHRONIZATION_ERROR` - **pin_key_sychronization_error**\n- `PIN_TRY_EXCEEDED` - **pin_try_exceeded**\n- `PLEASE_RETRY` - **please_retry**\n- `PROCESS_AS_DEBIT` - **process_as_debit**\n- `PROCESSING_ERROR` - **processing_error**\n- `PRODUCT_CODE_RESTRICTED` - **product_code_restricted**\n- `PROMO_LOCATION_RESTRICTED` - **promo_location_restricted**\n- `QUANTITY_EXCEEDED` - **quantity_exceeded**\n- `REAUTHORIZATION_TIMEFRAME_EXPIRED` - **reauthorization_timeframe_expired**\n- `RECHARGE_AMOUNT_EXCEEDED` - **recharge_amount_exceeded**\n- `RECHARGE_COUNT_EXCEEDED` - **recharge_count_exceeded**\n- `REENTER_TRANSACTION` - **reenter_transaction**\n- `REFERRAL` - **referral**\n- `REJECT_MESSAGE` - **reject_message**\n- `REJECTED_LOST/STOLEN_CHECKS` - **rejected_lost/stolen_checks**\n- `REPAIR_LIMIT_EXCEEDED` - **repair_limit_exceeded**\n- `REQUEST_IN_PROGRESS` - **request_in_progress**\n- `RESPONSE_RECEIVED_LATE` - **response_received_late**\n- `RESTRICTED_CARD` - **restricted_card**\n- `RESUBMISSION_VIOLATES_NETWORK_FREQUENCY` - **resubmission_violates_network_frequency**\n- `RETAIN_CARD` - **retain_card**\n- `REVERSAL` - **reversal**\n- `REVERSAL_NO_MATCH` - **reversal_no_match**\n- `REVERSAL_UNSUCCESSFUL` - **reversal_unsuccessful**\n- `REVOCATION_OF_ALL_AUTHORIZATIONS` - **revocation_of_all_authorizations**\n- `REVOCATION_OF_AUTHORIZATION` - **revocation_of_authorization**\n- `SECURE_CODE_NOT_ENABLED` - **secure_code_not_enabled**\n- `SECURITY_ERROR` - **security_error**\n- `SECURITY_ERROR_TRY_AGAIN` - **security_error_try_again**\n- `SECURITY_VIOLATION` - **security_violation**\n- `SEE_ATTENDANT` - **see_attendant**\n- `SEE_EXHIBIT_FOR_ERROR` - **see_exhibit_for_error**\n- `SERVICE_NOT_ALLOWED` - **service_not_allowed**\n- `SIGNATURE_REQUIRED` - **signature_required**\n- `SKIP_TRACE_INFO` - **skip_trace_info**\n- `SOFT_DESCRIPTOR_NOT_ENABLED` - **soft_descriptor_not_enabled**\n- `SSN_NOT_AVAILABLE` - **ssn_not_available**\n- `STOLEN_CARD` - **stolen_card**\n- `STOP_PAYMENT_ORDER` - **stop_payment_order**\n- `STOP_RECURRING_PAYMENT_REQUESTS` - **stop_recurring_payment_requests**\n- `STORE_LOCATION_ZERO_NOT_ALLOWED` - **store_location_zero_not_allowed**\n- `SUBSYSTEM_UNAVAILABLE` - **subsystem_unavailable**\n- `SURCHARGE_LIMIT_EXCEEDED` - **surcharge_limit_exceeded**\n- `SYSTEM_ERROR` - **system_error**\n- `TARGET_CARD_AND_TRANSACTION_COUNT_MISMATCH` - **target_card_and_transaction_count_mismatch**\n- `TRANSACTION_NUMBER_MISMATCH` - **transaction_number_mismatch**\n- `TESTMODE_DECLINE` - **testmode_decline**\n- `TICKET_LIMIT_EXCEEDED` - **ticket_limit_exceeded**\n- `TIMEOUT` - **timeout**\n- `TIMEOUT_REVERSAL_NOT_SUPPORTED` - **timeout_reversal_not_supported**\n- `TOO_MANY_TRANSACTIONS_REQUESTED` - **too_many_transactions_requested**\n- `TOTALS_UNAVAILABLE` - **totals_unavailable**\n- `TRANSACTION_COUNT_OR_WITHDRAWAL_LIMIT_EXCEEDED` - **transaction_count_or_withdrawal_limit_exceeded**\n- `TRANSACTION_DESTINATION_NOT_FOUND_FOR_ROUTING` - **transaction_destination_not_found_for_routing**\n- `TRANSACTION_HISTORY_UNAVAILABLE` - **transaction_history_unavailable**\n- `TRANSACTION_NOT_ALLOWED` - **transaction_not_allowed**\n- `TRANSACTION_NOT_PERMITTED` - **transaction_not_permitted**\n- `TRANSACTION_NOT_SUPPORTED` - **transaction_not_supported**\n- `TRANSACTION_TOTAL_LIMIT_PER_PRODUCT_CLASS_EXCEEDED` - **transaction_total_limit_per_product_class_exceeded**\n- `TRANSARMOR_INVALID_TOKEN_OR_ACCOUNT_NUMBER` - **transarmor_invalid_token_or_account_number**\n- `TRANSARMOR_KEY_ERROR` - **transarmor_key_error**\n- `TRANSARMOR_SERVICE_UNAVAILABLE` - **transarmor_service_unavailable**\n- `TRY_AGAIN_LATER` - **try_again_later**\n- `UNABLE_TO_LOCATE_PREVIOUS_MESSAGE` - **unable_to_locate_previous_message**\n- `UNABLE_TO_LOCATE_RECORD` - **unable_to_locate_record**\n- `UNABLE_TO_PROCESS` - **unable_to_process**\n- `UNABLE_TO_VERIFY_PIN` - **unable_to_verify_pin**\n- `UNAUTHORIZED` - **unauthorized**\n- `UNAVAILABLE` - **unavailable**\n- `UNDEFINED_CARD` - **undefined_card**\n- `UNDERAGE_CUSTOMER` - **underage_customer**\n- `UNKNOWN_VELOCITY_ERROR_PAY_INSIDE` - **unknown_velocity_error_pay_inside**\n- `UNSUCCESSFUL` - **unsuccessful**\n- `UNSUPPORTED_MESSAGE` - **unsupported_message**\n- `VALIDATION_ERROR` - **validation_error**\n- `VELOCITY_ERROR_PAY_INSIDE` - **velocity_error_pay_inside**\n- `VERIFICATION_TRANSACTION` - **verification_transaction**\n- `VIOLATION_OF_BUSINESS_ARRANGEMENT` - **violation_of_business_arrangement**\n- `VISA_OCT/MASTERCARD_MONEYSEND_TRANSACTIONS_BLOCKED` - **visa_oct/mastercard_moneysend_transactions_blocked**\n- `VOID_CAPTURED_ITEM` - **void_captured_item**\n- `VOYAGER_ID_PROBLEM` - **voyager_id_problem**\n- `Y_OR_N_REQUIRED` - **y_or_n_required**\n- `WAIT_2_PM_EASTERN` - **wait_2_pm_eastern**\n- `WITHDRAWAL_COUNT_LIMIT_EXCEEDED` - **withdrawal_count_limit_exceeded**\n- `WITHDRAWAL_LIMIT_EXCEEDED` - **withdrawal_limit_exceeded**\n- `ZIP_ADDRESS_NOT_VERIFIED` - **zip_and_address_not_verified**\n- `ZIP_NO_MATCH` - **address_match_zip_mismatch**\n- `ZIP_NOT_VERIFIED` - **zip_not_verified**\n- `3DS_AUTHENTICATION_SUCCESSFUL` - **3ds_authentication_successful**\n- `3DS_AUTHENTICATION_INVALID` - **3ds_authentication_invalid**\n- `3DS_AUTHENTICATION_FAILED` - **3ds_authentication_failed**\n- `3DS_AUTHENTICATION_NOT_VALIDATED` - **3ds_authentication_not_validated**\n- `3DS_AUTHENTICATION_SUCCESSFUL_WITHOUT_LIABILITY_SHIFT` - **3ds_authentication_successful_without_liability_shift** \n\n
" } ] } } }, "txnStatus": { "title": "txnStatus", "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer" }, "txnSubmittedMethod": { "title": "txnSubmittedMethod", "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" }, "txnsDatasModelTxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "The identifier of the Transaction associated with this TxnDatas resource." }, "txnsDatasResponse": { "title": "txnsDatasResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "txn": { "allOf": [ { "$ref": "#/$defs/txnsDatasModelTxn" }, { "description": "The identifier of the Transaction associated with this TxnDatas resource." } ] }, "signature": { "type": "string", "description": "The Base64 encoded image of the signature captured at the time of entering the Transaction." } } }, "txnsDebtRepayment": { "title": "txnsDebtRepayment", "enum": [ 0, 1 ], "type": "integer" }, "txnsFundingEnabled": { "title": "txnsFundingEnabled", "enum": [ 0, 1 ], "type": "integer" }, "txnsImported": { "title": "txnsImported", "enum": [ 0, 1 ], "type": "integer" }, "txnsMisused": { "title": "txnsMisused", "enum": [ 0, 1 ], "type": "integer" }, "txnsMobile": { "title": "txnsMobile", "enum": [ 0, 1 ], "type": "integer" }, "txnsModelBatch": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/batchesResponse" } ], "description": "If the Transaction is linked to a Batch, this field specifies the identifier of the Batch." }, "txnsModelFortxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "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." }, "txnsModelFromtxn": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnsResponse" } ], "description": "Reauthorize this referenced Transaction. For example, to process a resubmission of a declined Transaction or to reauthorize an expired Transaction." }, "txnsModelMerchant": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/merchantsResponse" } ], "description": "The identifier of the Merchant associated with this Transaction." }, "txnsModelPayment": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/paymentResponse" } ], "description": "The payment method associated with this Transaction, including the card details." }, "txnsModelStatement": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/statementsResponse" } ], "description": "The statement ID for which this transaction is being processed as payment." }, "txnsModelSubscription": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/subscriptionsResponse" } ], "description": "The identifier of the Subscription associated with this Transaction." }, "txnsModelToken": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/tokensResponse" } ], "description": "The token of the Tokens resource this Transaction is associated with." }, "txnsModelTxnRefs": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/txnRefsResponse" } ], "description": "A list of references related to this Transaction." }, "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" }, "txnsReserved": { "title": "txnsReserved", "enum": [ 0, 1, 3, 4, 5, 8 ], "type": "integer" }, "txnsResponse": { "title": "txnsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "ipCreated": { "type": "string", "description": "The incoming ip address from which this Transaction was created." }, "ipModified": { "type": "string", "description": "The incoming ip address from which this Transaction was last modified." }, "merchant": { "allOf": [ { "$ref": "#/$defs/txnsModelMerchant" }, { "description": "The identifier of the Merchant associated with this Transaction." } ] }, "token": { "allOf": [ { "$ref": "#/$defs/txnsModelToken" }, { "description": "The token of the Tokens resource this Transaction is associated with." } ] }, "payment": { "allOf": [ { "$ref": "#/$defs/txnsModelPayment" }, { "description": "The payment method associated with this Transaction, including the card details." } ] }, "fortxn": { "allOf": [ { "$ref": "#/$defs/txnsModelFortxn" }, { "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": { "allOf": [ { "$ref": "#/$defs/txnsModelFromtxn" }, { "description": "Reauthorize this referenced Transaction. For example, to process a resubmission of a declined Transaction or to reauthorize an expired Transaction." } ] }, "batch": { "allOf": [ { "$ref": "#/$defs/txnsModelBatch" }, { "description": "If the Transaction is linked to a Batch, this field specifies the identifier of the Batch." } ] }, "subscription": { "allOf": [ { "$ref": "#/$defs/txnsModelSubscription" }, { "description": "The identifier of the Subscription associated with this Transaction." } ] }, "statement": { "allOf": [ { "$ref": "#/$defs/txnsModelStatement" }, { "description": "The statement ID for which this transaction is being processed as payment." } ] }, "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
" } ] }, "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." }, "serviceCode": { "type": "string", "description": "The service code retrieved from the track data for a credit card swiped transaction." }, "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." }, "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." } ] }, "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
" } ] }, "convenienceFee": { "type": "integer", "description": "The amount of the total sum of this Transaction that is made up of convenience fee. Fee charged when card payment is an alternative form of payment not ordinarily accepted by a merchant or service provider. This field is specified as an integer in cents. [currently not active]", "contentEncoding": "int32" }, "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)" }, "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
" } ] }, "authDate": { "type": "integer", "description": "The date on which the Transaction was authorized. \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 past.", "contentEncoding": "int32" }, "authCode": { "type": "string", "description": "The authorization code for this Transaction. \nThis field is stored as a text string and must be between 0 and 20 characters long." }, "captured": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "A timestamp indicating when this Transaction was captured. \nThis field is set automatically. The format should be YYYY-MM-DD HH:MM:SS." }, "settled": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "A date indicating when this Transaction was settled. \nThis field is set automatically. The format should be YYYY-MM-DD HH:MM:SS." }, "settledCurrency": { "allOf": [ { "$ref": "#/$defs/txnsSetteledCurrency" }, { "description": "The currency of the settled total. \nThis field is set automatically." } ] }, "settledTotal": { "type": "integer", "description": "The total amount that was settled. \nThis field is specified as an integer in cents and is set automatically.", "contentEncoding": "int64" }, "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
" } ] }, "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." }, "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." }, "descriptor": { "type": "string", "description": "The descriptor used in this Transaction. \nThis 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." }, "traceNumber": { "type": "integer", "description": "Sequencial number that uniquely identifies the txn.", "contentEncoding": "int64" }, "discount": { "type": "integer", "description": "The discount applied to the transaction.", "contentEncoding": "int64" }, "shipping": { "type": "integer", "description": "The shipping fee pertaining to this transaction.", "contentEncoding": "int64" }, "duty": { "type": "integer", "description": "The duty fee applicable to this transaction.", "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
" } ] }, "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
" } ] }, "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
" } ] }, "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
" } ] }, "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" }, "total": { "type": "integer", "description": "The total amount of this Transaction. \nThis field is specified as an integer in cents.", "contentEncoding": "int64" }, "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" }, "authorization": { "type": "string", "description": "The authorization code for this Transaction, as returned by the network." }, "originalApproved": { "type": "integer", "description": "The amount, in 'cents', of funds originally authorized for the transaction.", "contentEncoding": "int64" }, "approved": { "type": "integer", "description": "The total amount that was approved for this Transaction by the processor. \nThis field is specified as an integer in cents.", "contentEncoding": "int64" }, "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." }, "cvv": { "type": "integer", "description": "Whether correct cvv was sent during this Transaction.", "contentEncoding": "int32" }, "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
" } ] }, "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
" } ] }, "emv": { "allOf": [ { "$ref": "#/$defs/terminalTxnsEmv" }, { "description": "Whether the card was dipped (using the EMV chip) during this Transaction.\n\n
\nValid Values\n\n- `0` - **Not dipped.**\n- `1` - **Dipped.**\n\n
" } ] }, "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
" } ] }, "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
" } ] }, "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
" } ] }, "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
" } ] }, "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
" } ] }, "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
" } ] }, "clientIp": { "type": "string", "description": "The client ip address from which the Transaction was created. \nValid values are any Ipv4 or Ipv6 address." }, "first": { "type": "string", "description": "The first name associated with this Transaction. For eCheck transactions, either first or last is required." }, "middle": { "type": "string", "description": "The middle name associated with this Transaction." }, "last": { "type": "string", "description": "The last name associated with this Transaction. For eCheck transactions, either first or last is required." }, "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." }, "email": { "type": "string", "description": "The email associated with this Transaction." }, "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": { "$ref": "#/$defs/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." }, "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." }, "status": { "allOf": [ { "$ref": "#/$defs/txnStatus" }, { "description": "The status of the Transaction. \n\n
\nValid Values \n\n - `0` - **Pending.**\n\n - `1` - **Approved.** Payments can be voided or cancelled.\n\n - `2` - **Failed**\n\n - `3` - **Captured.** Payments can be refunded.\n\n - `4` - **Settled.** Payments can be refunded.\n\n - `5` - **Returned.** Payments has been successfully refunded.\n\n
" } ] }, "refunded": { "type": "integer", "description": "The amount of this Transaction that has been refunded.", "contentEncoding": "int32" }, "reserved": { "allOf": [ { "$ref": "#/$defs/txnsReserved" }, { "description": "Indicates whether the Transaction is reserved and the action that will be taken as a result.\n\n
\nValid Values\n\n- `0` - **No reserve.**\n- `1` - **Block transaction, will never be processed. The Entity is sent to the manual review queue..**\n- `3` - **Hold transaction, will not be captured.**\n- `4` - **Reserve transaction, funds should be reserved.**\n- `5` - **Block current activity, no change for merchant.**\n- `8` - **We onboard the merchant and wait for manual check later.**\n\n
" } ] }, "misused": { "allOf": [ { "$ref": "#/$defs/txnsMisused" }, { "description": "Indicates if an authorization has been misused by not being captured or reversed within the timeframe, which varies per network, mcc and type of txn closing (capture/reverse auth), with valid values indicating whether it's Not misused (0) or Misused (1). \n\n
\nValid Values \n\n - `0` - **Not misused.**\n\n - `1` - **Misused.**\n\n
" } ] }, "checkStage": { "allOf": [ { "$ref": "#/$defs/txnCheckStage" }, { "description": "The last transaction stage check for risk.\n
\nValid Values\n\n- `activation` - **Terminal activation.**\n- `auth` - **Apply this decision during transaction authorization.**\n- `postauth` - **Apply this decision after transaction authorization.**\n- `capture` - **Apply this decision during transaction capture.**\n- `refund` - **Apply this decision when processing a refund.**\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." }, "imported": { "allOf": [ { "$ref": "#/$defs/txnsImported" }, { "description": "Whether the txn was imported from a report or not, this field is set automatically whether the txn was imported from a report or not. This field is set automatically.\n\n
\nValid Values\n\n- `0` - **Not Imported**\n- `1` - **Imported**\n
" } ] }, "requestSequence": { "type": "integer", "description": "For entry creation and deletion job sequencing: the current request sequence number for this transaction.", "contentEncoding": "int32" }, "processedSequence": { "type": "integer", "description": "For entry creation and deletion job sequencing: the current processed sequence number for this transaction.", "contentEncoding": "int32" }, "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
" } ] }, "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 in which each entry origin belongs to." }, "txnsession": { "type": "string", "description": "If the Transaction is linked to a transaction session, this field specifies the identifier of the txnSessions resource. For more information on the transaction session see txnSessions API." }, "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
" } ] }, "tip": { "type": "integer", "description": "Indicates the tip amount associated with a transaction. This value is for reporting purposes only, because transaction amount includes this amount in the total.", "contentEncoding": "int64" }, "softPosId": { "type": "string", "description": "The software POS ID." }, "softPosDeviceTypeIndicator": { "type": "string", "description": "The device type indicator for the terminal. \n\n
\nValid Values\n\n - `1` - **Apple (Worldpay as PSP)**\n - `2` - **Android (Worldpay as PSP)**\n - `3` - **Apple (Worldpay not PSP)**\n - `4` - **Android (Worldpay not PSP)**\n \n
" }, "networkTokenIndicator": { "allOf": [ { "$ref": "#/$defs/networkTokenIndicator" }, { "description": "Indicates if a transaction qualified for a network token through Network Payment Manager. \n
\nValid Values\n\n - `0` - **No**\n - `1` - **Yes**\n
" } ] }, "txnRefs": { "allOf": [ { "$ref": "#/$defs/txnsModelTxnRefs" }, { "description": "A list of references related to this Transaction." } ] }, "pinlessDebitConversion": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/txnPinlessDebitConversion" } ] }, { "description": "Indicates whether a transaction was attempted for Pinless Debit conversion and whether it was successful.\n
\nValid Values\n\n- `null` - **If the value is null, no conversion attempt was made.**\n- `0` - **Conversion was attempted but not successful.**\n- `1` - **Conversion was attempted and successfully completed.**\n\n
" } ] }, "submittedMethod": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/txnSubmittedMethod" } ] }, { "description": "Payment method used in the transaction request\n
\nValid Values\n\n- `null` - **Unknown Payment Method**\n- `0` - **Unknown Payment Method**\n- `1` - **American Express**\n- `2` - **Visa**\n- `3` - **MasterCard**\n- `4` - **Diners Club**\n- `5` - **Discover**\n- `7` - **Debit Card**\n- `8` - **Checking Account**\n- `9` - **Savings Account**\n- `10` - **Corporate Checking Account**\n- `11` - **Corporate Savings Account**\n- `15` - **Accel**\n- `16` - **ATH**\n- `17` - **AFFN**\n- `18` - **Culiance**\n- `19` - **Interlink**\n- `20` - **Jeanie**\n- `21` - **Maestro**\n- `22` - **NYCE**\n- `23` - **Pulse**\n- `24` - **Shazam**\n- `25` - **Star**\n- `26` - **Interac**\n
" } ] }, "processedMethod": { "allOf": [ { "oneOf": [ {}, { "$ref": "#/$defs/txnProcessedMethod" } ] }, { "description": "Payment method used to process the transaction\n
\nValid Values\n\n- `null` - **Unknown Payment Method**\n- `0` - **Unknown Payment Method**\n- `1` - **American Express**\n- `2` - **Visa**\n- `3` - **MasterCard**\n- `4` - **Diners Club**\n- `5` - **Discover**\n- `7` - **Debit Card**\n- `8` - **Checking Account**\n- `9` - **Savings Account**\n- `10` - **Corporate Checking Account**\n- `11` - **Corporate Savings Account**\n- `15` - **Accel**\n- `16` - **ATH**\n- `17` - **AFFN**\n- `18` - **Culiance**\n- `19` - **Interlink**\n- `20` - **Jeanie**\n- `21` - **Maestro**\n- `22` - **NYCE**\n- `23` - **Pulse**\n- `24` - **Shazam**\n- `25` - **Star**\n- `26` - **Interac**\n
" } ] }, "assessments": { "type": "array", "items": { "$ref": "#/$defs/assessmentsResponse" }, "description": "" }, "assessmentsEventId": { "type": "array", "items": { "$ref": "#/$defs/assessmentsResponse" }, "description": "" }, "chargebacks": { "type": "array", "items": { "$ref": "#/$defs/chargebacksResponse" }, "description": "" }, "entityReturns": { "type": "array", "items": { "$ref": "#/$defs/entityReturnsResponse" }, "description": "" }, "entries": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" }, "entriesEventId": { "type": "array", "items": { "$ref": "#/$defs/entriesResponse" }, "description": "" }, "entryOrigins": { "type": "array", "items": { "$ref": "#/$defs/entryOriginsResponse" }, "description": "" }, "fortxns": { "type": "array", "items": { "$ref": "#/$defs/txnsResponse" }, "description": "" }, "fromtxns": { "type": "array", "items": { "$ref": "#/$defs/txnsResponse" }, "description": "" }, "holds": { "type": "array", "items": { "$ref": "#/$defs/txnsResponse" }, "description": "" }, "invoiceResult": { "$ref": "#/$defs/invoiceResultResponse" }, "items": { "type": "array", "items": { "$ref": "#/$defs/itemsResponse" }, "description": "" }, "notes": { "type": "array", "items": { "$ref": "#/$defs/notesResponse" }, "description": "" }, "pendingEntries": { "type": "array", "items": { "$ref": "#/$defs/pendingEntriesResponse" }, "description": "" }, "reserveEntries": { "type": "array", "items": { "$ref": "#/$defs/reserveEntriesResponse" }, "description": "" }, "firstTxnSubscription": { "$ref": "#/$defs/subscriptionsResponse" }, "samePaymentTxns": { "type": "array", "items": { "$ref": "#/$defs/txnsResponse" }, "description": "" }, "terminalTxn": { "$ref": "#/$defs/terminalTxnsResponse" }, "txnData": { "$ref": "#/$defs/txnsDatasResponse" }, "txnMetadatas": { "type": "array", "items": { "$ref": "#/$defs/txnMetadatasResponse" }, "description": "" }, "txnReport": { "$ref": "#/$defs/txnReportsResponse" }, "interchangeHistories": { "type": "array", "items": { "$ref": "#/$defs/interchangeHistoriesResponse" }, "description": "" }, "txnResults": { "type": "array", "items": { "$ref": "#/$defs/txnResultsResponse" }, "description": "" }, "verifications": { "type": "array", "items": { "$ref": "#/$defs/verificationsResponse" }, "description": "" } } }, "txnsSetteledCurrency": { "title": "txnsSetteledCurrency", "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" }, "unauthReason": { "title": "unauthReason", "enum": [ "incomplete", "timeout", "clerkCancelled", "customerCancelled", "misdispense", "hardwareFailure", "suspectedFraud" ], "type": "string" }, "vendorFeesEnabled": { "title": "vendorFeesEnabled", "enum": [ 0, 1 ], "type": "integer" }, "vendorFeesExternal": { "title": "vendorFeesExternal", "enum": [ 0, 1 ], "type": "integer" }, "vendorsModelDivision": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/divisionsResponse" } ], "description": "ID of the division associated with this vendor." }, "vendorsModelEntity": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/entitiesResponse" } ], "description": "The identifier of the Entity associated with this Vendor resource." }, "vendorsResponse": { "title": "vendorsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "entity": { "allOf": [ { "$ref": "#/$defs/vendorsModelEntity" }, { "description": "The identifier of the Entity associated with this Vendor resource." } ] }, "division": { "allOf": [ { "$ref": "#/$defs/vendorsModelDivision" }, { "description": "ID of the division associated with this vendor." } ] }, "dealId": { "type": "string", "description": "Deprecated." }, "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
" } ] } } }, "verificationRefAction": { "title": "verificationRefAction", "enum": [ "0", "1", "3", "4", "5", "6", "8", "manualReview", "approved", "declined" ], "type": "string" }, "verificationRefsResponse": { "title": "verificationRefsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "type": "string", "description": "The Login that owns this resource." }, "entity": { "type": "string", "description": "The identifier of the Entity that was verified." }, "txn": { "type": "string", "description": "The ID of the transaction." }, "changeRequest": { "type": "string", "description": "The concept of change request is to get a second level authorization before actioning the result of a verification/policy run." }, "ref": { "type": "string", "description": "This is the reference from the integration response." }, "riskLevel": { "allOf": [ { "$ref": "#/$defs/verificationRiskLevel" }, { "description": "
\nValid Values\n\n- `Low` - **Risk level for Low.**\n- `High` - **Risk level for High.**\n- `Medium` - **Risk level for Medium.**\n\n
" } ] }, "stage": { "type": "string", "description": "This is the stage where the decisions or policy run is been triggered." }, "policyName": { "type": "string", "description": "This is the name of the policy that is ran in this stage as returned from the integratio n response." }, "action": { "allOf": [ { "$ref": "#/$defs/verificationRefAction" }, { "description": "The action to take when this check fails.\n\n
\nValid Values\n\n- `0` - **No action.**\n- `1` - **Block txn, will never be processed. The Entity is sent to the manual review queue.**\n- `3` - **Hold txn, will not be captured.**\n- `4` - **Reserve txn, funds should be reserved.**\n- `5` - **Block current activity, no change for merchant.**\n- `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**\n- `8` - **We onboard the merchant and wait for manual check later.**\n- `manualReview` - **Schedule the automatic release of the reserve.**\n- `approved` - **Hold txn, will not be captured. Automatic release when the associated sale is done.**\n- `declined` - **Hold txn, will not be captured. Automatic release when the associated sale is done.**\n \n
" } ] }, "policyUuid": { "type": "string", "description": "This is the ID of the policy as returned from the integration response." } } }, "verificationRiskLevel": { "title": "verificationRiskLevel", "enum": [ "Low", "High", "Medium" ], "type": "string" }, "verificationType": { "title": "verificationType", "enum": [ "advancedEntity", "ofac", "entity", "overall", "watchlist", "dataVerification", "advancedMerchant", "advancedMember", "association", "member", "merchantFailureLimit", "merchantPaymentFailureLimit", "saleTotalLimit", "saleTotalMinimum", "merchantCaptureWithoutAuthLimit", "refundTotalLimit", "averageSaleCountLimit", "merchantRefundSaleRatio", "merchantPaymentSuccessLimit", "ipFailureLimit", "ipFailureRatio", "inactiveMerchant", "refundWithoutSale", "refundWithoutSaleLimit", "captureAboveAuthLimit", "cvv", "avs", "aavs", "duplicateTxn", "merchantMatch", "currencyConversion", "settledCurrencyMismatch", "initialTxn", "similarTotalLimit", "similarTotalRatio", "limit", "ratio", "txnWatchlist", "balanceRefundLimit", "saleApprovedLimit", "refundApprovedLimit" ], "type": "string" }, "verificationsGenerated": { "title": "verificationsGenerated", "enum": [ 0, 1 ], "type": "integer" }, "verificationsResponse": { "title": "verificationsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "type": "string", "description": "The Login that owns this resource." }, "entity": { "type": "string", "description": "The identifier of the Entity that you want to verify." }, "member": { "type": "string", "description": "The identifier of the Member that you want to verify." }, "txn": { "type": "string", "description": "The Txn id in which this Verification belongs to." }, "terminalTxn": { "type": "string", "description": "The TerminalTxn id in which this Verification belongs to." }, "account": { "type": "string", "description": "The Account id in which this Verification belongs to." }, "decision": { "type": "string", "description": "Used to link multiple decisions together." }, "type": { "allOf": [ { "$ref": "#/$defs/verificationType" }, { "description": "The type of check to perform on the Entity, Member or Txn.\n
\n Entity Types - Valid Values\n
    \n
  • `advancedEntity` - Advanced Entity Verification
    • \n
  • `ofac` - OFAC Watchlist Verification
    • \n
  • `entity` - Entity Verification
    • \n
  • `overall` - Overall Entity Verification
    • \n
  • `watchlist` - Watchlist Verification
    • \n
  • `dataVerification` - Data Verification
    • \n
  • `advancedMerchant` - Advanced Merchant Verification
    • \n
\n
\n
\n Member Types - Valid Values\n
    \n
  • `advancedMember` - Advanced Member Verification
    • \n
  • `association` - Association Verification
    • \n
  • `member` - Member Verification
    • \n
  • `ofac` - OFAC Watchlist Verification
    • \n
  • `watchlist` - Watchlist Verification
    • \n
\n
\n
\n Transaction Types - Valid Values\n
    \n
  • `merchantFailureLimit` - Merchant Failure Limit
    • \n
  • `merchantPaymentFailureLimit` - Merchant Payment Failure Limit
    • \n
  • `saleTotalLimit` - Sale Total Limit
    • \n
  • `saleTotalMinimum` - Sale Total Minimum
    • \n
  • `merchantCaptureWithoutAuthLimit` - Merchant Capture Without Auth Limit
    • \n
  • `refundTotalLimit` - Refund Total Limit
    • \n
  • `averageSaleCountLimit` - Average Sale Count Limit
    • \n
  • `merchantRefundSaleRatio` - Merchant Refund Sale Ratio
    • \n
  • `merchantPaymentSuccessLimit` - Merchant Payment Success Limit
    • \n
  • `ipFailureLimit` - IP Failure Limit
    • \n
  • `ipFailureRatio` - IP Failure Ratio
    • \n
  • `inactiveMerchant` - Inactive Merchant
    • \n
  • `refundWithoutSale` - Refund Without Sale
    • \n
  • `refundWithoutSaleLimit` - Refund Without Sale Limit
    • \n
  • `captureAboveAuthLimit` - Capture Above Auth Limit
    • \n
  • `cvv` - CVV Verification
    • \n
  • `avs` - AVS Verification
    • \n
  • `aavs` - AAVS Verification
    • \n
  • `duplicateTxn` - Duplicate Transaction
    • \n
  • `merchantMatch` - Merchant Match
    • \n
  • `currencyConversion` - Currency Conversion
    • \n
  • `settledCurrencyMismatch` - Settled Currency Mismatch
    • \n
  • `initialTxn` - Initial Transaction
    • \n
  • `similarTotalLimit` - Similar Total Limit
    • \n
  • `similarTotalRatio` - Similar Total Ratio
    • \n
  • `limit` - Limit
    • \n
  • `ratio` - Ratio
    • \n
  • `txnWatchlist` - Transaction Watchlist
    • \n
  • `balanceRefundLimit` - Balance Refund Limit
    • \n
  • `saleApprovedLimit` - Sale Approved Limit
    • \n
  • `refundApprovedLimit` - Refund Approved Limit
    • \n
\n
" } ] }, "fromCache": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}", "type": "string", "description": "Whether this verification was created from cache. The format should be YYYY-MM-DD HH:MM:SS." }, "options": { "type": "integer", "description": "The Options for this Verification.", "contentEncoding": "int32" }, "additionalOptions": { "type": "integer", "description": "The Additional Options for this Verification.", "contentEncoding": "int32" }, "level": { "type": "string", "description": "Level conditions." }, "value": { "type": "string", "description": "The value for this Verification. This is used to associate a Verification to a Watchlist for Watchlist Verifications." }, "score": { "type": "integer", "description": "The score for this Verification. \nThis field is specified as an integer between 0 and 100.", "contentEncoding": "int32" }, "description": { "type": "string", "description": "Description of the verification." }, "ref": { "type": "string", "description": "The reference number for this verification." }, "generated": { "allOf": [ { "$ref": "#/$defs/verificationsGenerated" }, { "description": "
\nValid Values \n\n - `0` - **OFF**\n\n - `1` - **ON**\n\n
" } ] } } }, "watchlistIntegration": { "title": "watchlistIntegration", "enum": [ "APPLE", "ELAVON", "FEDACH", "FIRSTDATA", "NEUTRINO", "OFAC", "PAYRIX", "PLAID", "SIFT", "SOCURE", "SOUNDPAYMENTS", "TDBANK", "TDBANKCA", "VANTIV", "VCORE", "WEBSHIELD", "WELLSACH", "WELLSFARGO", "WFSINGLE", "WORLDPAY" ], "type": "string" }, "watchlistsDefault": { "title": "watchlistsDefault", "enum": [ 0, 1 ], "type": "integer" }, "watchlistsResponse": { "title": "watchlistsResponse", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of this resource." }, "created": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "modified": { "pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$", "type": "string", "description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS" }, "creator": { "allOf": [ { "$ref": "#/$defs/creator" }, { "description": "The identifier of the Login that created this resource." } ] }, "modifier": { "type": "string", "description": "The identifier of the Login that last modified this resource." }, "login": { "type": "string", "description": "The identifier of the Login associated with this Watchlist." }, "integration": { "allOf": [ { "$ref": "#/$defs/watchlistIntegration" }, { "description": "The integration related to this Watchlist.\n\n
\nValid Values\n\n- `APPLE` - **APPLE integration.**\n- `ELAVON` - **ELAVON integration.**\n- `FEDACH` - **FEDACH integration.**\n- `FIRSTDATA` - **FIRSTDATA integration.**\n- `NEUTRINO` - **NEUTRINO integration.**\n- `OFAC` - **OFAC integration.**\n- `PAYRIX` - **PAYRIX integration.**\n- `PLAID` - **PLAID integration.**\n- `SIFT` - **SIFT integration.**\n- `SOCURE` - **SOCURE integration.**\n- `SOUNDPAYMENTS` - **SOUNDPAYMENTS integration.**\n- `TDBANK` - **TDBANK integration.**\n- `TDBANKCA` - **TDBANKCA integration.**\n- `VANTIV` - **VANTIV integration.**\n- `VCORE` - **VCORE integration.**\n- `WEBSHIELD` - **WEBSHIELD integration.**\n- `WELLSACH` - **WELLSACH integration.**\n- `WELLSFARGO` - **WELLSFARGO integration.**\n- `WFSINGLE` - **WFSINGLE integration.**\n- `WORLDPAY` - **WORLDPAY integration.**\n\n
" } ] }, "name": { "type": "string", "description": "The name of this Watchlist. \nThis field is stored as a text string and must be between 0 and 500 characters long." }, "description": { "type": "string", "description": "A description of this Watchlist. \nThis field is stored as a text string and must be between 0 and 500 characters long." }, "default": { "allOf": [ { "$ref": "#/$defs/watchlistsDefault" }, { "description": "Whether this Watchlist applies to everyone.\n\n
\nValid Values\n\n- `0` - **Non-Default**\n- `1` - **Default**\n\n
" } ] }, "custom": { "type": "string", "description": "A custom identifier for this Watchlist. \nThis field is stored as a text string and must be between 0 and 500 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
" } ] } } } } }