Payrix · Schema
alertTriggersPostRequest
CompanyPaymentsEmbedded PaymentsPayment FacilitationMerchant OnboardingFintechPayoutsChargebacksSubscription
Properties
| Name | Type | Description |
|---|---|---|
| alert | object | |
| event | object | |
| resource | object | |
| name | string | The name of this alertTrigger. This field is stored as a text string and must be between 0 and 100 characters long. |
| description | string | Description of Alert Triggers. |
| inactive | object | |
| frozen | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/payrix/main/json-schema/payrix-alert-triggers-post-request-schema.json",
"title": "alertTriggersPostRequest",
"x-generated": "2026-09-21",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/payrix-alert-triggers-api-openapi.yml#/components/schemas/alertTriggersPostRequest",
"required": [
"alert",
"event",
"resource"
],
"type": "object",
"properties": {
"alert": {
"allOf": [
{
"$ref": "#/$defs/alertTriggersPostRequestModelAlert"
},
{
"description": "The identifier of the Alert resource that you want to invoke with this trigger."
}
]
},
"event": {
"allOf": [
{
"$ref": "#/$defs/alertTriggerEvent"
},
{
"description": "The event type that triggers the associated Alert.\n\n<details>\n<summary>Valid Values</summary>\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</details>"
}
]
},
"resource": {
"allOf": [
{
"$ref": "#/$defs/alertTriggerResource"
},
{
"description": "<details><summary>Valid Values</summary>\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</details>"
}
]
},
"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<details>\n<summary>Valid Values</summary>\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n</details>"
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n</details>"
}
]
}
},
"$defs": {
"CurrencyConversion": {
"title": "CurrencyConversion",
"enum": [
"customerAccepted",
"customerRejected",
"notEligible"
],
"type": "string"
},
"MembersGender": {
"title": "MembersGender",
"enum": [
"male",
"female"
],
"type": "string"
},
"MembersTimezone": {
"title": "MembersTimezone",
"enum": [
"est",
"cst",
"pst",
"mst",
"akst",
"hst",
"sst",
"chst",
"ast",
"pwt",
"mht",
"chut",
"nst"
],
"type": "string"
},
"MerchantsNew": {
"title": "MerchantsNew",
"enum": [
0,
1
],
"type": "integer"
},
"accountMethod": {
"title": "accountMethod",
"enum": [
8,
9,
10,
11
],
"type": "integer"
},
"accountPrimary": {
"title": "accountPrimary",
"enum": [
0,
1
],
"type": "integer"
},
"accountStatus": {
"title": "accountStatus",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
"accountType": {
"title": "accountType",
"enum": [
"all",
"credit",
"debit"
],
"type": "string"
},
"accountUpdaterEligible": {
"title": "accountUpdaterEligible",
"enum": [
1,
0
],
"type": "integer"
},
"accountsAccount": {
"title": "accountsAccount",
"type": "object",
"properties": {
"method": {
"allOf": [
{
"$ref": "#/$defs/accountMethod"
},
{
"description": "The type of the Account.\n\n<details>\n<summary>Valid Values</summary>\n\n- `8` - **Checking**\n- `9` - **Savings**\n- `10` - **Corporate Checking**\n- `11` - **Corporate Savings**\n\n</details>"
}
]
},
"number": {
"type": "string",
"description": "The number of the bank account."
},
"routing": {
"type": "string",
"description": "The routing number of the bank account. This field is stored as a text string and must be between 5 and 20 characters long."
}
},
"description": "An object representing details of the Account, including the type of Account (method), Account number, and routing code."
},
"accountsPostRequest": {
"title": "accountsPostRequest",
"required": [
"entity",
"account",
"currency"
],
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "The identifier of the Entity associated with this Account."
},
"account": {
"allOf": [
{
"$ref": "#/$defs/accountsAccount"
},
{
"description": "An object representing details of the Account, including the type of Account (method), Account number, and routing code."
}
]
},
"name": {
"type": "string",
"description": "A client-supplied name for this bank account. \nThis field is stored as a string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A client-supplied description for this bank account. \nThis field is stored as a string and must be between 0 and 100 characters long."
},
"primary": {
"allOf": [
{
"$ref": "#/$defs/accountPrimary"
},
{
"description": "Indicates whether the Account is the primary Account for the associated Entity. \nOnly one Account associated with each Entity can be the primary Account.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not primary**\n- `1` - **Primary**\n\n</details>"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/$defs/accountType"
},
{
"description": "The type of financial account: debit, credit, or both.\n\n<details>\n<summary>Valid Values</summary>\n\n- `all` - **Debit/checking and credit**\n- `credit` - **Credit only**\n- `debit` - **Debit/checking only**\n\n</details>"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/$defs/accountStatus"
},
{
"description": "The status of the Account.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Ready.**\n- `1` - **Ready.**\n- `2` - **Challenged.**\n- `3` - **Verified.**\n- `4` - **Manual.**\n\n</details>"
}
]
},
"expiration": {
"type": "string",
"description": "The expiration date of the related debit account. The date is specified as a four-digit string in MMYY format, for example, `0118` for January 2018."
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency of this Account. The default is `USD`. See <a href=\"https://www.iban.com/currency-codes\" target=\"_blank\">Currency codes</a> 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<details>\n<summary>Valid Values</summary>\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n</details>"
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n</details>"
}
]
},
"payouts": {
"type": "array",
"items": {
"$ref": "#/$defs/payoutPostRequest"
},
"description": ""
}
},
"description": "A request body for creating new bank account information for one or more entities."
},
"aggregationDefault": {
"title": "aggregationDefault",
"enum": [
0,
1
],
"type": "integer"
},
"aggregationSchedule": {
"title": "aggregationSchedule",
"enum": [
"hours",
"days",
"weeks",
"months",
"years"
],
"type": "string"
},
"aggregationStatus": {
"title": "aggregationStatus",
"enum": [
"notReady",
"ready",
"processing",
"processed"
],
"type": "string"
},
"aggregationType": {
"title": "aggregationType",
"enum": [
"entityEntryEventMerchant",
"merchantTxnApprovedAll",
"merchantTxnCapturedAll",
"merchantTxnFailedAll"
],
"type": "string"
},
"aggregationsLevel": {
"title": "aggregationsLevel",
"enum": [
"admin",
"division",
"merchant",
"partition"
],
"type": "string"
},
"aggregationsPostRequest": {
"title": "aggregationsPostRequest",
"required": [
"login",
"resource",
"totals",
"schedule",
"start"
],
"type": "object",
"properties": {
"login": {
"type": "string",
"description": "The identifier of the Login that owns this Aggregation."
},
"entity": {
"type": "string",
"description": "The identifier of the Entity that this Aggregation applies to."
},
"forlogin": {
"type": "string",
"description": "The identifier of the Login that this Aggregation applies to."
},
"org": {
"type": "string",
"description": "The identifier of the Org that this Aggregation applies to."
},
"team": {
"type": "string",
"description": "The identifier of the Team that this Aggregation applies to."
},
"division": {
"type": "string",
"description": "The identifier of the Division that this Aggregation applies to."
},
"partition": {
"type": "string",
"description": "The identifier of the Partition that this Aggregation applies to."
},
"type": {
"allOf": [
{
"$ref": "#/$defs/aggregationType"
},
{
"description": "The type of aggregation. This will automatically set the search and total values.\n\n<details>\n<summary>Valid Values</summary>\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</details>"
}
]
},
"level": {
"allOf": [
{
"$ref": "#/$defs/aggregationsLevel"
},
{
"description": "The level of user that this aggregation will run for.\n\n<details>\n<summary>Valid Values</summary>\n\n- `admin` - **Admin User.**\n- `division` - **Division-level User.**\n- `merchant` - **Merchant-level User.**\n- `partition` - **Partition-level User.**\n\n</details>"
}
]
},
"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": "<details><summary>Valid Values</summary>\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</details>"
}
]
},
"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<details>\n<summary>Valid Values</summary>\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</details>"
}
]
},
"schedule": {
"allOf": [
{
"$ref": "#/$defs/aggregationSchedule"
},
{
"description": "The schedule that determines when the aggregation function will be processed.\n\n<details>\n<summary>Valid Values</summary>\n\n- `hours` - **Hourly schedule.**\n- `days` - **Daily schedule.**\n- `weeks` - **Weekly schedule.**\n- `months` - **Monthly schedule.**\n- `years` - **Annual schedule.**\n\n</details>"
}
]
},
"scheduleFactor": {
"type": "integer",
"description": "A multiplier that you can use to adjust the schedule set in the 'schedule' field, such as daily, weekly, monthly, or annually. In This field is specified as an integer and its value determines how the interval is multiplied.",
"contentEncoding": "int32",
"default": 1
},
"start": {
"type": "integer",
"description": "The date on which the aggregation processing should start. The date is specified as a twelve digit string in YYYYMMDDHHII format, for example, '201601201528' for January 20, 2016 at 15:28 (3:28 pm). The value of this field must represent a date in the future, or the present date. When the schedule is set to HOURLY (1) the minute part of the time must be divisible by 10 (15:10, 15:20, 15:30, etc...).",
"contentEncoding": "int64"
},
"default": {
"allOf": [
{
"$ref": "#/$defs/aggregationDefault"
},
{
"description": "Indicates whether this aggregation was automatically created.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Manually created.**\n- `1` - **Automatically created.**\n\n</details>"
}
]
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Active**\n- `1` - **Inactive**\n\n</details>"
}
]
},
"frozen": {
"allOf": [
{
"$ref": "#/$defs/frozen"
},
{
"description": "Whether this resource is marked as frozen.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Not Frozen**\n- `1` - **Frozen**\n\n</details>"
}
]
}
}
},
"alertActionType": {
"title": "alertActionType",
"enum": [
"email",
"web",
"app",
"sms"
],
"type": "string"
},
"alertActionsMaxAttemptsTempDisabled": {
"title": "alertActionsMaxAttemptsTempDisabled",
"enum"
# --- truncated at 32 KB (419 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/payrix/refs/heads/main/json-schema/payrix-alert-triggers-post-request-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/payrix-alert-triggers-post-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.