Payrix Host Themes API
A host themes retrieves the active theme color associated with a specific host.
Payrix Host Themes API is one of 133 APIs that Payrix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Host Themes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 2 operations across 2 paths, and defines 852 schemas. It is described by OpenAPI 3.2.0, at version 1.7.0.
Requests are made against 3 base URLs: https://test-api.payrix.com, https://test-api.payrixcanada.com, {serverUrl}.
2 operations
2 paths
852 schemas
2 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 5
Payrix Host Themes API declares
5 security schemes
for authenticating requests.
An API key is passed in the header as APIKEY (apiKey).
An API key is passed in the header as SESSIONKEY (sessionKey).
An API key is passed in the header as TXNSESSIONKEY (txnSessionKey).
An API key is passed in the header as USERNAME (username).
An API key is passed in the header as PASSWORD (password).
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Host Themes 2
A host themes retrieves the active theme color associated with a specific host.
GET
/hostThemes/{id}
getHostThemesId
GET
/hostThemes
getHostThemes
Schemas 852
The contract defines 852 schemas that model the data the API accepts and returns. The most detailed are txnsResponse (127 properties), entitiesResponse (104 properties), terminalTxnsResponse (96 properties), parametersResponse (94 properties). Each schema is shown below with its type and property counts.
fundingParametersModelDivision
The identifier of the Division associated with this fundingParameter.
invoiceItemsResponse
object
16 properties
invoiceResultStatus
string
watchlistsDefault
integer
entityReservesModelLogin
The Login that owns this resource.
hostThemesResponseResult
object
1 property
entityRefStage
string
terminalTxnsResultCode
integer
itemsResponse
object
18 properties
decisionActionsScoreType
string
merchantsSaqType
string
disbursementsModelAccount
The token of the accounts resource used for this Disbursement.
batchesResponse
object
18 properties
subscriptionOrigin
integer
txnResultsModelTxn
The identifier of the Transaction associated with this txnResults resource.
invoiceLineItemsResponse
object
11 properties
terminalTxnsBinType
string
reserveEntriesModelFund
The identifier of the Fund that this reserveEntries resource relates to.
entryOriginsModelDisbursement
The identifier of the Disbursement that this entry origin relates to.
refundsModelEntry
The identifier of the Entries resource that is being refunded.
credentialsModelSecret
The secret resource identifier to use when connecting using this Credential. This field is only necessary when a private key is required by the integration.
merchantStatusReason
string
terminalTxnResultsModelTerminalTxn
The identifier of the TerminalTxn associated with this terminalTxnResults resource.
entityRoutesFundingCurrency
string
terminalTxnsDatasModelTerminalTxn
The identifier of the TerminalTxn associated with this TerminalTxnDatas resource.
invoiceResultResponse
object
24 properties
CurrencyConversion
string
entriesModelDisbursement
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.
entriesModelRevShareStatement
If the activity that this Entry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource.
configurationStageInput
string
statementEntriesDeductedFromBalance
integer
noteDocumentsDocumentType
string
alertsModelTeam
The identifier (ID) of the team that this Alert relates to. The Alert is triggered based on the activity of this Team.
partitionsResponse
object
15 properties
vendorsModelDivision
ID of the division associated with this vendor.
terminalTxnsModelToken
The ID of the token record to associate with this terminal transaction request.
notesResponse
object
18 properties
payoutsModelPayoutFlow
The identifier of the PayoutFlow associated with this Payout.
invoicesModelSubscription
The identifier of the Subscription of this invoice resource.
verificationRefsResponse
object
15 properties
payoutFlowSchedule
string
messagesRead
integer
reservesModelEntity
The identifier of the Entity that this Reserve applies to.
holdsModelAnalyst
The person who review the hold applied.
terminalTxnsMetadatasResponse
object
9 properties
alertActionsModelAlert
The identifier of the Alert resource that defines this alertAction.
disbursementResultsResponse
object
13 properties
txnsDebtRepayment
integer
chargebackMessageResultModelChargebackMessage
The identifier of the chargebackMessage resource that this chargebackMessageResult relates to.
merchantRiskLevel
string
chargebacksResponse
object
35 properties
entityReturnCode
string
entityRefsResponse
object
19 properties
profitShareResultsResponse
object
9 properties
hostThemesResponseItem
object
3 properties
assessmentsResponse
object
22 properties
settlementStatus
string
disbursementEntriesModelEntry
The identifier of the Entry that this DisbursementEntry resource refers to.
merchantAutoBoarded
integer
disbursementRefStage
string
parametersVerifyDisabled
integer
merchantPlatformStatusesResponse
object
8 properties
partitionNoEmailConfirmation
integer
terminalTxnResultsBankCode
string
entriesModelAdjustment
The adjustment ID from which the funding activity was triggered.
chargebacksModelTxn
The ID of the Transaction associated with the Chargeback.
customersModelMerchant
The ID of the Merchant associated with this Customer.
orgFlowAction
string
configurationStageName
string
feesResponse
object
34 properties
chargebackDocumentsDocumentSource
string
decisionsPeriod
string
revenueBoostsModelDivision
The identifier of the Division that networkPaymentManager is associated with.
reservesModelPartition
The identifier of the Partition that this Reserve's resource applies to.
disbursementEntriesModelEventId
The identifier of the record that is associated with this DisbursementEntry resource.
MerchantsNew
integer
parametersVerifyForPayoutNotRequired
integer
entityCustomFieldsModelEntity
Entity for which we are creating custom field.
disbursementEntriesModelReserveEntry
The identifier of the ReserveEntry that this DisbursementEntry resource refers to.
reserveEntryEvent
integer
feeModifiersModelEntity
The identifier of the Entity that this Fee Modifier applies for.
pendingEntriesModelFromentity
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…
decisionsResponse
object
39 properties
payoutFlowsModelPartition
The identifier of the Partition in which entities will have automated payouts generated.
alertTriggerResource
integer
payoutsModelAccount
The token of the Account that this Payout is associated with. This account will either receive the funds or be debited for the funds every time a Disbursement…
feeRuleType
string
saferPaymentsModelPartition
The identifier of the Partition that saferPayments is associated to.
decisionType
string
assessmentEvent
integer
pendingEntriesModelStatement
If the activity that this PendingEntry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource.
holdsHoldSource
string
txnsModelFortxn
If this Transaction is related to another Transaction, then this field is set to the identifier of the other Transaction. For example, if this Transaction is a…
entriesModelSettlement
If the activity that this Entry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource.
interchangeHistoriesResponse
object
18 properties
payoutsResponse
object
27 properties
terminalTxnsModelTxn
The related txn this terminalTxn belongs to.
invoiceResultModelInvoice
The identifier of the Invoice that owns this invoiceResult resource.
txnOrigin
integer
paymentUpdatesModelToken
The ID of the token record to associate with this terminal activation request.
terminalsResponse
object
26 properties
verificationsGenerated
integer
disbursementsDisbursementEntriesStatus
string
fundingParametersModelPartition
The identifier of the Partition associated with this fundingParameter.
txnsModelToken
The token of the Tokens resource this Transaction is associated with.
parametersPassTokenEnabled
integer
accountMethod
integer
fundOriginsModelTxn
The identifier of the Transaction that this fund origin relates to.
platformModel
string
txnProcessedMethod
integer
country
string
merchantsIncrementalAuthSupported
integer
accountsReserved
integer
confirmCodeType
string
entityReservesModelFund
The identifier of the Fund that this entityReserves resource relates to.
entityTermsModelEntity
The identifier of the entity that the terms are associated with.
alertActionsResponse
object
15 properties
noteType
string
orgFlowTrigger
string
aggregationResultGroupsModelAggregation
The identifier of the Aggregation that this AggregationResult refers to.
embededFinancePlatform
string
customersResponse
object
39 properties
aggregationsModelTeam
The identifier of the Team that this Aggregation applies to.
reservesLevel
string
txnsCofType
string
profitShareResultsModelProfitShare
The identifier of the ProfitShare that this ProfitShareResult refers to.
chargebackDocumentType
string
terminalTxnPaymentMethod
integer
tokensModelCustomer
The Customer that this Token is associated with.
subscriptionTokensModelSubscription
The identifier of the Subscription resource that this Subscription Token is associated with. This is the Subscription that the Token identified in the 'token'…
txnStatus
integer
hostThemesDefault
integer
payoutFlowTrigger
string
payoutFlowsModelOrg
The identifier of the Org that this payoutFlows resource applies to. If you set this field, then the payoutFlow applies to all Entities in the Org.
MembersGender
string
txnResultType
integer
parametersDiscover3dsEnabled
integer
terminalTxnsSignature
integer
payoutFlowsModelPayoutLogin
The Login that will own the Payout resource. When set to null, the Payout resource will be owned by the triggerring Entity.
billingsModelForentity
The alphanumeric identifier of the Entity associated with this Account.
entityReturnsModelLogin
The Login that owns this resource.
partitionNoHoldEmail
integer
statementEntriesModelEventId
The identifier of the record that is associated with this StatementEntry.
parametersBankAccountAddStopEmail
integer
entityTermsResponse
object
13 properties
entryOriginsModelFunding
The processor’s funding ID (related to a merchant, for some processors it is the merchant ID) from which the funds were sourced.
chargebackStatusesModelChargebackMessage
ID of the chargeback message associated with this chargeback.
holdAction
integer
fundOriginsResponse
object
13 properties
vendorFeesExternal
integer
pendingEntriesModelRefund
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.
accountsModelEntity
The identifier of the Entity associated with this Account.
assessmentsModelEventId
The identifier of the record that is associated with this assessments resource.
descisionActionsAction
integer
invoiceParameterType
string
disbursementsFundingStatus
string
chargebackMessageModelChargeback
The identifier of the Chargeback resource that this chargebackMessage relates to.
reserveEntriesModelReserveEntry
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…
pendingEntriesPending
integer
profitSharesModelOrg
The identifier of the Org in which entities will have their earnings/expenses shares.
payoutSchedule
integer
changeRequest
object
19 properties
revShareStatmentsModelEntity
The Entities object which is collecting the money.
parametersBoardingExemptionsDisabled
integer
disbursementStatus
integer
globalBusinessType
string
paymentUpdatesModelAccount
The account associated with this Payment being updated. Used for instant funding payouts.
feesTxnFee
integer
chargebackDocumentStatus
string
loginsResponse
object
61 properties
txnResultsCode
integer
payoutsModelLogin
The Login that owns this resource.
reservesModelOrg
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.
accountsResponse
object
26 properties
aggregationResultsResponse
object
12 properties
parametersDiscoverAcquiredEnabled
integer
statementEntriesModelOnentity
The identifier of the Entity that triggered the charge.
reserveEntriesModelTxn
This field indicates that this reserveEntry was triggered from a Transaction, and it stores the identifier of the Transaction.
terminalTxnsModelForterminalTxn
If this Terminal Transaction is related to another Terminal Transaction, then this field is set to the identifier of the other Terminal Transaction. For exampl…
txnsModelSubscription
The identifier of the Subscription associated with this Transaction.
holdsModelTerminalTxn
The TerminalTxn id in which this Hold belongs to.
parametersVisa3dsEnabled
integer
alertsModelLogin
The identifier of the Login that created this resource.
currencyRatesModelLogin
The identifier of the Login that owns this resource.
details
object
An object describing the response, including the request ID and pagination indicators.
3 properties
reservesResponse
object
24 properties
binsPinlessSupport
string
pendingEntriesModelAdjustment
The adjustment ID from which the funding activity was triggered.
reserveEntriesModelHold
The ID of the hold that generated this reserveEntry.
terminalTxnOrigin
integer
billingEventsDeductFromBalance
integer
orgFlowsResponse
object
13 properties
holdsResponse
object
31 properties
pinlessDebitConversionsResponse
object
14 properties
loginHelpersLoginAsEnabled
integer
tokensResponse
object
25 properties
parametersECheckEnabled
integer
secretsModelLogin
The identifier of the Login that owns this secret resource.
saferPaymentsResponse
object
17 properties
configurationIntegration
string
parametersBoardingDisabled
integer
profitShareRuleType
string
decisionActionType
string
reserveStatus
integer
aggregationsModelEntity
The identifier of the Entity associated with this Account.
disbursementEntriesModelPendingEntry
The identifier of the PendingEntry that this DisbursementEntry resource refers to.
aggregationsModelPartition
The identifier of the Partition that this Aggregation applies to.
subscriptionTokensModelToken
The identifier of the Token resource that this Subscription Token is associated with. This resource identifies the means of payment for the Subscription identi…
binsType
string
membersModelVendor
This holds the ID of the related vendor record.
configurationsModelLogin
The identifier of the Login that owns this configuration resource.
verificationsResponse
object
22 properties
entriesIsFee
integer
reservesModelHold
The identifier of the Entity Hold from which this Reserve was generated.
invoicesEmailStatus
string
embeddedFinanceProduct
string
membersPoliticallyExposed
integer
merchantsNaics
string
teamLoginRead
integer
membersPrimary
integer
billingsModelOrg
The identifier of the Org associated with this invoiceParameter.
terminalTxnStatus
integer
subscriptionTokensResponse
object
9 properties
pendingEntriesModelEntityDebt
The ID of the entityDebt representing the relationship for the debt
parametersLoginAsEnabled
integer
entryMode
integer
chargebackDocumentsModelChargeback
The identifier of the Chargeback resource that this chargebackDocument relates to.
simplifiedDepositEnabled
integer
confirmCodesModelLogin
The identifier of the Login associated with this confirmation code.
fundOriginPlatform
string
pendingEntriesResponse
object
37 properties
feeRulesModelFee
The identifier of the Fee that this Fee Rule applies.
verificationRiskLevel
string
parametersNegativeBalanceEmail
integer
chargebackDocumentsResponse
object
14 properties
messageThreadsModelForlogin
The identifier of the receiving Login of this messageThreads resource.
pendingEntriesModelOnentity
The identifier of the Entity that this PendingEntry refers to. This is the owner of the record that triggered the charge.
pendingEntriesModelEntry
The entry ID associated with this pendingEntry.
changeManagementEnabled
integer
configurationsName
string
statementsModelEntity
The paying entity for which this statement applies.
entityDebtsResponse
object
8 properties
txnRefsResponse
object
9 properties
saferPaymentNonComplianceFeeManagedModel
integer
saferPaymentPciNonValidationFeeEnabled
integer
fundOriginsModelAdjustment
The identifier of the Adjustment that this fund origin relates to.
fundingParametersModelLogin
The identifier of the Login that owns this fundingParameter resource.
revenueBoostsResponse
object
17 properties
chargebackMessageType
string
decisionsUseCache
integer
teamLoginDelete
integer
pendingEntriesIsFee
integer
appleDomainsModelOwnerEntity
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 do…
disbursementRefPlatform
string
terminalType
string
orgFlowActionsResponse
object
8 properties
chargebacksActionable
integer
orgFlowRulesModelOrgFlow
The identifier of the orgFlow resource that this orgFlowActions resource is associated with.
noteDocumentType
string
revenueBoostsModelEntity
The identifier of the Entity that networkPaymentManager is associated with.
paymentResponse
object
10 properties
mccsModelEntity
The identifier of the Entity associated with this Mcc resource.
txnRefStage
string
terminalRefPlatform
string
disbursementsModelEntity
The identifier of the Entity that owns this Disbursement.
terminalTxnRefStage
string
profitShareType
string
aggregationsModelLogin
The identifier of the Login that created this resource.
mccType
string
parametersDecisionMicroserviceEnabled
integer
secretType
string
embeddedFinanceModelEntity
The identifier of the Entity that this embeddedFinance is associated to.
configurationType
string
payoutFlowsResponse
object
26 properties
saferPaymentsModelDivision
The identifier of the Division that saferPayments is associated to.
disbursementResultsModelDisbursementRef
The ID of the disbursementRef for which this result is recorded.
noteDocumentStatus
string
saferPaymentStatus
string
payoutsModelEntity
The identifier of the Entity that this Payout is associated with.
feesModelEntity
The identifier of the Entity that will charge this Fee.
txnReportsResponse
object
11 properties
entityRoutesModelPartition
ID of the partition in which this entity operates.
terminalTxnsPin
integer
terminalsCloudEnabled
integer
paymentUpdateGroupsResponse
object
12 properties
entityReturnsResponse
object
15 properties
profitShareResultsModelEntry
The identifier of the Entry that this ProfitShareResult refers to.
membersModelMerchant
The identifier of the Merchant associated with this Member.
messagesModelOpposingMessage
Specifies whether this is the opposingMessage or not.
paymentMethod
integer
plansModelMerchant
The identifier of the Merchant associated with this Plan.
adjustmentsModelEntity
The identifier of the Entity associated with this Account.
decisionRulesResponse
object
13 properties
orgFlowActionsModelOrg
The identifier of the Org resource that this orgFlowActions resource is associated with.
txnsPinEntryCapability
string
adjustmentsModelFunding
The ID of the fund which the disbursement’s movement applies.
vendorFeesEnabled
integer
revShareSchedulesModelEntity
The Entities object which is collecting the money.
teamLoginUpdate
integer
pendingEntriesModelDisbursement
If the activity that this PendingEntry refers to is the charging of a Disbursement, then this field stores the identifier of the corresponding Disbursement res…
messageThreadsResponse
object
16 properties
reservesModelDivision
The identifier of the Division that this Reserve's resource applies to.
appleDomainsResponse
object
10 properties
merchantsSeasonal
integer
feeModifiersMarkupUm
integer
terminalTxnsUnattended
integer
entriesModelOpposingEntry
The identifier of the Entry that this Entry was created based on.
invoiceStatus
string
statementsModelForentity
The payee entity of the statement.
txnsModelMerchant
The identifier of the Merchant associated with this Transaction.
merchantsApplePayActive
integer
cycle
string
messageThreadsModelLogin
The identifier of the Login that owns this messageThreads resource.
orgFlowRulesType
string
accountType
string
alertTriggerEvent
string
currencyRatesModelPartition
If this currency rate relates to a partition, then this field stores the identifier of the Partition.
loginHelpersResponse
object
12 properties
fundingParameterType
string
paymentExpirationUpdated
integer
profitSharesModelDivision
The identifier of the Division in which entities will have their earnings/expenses shares.
orgEntitiesModelEntity
The identifier of the Entity that this orgEntity is associated with.
aggregationsModelDivision
The identifier of the Division that this Aggregation applies to.
statementEntriesResponse
object
20 properties
messageType
string
terminalTxnsMetadatasField
string
subscriptionsModelStatementEntity
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…
notesModelLogin
The identifier of the Login that owns this notes resource.
entityDefault
integer
invoiceParametersResponse
object
15 properties
terminalTxnsEmv
integer
notesModelTerminalTxn
The identifier of the TerminalTxn that relates to this notes resource.
aggregationsResponse
object
28 properties
invoicesModelLogin
The identifier of the Login of this invoice resource.
feeModifiersModelDivision
Division ID in which the fee modifiers is associated.
fundingParametersModelEntity
The identifier of the Entity associated with this fundingParameter.
currencyRatesModelEntity
If this currency rate relates to an entity, then this field stores the identifier of the Entity.
invoicesModelMerchant
The identifier of the Merchant of this invoice resource.
billingsCollectionIncludeCurrent
integer
profitShareRulesModelProfitShare
The identifier of the ProfitShare that this ProfitShare Rule applies to.
entityCustomFieldsResponse
object
9 properties
billingCollection
string
revShareSchedulesResponse
object
13 properties
terminalTxnsSwiped
integer
teamLoginCreate
integer
error-four-hundred1
object
1 property
billingsCollectionFactor
string
mccsModelDivision
The Division on which this MCC applies.
entityReturnsModelPayment
The identifier of the Payment that this EntityReturns refers to.
statementsModelBilling
The identifier of the Billing of this statement resource.
holdsModelAccount
The identifier of the Account that owns this holds resource.
fundOriginsModelFund
The fund for which the amount is available from this source.
entitiesReserved
integer
terminalRefsProcessor
string
revenueBoostsPlatform
string
terminalRefStage
string
noteDocumentsResponse
object
14 properties
adjustmentsModelDisbursement
The identifier of the Disbursement associated with this Adjustment.
decisionActionsApplication
string
plansModelBilling
The attached billing for which recurring payments should be made to pay off statements.
merchantStatus
integer
aggregationDefault
integer
txnsSetteledCurrency
string
paymentNumberUpdatedModel
integer
txnsPlatform
string
pendingEntriesOriginalEvent
integer
feeType
integer
txnMetadatasResponse
object
9 properties
binsModelEventSchedule
The identifier of the EventSchedule that this Bin is associated with.
fundsResponse
object
17 properties
configurationsModelPartition
The identifier of the Partition associated with this configuration resource.
batchStatus
string
accountCheckStage
string
messagesSecure
integer
parametersAccountUpdaterEnabled
integer
entityRefsModelEntityRoute
The original 'entityroute' that routed the merchant onto the platform which then returned this reference information, if applicable
tokenStatus
string
terminalsAutoClose
integer
payoutFlowsSkipOffDays
integer
txnResultsResponse
object
11 properties
decisionsModelDivision
The identifier of the Division that this decision resource belongs to.
feeSchedule
integer
secretsModelEntity
The identifier of the Entity associated with this secret.
accountsUpdateMethod
string
payoutsModelBilling
The identifier of a Billing that this Payout is associated with. Payout associated with a Billing record will be used to pay for Statements.
billingModifiersModelEntity
The identifier of the Entity that this Billing Modifier applies to.
payoutFlowUm
string
feeModifiersModelPartition
ID of the partition related to this fee modifiers.
alertActionType
string
pendingEntriesModelTerminalTxn
The terminal transaction ID from which the funding activity was triggered.
invoicesModelCustomer
The identifier of the Customer of this invoice resource.
configurationStagesModelConfiguration
The identifier of the Configuration that owns this configurationStage resource.
reserveEntriesModelEventId
The identifier of the record that is associated with this PendingEntry.
billingModifiersModelBilling
The identifier of the Billing that this Billing Modifier applies to.
binsCategory
string
entriesModelFee
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.
currencyRatesToCurrency
string
entryOriginsModelEntry
The entry on which the funding source was recorded.
statementEntriesModelBilling
The identifier of the Billing that this StatementEntry refers to.
terminalTxnRefsResponse
object
9 properties
invoiceParametersModelDivision
The identifier of the Division associated with this invoiceParameter.
terminalsModelMerchant
The identifier of the Merchant that owns this terminals resource.
parametersPositiveBalanceEmail
integer
parametersHoldMessagesDisabled
integer
assessmentsModelChargeback
The identifier of the Chargeback that this assessment resource refers to.
secretsModelPartition
The identifier of the Partition associated with this secret.
membersModelFacilitator
This holds the ID of the related facilitator record.
omniTokensModelDeleter
The identifier of the User who deleted the omniToken.
holdsModelDecisionAction
The identifier of the DecisionAction associated with this Hold resource.
merchantsGooglePayActive
integer
txnsModelStatement
The statement ID for which this transaction is being processed as payment.
disbursementRefsModelDisbursementRef
The identifier of the DisbursementRef that this disbursementRef resource refers to.
subscriptionsResponse
object
23 properties
billingsModelDivision
The identifier of the Division associated with this vendor.
chargebackStatusesResponse
object
8 properties
configurationStageCredentials
string
feeModifiersResponse
object
15 properties
chargebackStatusesModelChargeback
ID of the related chargeback.
pendingEntriesModelFund
The identifier of the Fund that this PendingEntry refers to.
payoutFlowsModelEntity
The identifier of the Entity that this payoutFlow applies to.
loginsPortalAccess
integer
invoiceParametersModelPartition
The identifier of the Partition associated with this invoiceParameter.
planUm
string
txnsFundingEnabled
integer
txnsImported
integer
paymentUpdateGroupsModelEntity
The identifier of the Entity that this resource belongs to.
assessmentsModelEntity
The identifier of the Entity associated with this assessment.
changeRequestModelAnalyst
The person who review the request.
pendingEntriesModelEntity
The identifier of the Entity that owns this PendingEntry.
terminalStatus
integer
accountPrimary
integer
MembersTimezone
string
txnsAllowPartial
integer
binsModelBilling
The identifier of the Billing that this Bin is associated with.
watchlistIntegration
string
facilitatorsResponse
object
16 properties
entityReturnsModelDisbursement
This field indicates that this EntityReturn was triggered from a\ \ Disbursement. \nThis field stores the identifier of the Disbursement.
parametersSurchargeEnabled
integer
txnSubmittedMethod
integer
parametersAmexEnabled
integer
txnsDatasModelTxn
The identifier of the Transaction associated with this TxnDatas resource.
invoiceParameterLocked
integer
merchantsAdvanceBilling
integer
orgsModelLogin
The Login that owns this Org.
currency
string
alertsResponse
object
16 properties
loginsModelLogin
The identifier of the Login.
holdsReleaseAction
integer
statementEntriesModelEntity
The paying entity for which this statementEntry applies.
parametersDebtRepaymentEnabled
integer
decisionActionsResponse
object
18 properties
verificationType
string
chargebacksModelMerchant
The ID of the merchant associated with the Chargeback.
feeRulesResponse
object
14 properties
saferPaymentsModelEntity
The identifier of the Entity that saferPayments is associated to.
disbursementResultsPlatform
string
changeRequestStatus
string
entitiesResponse
object
104 properties
aggregationResultsModelAggregationResultGroup
The identifier of the AggregationResultGroup that this AggregationResult refers to.
entityDataResponse
object
7 properties
orgFlowsModelLogin
The Login that owns this resource.
refundReleaseReserve
integer
interchangeHistoriesIsCurrent
integer
txnPinlessDebitConversion
integer
alertActionsMaxAttemptsTempDisabled
integer
assessmentsModelDisbursement
The identifier of the Disbursement that this assessment resource refers to.
entitiesPublic
integer
payoutUm
integer
detailsProperties
object
Where the response lists multiple resources, the API splits the response into several 'pages'. This object indicates the current and last available pages in th…
3 properties
entityRoutesModelEntity
The identifier of the Entity that this entityRoute applies to.
fundOriginsModelDisbursement
ID of the disbursement related to this fund.
orgFlowsModelForlogin
The identifier of the Login resource for which this orgFlows resource is triggered.
revenueBoostsModelOrg
The identifier of the Org (group) that networkPaymentManager is associated with.
planType
string
contactsResponse
object
21 properties
disbursementEntryEvent
integer
pendingEntriesModelChargeback
If the activity that this PendingEntry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource.
errorItem
object
5 properties
changeRequestModelLogin
The identifier of the Login associated with this ChangeRequest.
bankAccountUpdateStopEmail
integer
loginsMfaEnabled
integer
terminalTxnReserved
integer
messageThreadsModelEntityReturn
The identifier of the EntityReturn that is related to this messageThread.
entryEvent
integer
teamsResponse
object
16 properties
holdsModelTxn
The identifier of the Txn that is being held with this hold.
txnsMobile
integer
holdsModelVerification
If this hold resource was triggered through a verification, then this field stores the identifier of the Verification.
membersSignificantResponsibility
integer
paymentUpdatesResponse
object
15 properties
fundingParametersModelOrg
The identifier of the Org associated with this fundingParameter.
teamLoginModelTeam
The identifier of the Team resource that the Login identified in the 'login' field should be marked as part of.
entriesModelEventId
The identifier of the record that is associated with this Entry.
saferPaymentsModelOrg
The identifier of the Org (group) that saferPayments is associated to.
networkTokenIndicator
integer
feeModifiersModelFromentity
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. This field is optional. If…
credentialsModelEntity
The identifier of the Entity that this Credential resource belongs to.
frozen
integer
status
string
currencyRatesModelOrg
If this currency rate relates to an org, then this field stores the identifier of the Org.
paymentModelBin
Bin identifier for this payment.
reserveEntriesModelEntry
The entry ID associated with this pendingEntry.
accountStatus
integer
feeModifiersModelFee
The identifier of the Fee that this Fee Modifier applies.
vendorsResponse
object
12 properties
inactive
integer
pendingEntriesModelProfitShare
If the activity that this PendingEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
payoutFlowsModelDivision
The identifier of the Division in which entities will have automated payouts generated.
embeddedFinanceResponse
object
14 properties
statementEntriesModelRevShareStatement
If the activity that this StatementEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource
revShareStatmentsModelForentity
The Entities object which is paying the money.
entityRefStaging
integer
parametersPayoutDelayIncludeOffDays
integer
disbursementsModelPayout
The identifier of the Payout that represents the schedule for this Disbursement.
profitSharesModelPartition
The identifier of the Partition in which entities will have their earnings/expenses shares.
merchantsResponse
object
75 properties
entryOriginPlatform
string
disbursementsSameDay
integer
terminalTxnsModelMerchant
The identifier of the Merchant associated with this Transaction.
terminalTxnsPos
integer
batchesModelMerchant
The identifier of the Merchant that is associated with this Batch.
creator
The identifier of the Login that created this resource.
billingEventsResponse
object
11 properties
chargebackStatusesStatus
string
billingModifiersModelOrg
The identifier of the Org that this Billing Modifier applies to.
saferPaymentProgram
string
secretsResponse
object
18 properties
adjustmentsModelLogin
The identifier of the Login that created this resource.
noteDocumentsModelNote
The identifier of the Note that owns this note documents resource.
reserveEntriesModelEntityReserve
This field indicates that this reserveEntry was triggered from a manual change to an entityReserve, and it stores the identifier of the entityReserve resource.
aggregationType
string
error-four-hundred-Properties
object
5 properties
txnsModelTxnRefs
A list of references related to this Transaction.
entityRefsModelEntity
The identifier of the Entity that owns this entityRefs resource.
entriesResponse
object
43 properties
orgFlowsModelPartition
The identifier of the Partition resource for which this orgFlows resource is triggered.
terminalTxnsHsaFsaCardIndicator
integer
reservesRelease
string
invoicesResponse
object
27 properties
txnsModelBatch
If the Transaction is linked to a Batch, this field specifies the identifier of the Batch.
chargebackMessageStatus
string
entriesModelFund
The identifier of the Fund that this Entry refers to.
messagesModelMessageThread
The identifier of the messageThreads that owns this Messages resource.
divisionsCanUsePlaidWrapperMicroservice
integer
omniTokensResponse
object
15 properties
orgEntitiesModelOrg
The identifier of the Org that this orgEntity is associated with.
loginHelpersModelLogin
The Login that owns this resource.
subscriptionsModelFirstTxn
The identification of the first transaction processed through this subscription. This is used internally to process subsequent transactions.
parametersApplePayEnabled
integer
aggregationStatus
string
merchantsLetterStatus
integer
alertTriggersModelAlert
The identifier of the Alert resource that you want to invoke with this trigger.
merchantLocationType
integer
profitSharesModelLogin
The identifier of the Login that owns this ProfitShare.
aggregationsModelForlogin
The identifier of the Login that this Aggregation applies to.
disbursementsModelLastNegativeEntry
The last negative Entry processed included in the disbursement.
statementStatus
string
binLocationType
string
confirmCodesResponse
object
11 properties
billingEventsModelBilling
The identifier of the Billing that this billingEvent applies to.
parametersPortalAccessEnabled
integer
payoutFlowsModelLogin
The Login that owns this resource.
paymentUpdateStatus
string
configurationsModelOrg
The identifier of the Org associated with this configuration resource.
contactsModelEntity
The identifier of the Entity that this Contact relates to.
invoiceItemsModelLogin
The identifier of the Login that owns this InvoiceItem.
feesModelForentity
The identifier of the Entity that this Fee applies for.
aggregationSchedule
string
merchantsVisaDisclosureIP
integer
entriesModelProfitShare
If the activity that this Entry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
billingModifiersModelPartition
The identifier of the Partition that this Billing Modifier applies to.
billingsModelEntity
The alphanumeric identifier of the Entity associated with this Account.
parametersGooglePayEnabled
integer
txnMetadatasModelTxn
The identifier of the Transaction associated with this TxnMetadatas resource.
refundsResponse
object
10 properties
fundingParametersResponse
object
17 properties
assessmentsModelOnentity
The identifier of the Entity that this assessment refers to. This is the owner of the record that triggered the charge.
parametersPayoutIncludePending
integer
entitiesModelLogin
The ID of the Login that owns this resource.
minPasswordComplexity
integer
billingEvent
string
disbursementRefsResponse
object
17 properties
entityReturnsModelEntity
The identifier of the Entity that this EntityReturns refers to.
txnsMisused
integer
billingSchedule
string
itemsModelTxn
The txn in which these items have been sold, A single txn may have many items.
teamLoginReference
integer
profitSharesModelForentity
The identifier of the Entity that will have it's earnings/expenses shared.
reserveEntriesResponse
object
25 properties
appleDomainStatus
string
feeApplication
string
entryOriginsModelCancellation
The identifier of the Cancellation that this entry origin relates to.
customersModelEntity
The ID of the Entity that owns this resource.
parametersVerifyForBoardingNotRequired
integer
terminalTxnsReceipt
string
entityRoutesModelDivision
Division ID in which the entity route is associated.
chargebackMessageImported
integer
changeRequestOperation
string
alertsModelForlogin
The identifier of the Login that this Alert applies to.
parametersMcInstantPayoutsEnabled
integer
hostsResponse
object
11 properties
entityDataModelEntity
The Entity associated with this EntityData.
entityPlatform
string
terminalTxnType
integer
assessmentsModelForentity
The identifier of the Entity that this assessment applies to. An opposing assessment is associated with this entity.
configurationsModelEntity
The identifier of the Entity associated with this configuration resource.
entityDebtsModelToentity
The identifier of the Entity that will receive the money.
verificationRefAction
string
currencyRatesModelDivision
If this currency rate relates to a division, then this field stores the identifier of the Division.
membersResponse
object
50 properties
omniTokensModelEntity
The identifier of the Entity that this omniTokens is associated to.
parametersMfaEnabled
integer
entityCountry
string
entityRefsModelMember
The identifier of the Member associated with this entityRefs resource.
entriesModelChargeback
If the activity that this Entry refers to is a Chargeback, then this field stores the identifier of the corresponding Chargeback resource.
pendingEntryEvent
integer
disbursementsResponse
object
36 properties
statementEntriesModelForentity
The identifier of the Entity that will be paid for this charge.
subscriptionsModelPlan
The identifier of the Plan that this Subscription is associated with. The Plan determines the frequency and amount of each payment.
terminalRefsResponse
object
10 properties
terminalsCapability
integer
merchantResultsResponse
object
10 properties
pendingEntriesModelTxn
If the activity that this PendingEntry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource.
entriesModelFromentity
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…
entityReturnsActionCode
string
feesModelOrg
The identifier of the Org who should pay this Fee on behalf of the Entity identified in the value of the 'forentity' field. This field is optional. If it is se…
billingsResponse
object
30 properties
entriesModelEntity
The identifier of the Entity that owns this Entry.
txnCheckStage
string
changeRequestModelEntity
The identifier of the Entity associated with this Account.
parametersTxnDecisionMicroserviceEnabled
integer
disbursementsModelLastPositivePendingEntry
The last positive PendingEntry processed included in the disbursement.
decisionsModelPartition
The identifier of the Partition that this decision resource belongs to.
parametersResponse
object
94 properties
messagesGenerated
integer
pendingEntriesModelFee
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.
txnsDatasResponse
object
7 properties
hostsModelDivision
The identifier of the Division resource that this Host belongs to.
entityRoutesResponse
object
18 properties
adjustmentsResponse
object
19 properties
entityType
integer
entriesModelPendingEntry
The ID of the pending entry that is associated with this entry.
payoutInactive
integer
parametersOptBlueEnabled
integer
decisionsModelOrg
If this decision resource relates to an Org, then this field stores the identifier of the Org.
entityRoutesModelOrg
The identifier of the Org that this entityRoute applies to.
accountsModelAccount
The identifier of the Payment associated with this Account.
orgEntitiesResponse
object
7 properties
accountPayment
object
15 properties
secretLocked
integer
chargebackPlatform
string
mccsModelPartition
The Partition on which this MCC applies.
saferPaymentsModelDeleter
The id of user who deleted the omniToken.
teamsAutoCascadeDisabled
integer
revShareSchedulesModelForentity
The Entities object which is paying the money.
adjustmentsModelFromentity
The applicable Entity for this Adjustment. This field is an optional field.
holdsModelVerificationRef
If this hold resource was triggered through Payrix Integration Risk, then this field stores the identifier of the VerificationRef.
revenueBoostsModelDeleter
The id of user who deleted the revenueBoost entity.
notesModelEntity
The identifier of the Entity that relates to this notes resource.
mccsModelLogin
The identifier of the Login that owns this Mccs resource.
descisionAction
integer
fundingParameterPaymentMethods
string
merchantEnvironment
string
chargebackStatus
string
parametersVisaInstantPayoutsEnabled
integer
parametersGetParametersEnabled
integer
disbursementsModelSettlement
The settlement record for this disbursement.
configurationsModelDivision
The identifier of the Division associated with this configuration resource.
appleDomainsModelRegisteredMerchant
The identifier of the Merchant registered with Apple Pay for this domain.
planSchedule
integer
terminalTxnsResponse
object
96 properties
adjustmentsModelOnentity
The identifier of the Entity associated with this Adjustment.
parametersDeclineNotificationEmail
integer
invoiceLineItemsModelInvoice
The identifier of the Invoice that owns this InvoiceLineItem.
entityPendingRiskCheck
string
feeUm
integer
statementEntriesModelFee
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.
billingModifiersModelFromentity
The identifier of the Entity that is responsible for paying this Bill on behalf of the Entity specified in the 'entity' field.
resource
integer
chargebackMessageResultResponse
object
8 properties
terminalTxnsTerminalCapability
integer
terminalTxnsMetadatasModelTerminalTxn
The identifier of the Terminal Transaction associated with this TerminalTxnMetadatas resource.
watchlistsResponse
object
13 properties
configurationStageMethod
string
teamLoginResponse
object
13 properties
invoiceResultModelTxn
The identifier of the Transaction associated with this invoiceResult resource.
entityReservesResponse
object
13 properties
settlementsResponse
object
13 properties
terminalEnvironment
integer
assessmentsModelPartition
The identifier of the Partition that this assessment resource refers to.
txnsModelFromtxn
Reauthorize this referenced Transaction. For example, to process a resubmission of a declined Transaction or to reauthorize an expired Transaction.
orgFlowsModelDivision
The identifier of the Division resource for which this orgFlows resource is triggered.
entityDebtsModelEntity
The identifier of the Entity that owes money.
revenueBoostsModelPartition
The identifier of the Partition that networkPaymentManager is associated with.
aggregationResultGroupsResponse
object
16 properties
billingsModelLogin
The Login that owns this resource.
credentialIntegration
string
binsResponse
object
28 properties
teamsModelLogin
The Login that owns this Team.
teamsAutoCascadeOwner
integer
originalEntryEvent
integer
CurrencyRatesFromCurrency
string
invoiceParametersModelLogin
The identifier of the Login that owns this invoiceParameter resource.
entitiesEinType
string
fundsModelEntity
The identifier of the Entity that owns this Fund.
messagesResponse
object
13 properties
revShareStatmentsModelRevShareSchedule
The RevShareSchedule object defines specific income sharing rules.
vendorsModelEntity
The identifier of the Entity associated with this Vendor resource.
merchantsPassTokenEnabled
integer
terminalTxnsDatasResponse
object
7 properties
secretsModelOrg
The identifier of the Org associated with this secret.
terminalsTimezone
string
configurationStagesResponse
object
28 properties
entriesModelTxn
If the activity that this Entry refers to is a Transaction, then this field stores the identifier of the corresponding Transaction resource.
disbursementResultsModelDisbursement
The identifier of the Disbursement that this disbursementResult resource refers to.
tokensModelPayment
The payment method that is associated with this Token.
omniTokensModelOrg
The identifier of the Org (group) that omniTokens is associated to.
disbursementRefsModelDisbursement
The identifier of the Disbursement that this disbursementRef resource refers to.
omniTokensModelDivision
The identifier of the Division that omniTokens is associated to.
txnsCopyReasons
string
payoutFlowsSameDay
integer
parametersUpdateAllTokensEnabled
integer
unauthReason
string
configurationsResponse
object
17 properties
revenueBoostsEnableRevenueBoost
integer
divisionsResponse
object
39 properties
billingModifiersResponse
object
13 properties
chargebackPaymentMethod
integer
disbursementsModelLastNegativeReserveEntry
The last negative ReserveEntry processed included in the disbursement.
entriesModelOnentity
The identifier of the Entity that this Entry refers to. This is the owner of the record that triggered the charge.
paymentUpdatesModelPaymentUpdateGroup
The PaymentGroup resource that this PaymentUpdate belongs to.
alertTriggersResponse
object
12 properties
binsTransferEnabled
integer
statementEntriesModelStatement
The identifier of the Statement that this StatementEntry refers to.
revShareScheduleEvent
integer
plansResponse
object
20 properties
binMethod
integer
notesModelHold
The identifier of the Hold that relates to this notes resource.
disbursementsModelStatement
The identifier of the Statement being paid by this Disbursement.
parametersDiscoverEnabled
integer
invoiceParametersModelEntity
The identifier of the Entity associated with this invoiceParameter.
omniTokensModelPartition
The identifier of the Partition that omniTokens is associated to.
profitSharesModelEntity
The identifier of the Entity that this ProfitShare refers to. This is the entity that will receive the split income/expense.
customersModelLogin
The ID of the Login that owns this resource.
pendingEntriesModelSettlement
If the activity that this PendingEntry refers to is a Settlement, then this field stores the identifier of the corresponding Settlement resource.
chargebacksShadow
integer
pinlessDebitConversionsPlatform
string
hostThemesModelHost
The identifier of the related host.
secretsPlatform
string
orgFlowActionsModelOrgFlow
The identifier of the OrgFlow resource that this orgFlowActions resource is associated with.
entityRoutesModelLogin
The Login that owns this EntityRoute.
binsDebitOverCreditEnabled
integer
billingModifiersModelDivision
The identifier of the Division that this Billing Modifier applies to.
txnsReserved
integer
teamLoginTeamAdmin
integer
txnsModelPayment
The payment method associated with this Transaction, including the card details.
disbursementsModelLastPositiveReserveEntry
The last positive ReserveEntry processed included in the disbursement.
aggregationsModelOrg
The identifier of the Org that this Aggregation applies to.
parametersMc3dsEnabled
integer
fundingParameterPlatform
string
parametersAmex3dsEnabled
integer
entitiesTimezone
string
feeCollection
integer
disbursementsModelLastPositiveEntry
The last positive Entry processed included in the disbursement.
merchantsExpressBatchCloseMethod
string
secretsModelDivision
The identifier of the Division associated with this secret.
fundingParameterLocked
integer
entityReturnsModelTxn
This field indicates that this EntityReturn was triggered from a\ \ Transaction. \nThis field stores the identifier of the Transaction.
hostThemesResponse
object
8 properties
terminalTxnResultType
integer
terminalTxnMetadataType
string
reservesModelLogin
The identifier of the Login that owns this Reserve.
parametersOmniTokenEnabled
integer
payoutFlowsModelBilling
The identifier of a Billing that this PayoutFlow is associated with. The Billing identifier will be carried over to Payouts created based on this PayoutFlow.
feeModifiersModelOrg
The identifier of the Org this Fee Modifiers should apply for on behalf of the Entity identified in the value of the 'entity' field. This field is optional. If…
configurationStageExtension
string
invoiceType
string
parametersFundingEnabled
integer
entitiesTinStatus
integer
feesCollectionFactor
integer
parametersAutoTaxExemptEnabled
integer
assessmentsModelOpposingAssessment
The identifier of the Assessment of the forentity assessment.
entriesModelRefund
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.
merchantsTcAttestation
integer
disbursementEntriesResponse
object
14 properties
assessmentsModelTxn
The identifier of the Txn that this assessment resource refers to.
configurationStageOutput
string
orgFlowsModelTeam
The identifier of the Team resource for which this orgFlows resource is triggered.
changeRequestModelRecordId
The id of the model, only set when operation is update.
credentialsResponse
object
17 properties
chargebacksModelLastStatusChange
The ChargebackStatus representing the latest status change for this Chargeback.
orgFlowRulesResponse
object
13 properties
disbursementsModelLastNegativePendingEntry
The last negative PendingEntry processed included in the disbursement.
terminalTxnsCvvStatus
string
pendingEntriesIsEFE
integer
invoiceLineItemsModelInvoiceItem
The identifier of the InvoiceItem associated with this InvoiceLineItem.
entriesIsEFE
integer
holdsModelLogin
The identifier of the Login that owns this holds resource.
hostsModelPartition
The identifier of the Partition resource that this Host belongs to.
merchantsModelEntity
The Entity associated with this Merchant.
txnType
integer
holdsModelEntity
The identifier of the Entity associated with this Hold resource.
loginsModelDivision
The division that this Login belongs to.
loginsConfirmed
integer
entryOriginsResponse
object
12 properties
notesModelTxn
The identifier of the Txn that relates to this notes resource.
mccsMccCode
string
chargebackMessageResponse
object
19 properties
teamLoginModelLogin
The Login that owns this resource.
messageThreadsModelHold
The identifier of the Hold that is related to this messageThread.
merchantType
string
decisionRuleType
string
statementsResponse
object
19 properties
alertsModelPartition
The partition for which this Alerts applies.
alertsModelDivision
The identifier of the Division that this Alert applies to.
statementEntriesModelProfitShare
If the activity that this StatementEntry refers to is a ProfitShare, then this field stores the identifier of the corresponding ProfitShare resource.
entityCheckStage
string
billingsModelPartition
The identifier of the Partition associated with this invoiceParameter.
interchangeHistoriesIsInitial
integer
chargebackMessageResultType
string
reserveEntriesModelOnentity
The identifier of the Entity that this reserveEntry refers to. This is the owner of the record that triggered the charge.
reserveEntriesModelReserve
This field indicates that this reserveEntry was triggered from an automatic reserve, and it stores the identifier of the Reserve resource.
invoiceParametersModelOrg
The identifier of the Org associated with this invoiceParameter.
txnResultsBankCode
string
pendingEntriesModelRevShareStatement
If the activity that this PendingEntry refers to is a Revenue Share, then this field stores the identifier of the corresponding RevShareStatement resource
txnsResponse
object
127 properties
accountUpdaterEligible
integer
profitSharesResponse
object
23 properties
paymentUpdatesModelPayment
The payment associated with this PaymentUpdate.
disbursementResultCode
string
parametersSameDayPayoutsEnabled
integer
terminalTxnResultsResponse
object
11 properties
reserveEntriesModelLogin
The Login that owns this resource.
currencyRatesResponse
object
17 properties
disbursementEntriesModelDisbursement
The identifier of the Disbursement that this DisbursementEntry resource refers to.
decisionsModelEntity
If this decision resource relates to an Entity, then this field stores the identifier of the Entity.
messageThreadsModelOpposingMessageThread
Specifies whether this is the opposing MessageThread.
orgsResponse
object
25 properties
entriesModelStatement
If the activity that this Entry refers to is a Statement, then this field stores the identifier of the corresponding Statement resource.
assessmentsModelMerchant
The identifier of the Merchant that this assessment resource refers to.
mccsModelOrg
The identifier of the Org associated with this Mcc resource.
assessmentsModelFee
The identifier of the Fee that this assessment resource refers to.
aggregationsLevel
string
parametersPayoutAdjustSubcents
integer
binsBillPayEnabled
integer
credentialType
string
revShareStatmentsResponse
object
10 properties
profitShareRulesResponse
object
14 properties
fundOriginsModelFunding
The processor's funding ID (related to a merchant, this field is required if the adjustment is not between entities.
divisionsModelLogin
The login ID of the user that owns this division record.
decisionsTarget
string
mccsResponse
object
12 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Payrix 12
Other APIs Payrix publishes across the network.
Payrix Accounts API
Payrix Accounts Verifications API
Payrix Adjustments API
Payrix Aggregation Result Groups API
Payrix Aggregation Results API
Payrix Aggregations API
Payrix Alert Actions API
Payrix Alert Triggers API
Payrix Alerts API
Payrix API Keys API
Payrix Apple Domains API
Payrix Apple Domains Mass Enablement API
#Host Themes
Where this information came from
This is an independent, third-party profile of Payrix Host Themes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.