Payrix · Schema
alertTriggersPutRequest
CompanyPaymentsEmbedded PaymentsPayment FacilitationMerchant OnboardingFintechPayoutsChargebacksSubscription
Properties
| Name | Type | Description |
|---|---|---|
| alert | string | The identifier of the Alert resource that you want to invoke with this trigger. |
| 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-put-request-schema.json",
"title": "alertTriggersPutRequest",
"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/alertTriggersPutRequest",
"type": "object",
"properties": {
"alert": {
"type": "string",
"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": {
"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"
},
"frozen": {
"title": "frozen",
"enum": [
0,
1
],
"type": "integer"
},
"inactive": {
"title": "inactive",
"enum": [
0,
1
],
"type": "integer"
}
}
}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-put-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.