Payrix · Schema
assessmentsResponseResult
CompanyPaymentsEmbedded PaymentsPayment FacilitationMerchant OnboardingFintechPayoutsChargebacksSubscription
Properties
| Name | Type | Description |
|---|---|---|
| response | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/payrix/main/json-schema/payrix-assessments-response-result-schema.json",
"title": "assessmentsResponseResult",
"x-generated": "2026-09-21",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/payrix-assessments-api-openapi.yml#/components/schemas/assessmentsResponseResult",
"type": "object",
"properties": {
"response": {
"$ref": "#/$defs/assessmentsResponseItem"
}
},
"$defs": {
"CurrencyConversion": {
"title": "CurrencyConversion",
"enum": [
"customerAccepted",
"customerRejected",
"notEligible"
],
"type": "string"
},
"CurrencyRatesFromCurrency": {
"title": "CurrencyRatesFromCurrency",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UZS",
"VEF",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XUA",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"type": "string"
},
"MembersGender": {
"title": "MembersGender",
"enum": [
"male",
"female"
],
"type": "string"
},
"MembersTimezone": {
"title": "MembersTimezone",
"enum": [
"est",
"cst",
"pst",
"mst",
"akst",
"hst",
"sst",
"chst",
"ast",
"pwt",
"mht",
"chut",
"nst"
],
"type": "string"
},
"MerchantsNew": {
"title": "MerchantsNew",
"enum": [
0,
1
],
"type": "integer"
},
"accountCheckStage": {
"title": "accountCheckStage",
"const": "createAccount",
"type": "string"
},
"accountMethod": {
"title": "accountMethod",
"enum": [
8,
9,
10,
11
],
"type": "integer"
},
"accountPayment": {
"title": "accountPayment",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of this resource."
},
"created": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$",
"type": "string",
"description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS"
},
"modified": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$",
"type": "string",
"description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS"
},
"creator": {
"allOf": [
{
"$ref": "#/$defs/creator"
},
{
"description": "The identifier of the Login that created this resource."
}
]
},
"modifier": {
"type": "string",
"description": "The identifier of the Login that last modified this resource."
},
"method": {
"allOf": [
{
"$ref": "#/$defs/accountMethod"
},
{
"description": "The type of the Account.\n\n<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": "For credit payment method, the card number of the credit card associated with this Transaction.\nFor eCheck payment method, the bank account number associated with this Transaction."
},
"last4": {
"type": "string"
},
"routing": {
"type": "string",
"description": "The routing code for the eCheck or bank account payment associated with this Transaction."
},
"bin": {
"type": "string"
},
"payment": {
"type": "string"
},
"lastChecked": {
"type": [
"integer",
"null"
],
"description": "Times timestamp with last time payment was checked.",
"contentEncoding": "int32"
},
"mask": {
"type": "string"
},
"inactive": {
"allOf": [
{
"$ref": "#/$defs/inactive"
},
{
"description": "Whether this resource is marked as inactive.\n\n<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>"
}
]
}
}
},
"accountPrimary": {
"title": "accountPrimary",
"enum": [
0,
1
],
"type": "integer"
},
"accountStatus": {
"title": "accountStatus",
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
"accountType": {
"title": "accountType",
"enum": [
"all",
"credit",
"debit"
],
"type": "string"
},
"accountUpdaterEligible": {
"title": "accountUpdaterEligible",
"enum": [
1,
0
],
"type": "integer"
},
"accountsModelAccount": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/accountPayment"
}
],
"description": "The identifier of the Payment associated with this Account."
},
"accountsModelEntity": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/entitiesResponse"
}
],
"description": "The identifier of the Entity associated with this Account."
},
"accountsReserved": {
"title": "accountsReserved",
"enum": [
0,
1,
3,
4,
5,
6,
7,
8,
9,
10
],
"type": "integer"
},
"accountsResponse": {
"title": "accountsResponse",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of this resource."
},
"created": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$",
"type": "string",
"description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS"
},
"modified": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$",
"type": "string",
"description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS"
},
"creator": {
"allOf": [
{
"$ref": "#/$defs/creator"
},
{
"description": "The identifier of the Login that created this resource."
}
]
},
"modifier": {
"type": "string",
"description": "The identifier of the Login that last modified this resource."
},
"entity": {
"allOf": [
{
"$ref": "#/$defs/accountsModelEntity"
},
{
"description": "The identifier of the Entity associated with this Account."
}
]
},
"account": {
"allOf": [
{
"$ref": "#/$defs/accountsModelAccount"
},
{
"description": "The identifier of the Payment associated with this Account."
}
]
},
"token": {
"type": "string",
"description": "A unique token that can be used to refer to this Account in other parts of the API."
},
"name": {
"type": "string",
"description": "A client-supplied name for this bank account. \nThis field is stored as a string and must be between 0 and 100 characters long."
},
"description": {
"type": "string",
"description": "A client-supplied description for this bank account. \nThis field is stored as a string and must be between 0 and 100 characters long."
},
"primary": {
"allOf": [
{
"$ref": "#/$defs/accountPrimary"
},
{
"description": "Indicates whether the Account is the primary Account for the associated Entity. \nOnly one Account associated with each Entity can be the primary Account.\n\n<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>"
}
]
},
"reserved": {
"allOf": [
{
"$ref": "#/$defs/accountsReserved"
},
{
"description": "Indicates whether the Account is reserved and the action that will be taken as a result.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **No reserve.**\n- `1` - **Block transaction, will never be processed. The Entity is sent to the manual review queue..**\n- `3` - **Hold transaction, will not be captured.**\n- `4` - **Reserve transaction, funds should be reserved.**\n- `5` - **Block current activity, no change for merchant.**\n- `6` - **Passed decision(s). Will not be set anywhere, will only be used for integration purposes.**\n- `7` - **We did not have policies to process.**\n- `8` - **We onboard the merchant and wait for manual check later.**\n- `9` - **Schedule the automatic release of the reserve.**\n- `10` - **Hold transaction, will not be captured. Automatic release when the associated sale is done.**\n\n</details>"
}
]
},
"checkStage": {
"allOf": [
{
"$ref": "#/$defs/accountCheckStage"
},
{
"description": "The last stage completed for risk.\n\n<details>\n<summary>Valid Values</summary>\n\n- `createAccount` - **Create Account**\n\n</details>"
}
]
},
"expiration": {
"type": "string",
"description": "The expiration date of the related debit account. \nThe date is specified as a four-digit string in MMYY format, for example, `0118` for January 2018."
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency of this Account. The default is `USD`. See <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>"
}
]
},
"plaidAccountId": {
"type": "string",
"description": "The account identifier that is returned by the Plaid flow."
},
"updateMethod": {
"allOf": [
{
"$ref": "#/$defs/accountsUpdateMethod"
},
{
"description": "The method used to update the account.\n\n<details>\n<summary>Valid Values</summary>\n\n- `NOC` - **Notification of change**\n- `PLAID` - **Plaid.**\n- `MANUAL` - **Manual**\n\n</details>"
}
]
},
"changeRequests": {
"type": "array",
"items": {
"$ref": "#/$defs/changeRequest"
},
"description": ""
},
"paymentUpdates": {
"type": "array",
"items": {
"$ref": "#/$defs/paymentUpdatesResponse"
},
"description": ""
},
"payouts": {
"type": "array",
"items": {
"$ref": "#/$defs/payoutsResponse"
},
"description": ""
}
}
},
"accountsUpdateMethod": {
"title": "accountsUpdateMethod",
"enum": [
"NOC",
"PLAID",
"MANUAL"
],
"type": "string"
},
"adjustmentsModelDisbursement": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/disbursementsResponse"
}
],
"description": "The identifier of the Disbursement associated with this Adjustment."
},
"adjustmentsModelEntity": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/entitiesResponse"
}
],
"description": "The identifier of the Entity associated with this Account."
},
"adjustmentsModelFromentity": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/entitiesResponse"
}
],
"description": "The applicable Entity for this Adjustment. \nThis field is an optional field."
},
"adjustmentsModelFunding": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/entityRefsResponse"
}
],
"description": "The ID of the fund which the disbursement’s movement applies."
},
"adjustmentsModelLogin": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/loginsResponse"
}
],
"description": "The identifier of the Login that created this resource."
},
"adjustmentsModelOnentity": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/entitiesResponse"
}
],
"description": "The identifier of the Entity associated with this Adjustment."
},
"adjustmentsResponse": {
"title": "adjustmentsResponse",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of this resource."
},
"created": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$",
"type": "string",
"description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS"
},
"modified": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$",
"type": "string",
"description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS"
},
"creator": {
"allOf": [
{
"$ref": "#/$defs/creator"
},
{
"description": "The identifier of the Login that created this resource."
}
]
},
"modifier": {
"type": "string",
"description": "The identifier of the Login that last modified this resource."
},
"login": {
"allOf": [
{
"$ref": "#/$defs/adjustmentsModelLogin"
},
{
"description": "The identifier of the Login that created this resource."
}
]
},
"entity": {
"allOf": [
{
"$ref": "#/$defs/adjustmentsModelEntity"
},
{
"description": "The identifier of the Entity associated with this Account."
}
]
},
"fromentity": {
"allOf": [
{
"$ref": "#/$defs/adjustmentsModelFromentity"
},
{
"description": "The applicable Entity for this Adjustment. \nThis field is an optional field."
}
]
},
"onentity": {
"allOf": [
{
"$ref": "#/$defs/adjustmentsModelOnentity"
},
{
"description": "The identifier of the Entity associated with this Adjustment."
}
]
},
"disbursement": {
"allOf": [
{
"$ref": "#/$defs/adjustmentsModelDisbursement"
},
{
"description": "The identifier of the Disbursement associated with this Adjustment."
}
]
},
"description": {
"type": "string",
"description": "The description of this Decision Rule. \nThis field is stored as a text string and must be between 0 and 100 characters long."
},
"amount": {
"type": "number",
"description": "The amount of the Adjustment, This field is specified in cents(up to three decimal points)."
},
"currency": {
"allOf": [
{
"oneOf": [
{},
{
"$ref": "#/$defs/currency"
}
]
},
{
"description": "The currency for the amount of this resource. See <a href=\"https://www.iban.com/currency-codes\" target=\"_blank\">Currency codes</a> for all valid values."
}
]
},
"funding": {
"allOf": [
{
"$ref": "#/$defs/adjustmentsModelFunding"
},
{
"description": "The ID of the fund which the disbursement’s movement applies."
}
]
},
"platform": {
"type": "string",
"description": "The processor that issued this terminalTxnRef.\n\n<details>\n<summary>Valid Values</summary>\n\n- `APPLE` - **Apple Payment Processor**\n- `ELAVON` - **ELAVON Payment Processor**\n- `FIRSTDATA` - **FirstData Payment Processor**\n- `GOOGLE` - **Google Payment Processor**\n- `VANTIV` - **WorldPay / Vantiv eComm Payment Processor (VAP)**\n- `VCORE` - **WorldPay / Vantiv Core Payment Processor**\n- `WELLSACH` - **Wells Fargo Merchant Services Payment Processor (ACH)**\n- `WELLSFARGO` - **Wells Fargo Merchant Services Payment Processor**\n- `WFSINGLE` - **Wells Fargo Single Payment Processor**\n- `WORLDPAY` - **WORLDPAY**\n- `TDBANKCA` - **TDBANKCA**\n</details>"
},
"fbo": {
"type": "string",
"description": "FBO account (For-Benefit-Of account) identifier."
},
"entry": {
"$ref": "#/$defs/entriesResponse"
},
"entryOrigins": {
"type": "array",
"items": {
"$ref": "#/$defs/entryOriginsResponse"
},
"description": ""
},
"pendingEntry": {
"$ref": "#/$defs/pendingEntriesResponse"
}
}
},
"aggregationDefault": {
"title": "aggregationDefault",
"enum": [
0,
1
],
"type": "integer"
},
"aggregationResultGroupsModelAggregation": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/aggregationsResponse"
}
],
"description": "The identifier of the Aggregation that this AggregationResult refers to."
},
"aggregationResultGroupsResponse": {
"title": "aggregationResultGroupsResponse",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of this resource."
},
"created": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$",
"type": "string",
"description": "The date and time at which this resource was created. The format should be YYYY-MM-DD HH:MM:SS.SSSS"
},
"modified": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}.\\d{4}$",
"type": "string",
"description": "The date and time at which this resource was modified. The format should be YYYY-MM-DD HH:MM:SS.SSSS"
},
"creator": {
"allOf": [
{
"$ref": "#/$defs/creator"
},
{
"description": "The identifier of the Login that created this resource."
}
]
},
"modifier": {
"type": "string",
"description": "The identifier of the Login that last modified this resource."
},
"aggregation": {
"allOf": [
{
"$ref": "#/$defs/aggregationResultGroupsModelAggregation"
},
{
"description": "The identifier of the Aggregation that this AggregationResult refers to."
}
]
},
"resource": {
"allOf": [
{
"$ref": "#/$defs/resource"
},
{
"description": "<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, must be between 0 and 1000 characters long, and is copied from the aggregation."
},
"totals": {
"type": "string",
"description": "The especification of the desired aggregation functions including count, sum, min and max. This field is stored as a text string, must be between 1 and 100 characters long, and is copied from the aggregation."
},
"degrouping": {
"type": "string",
"description": "Degrouping is the reverse process of grouping, where progressively smaller groups are removed to provide aggregated results at higher levels. This is useful when you want to see overall totals without the detailed breakdowns. For example, degrouping can be used to sum up all transactions across all merchants and payment methods, providing a total approval count without needing to look at individual merchant or payment method details."
},
"lastModified": {
"pattern": "^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}",
"type": "string",
"description": "The last modified date and time. The format should be YYYY-MM-DD HH:MM:SS"
},
"effective": {
"type": "integer",
"description": "Effective date time of aggregation.",
"contentEncoding": "int64"
},
"default": {
"allOf": [
{
"$ref": "#/$defs/aggregationDefault"
},
{
"description": "Indicates whether this aggregation was automatically created.\n\n<details>\n<summary>Valid Values</summary>\n\n- `0` - **Manually created.**\n- `1` - **Automatically created.**\n\n</details>"
}
]
},
"type": {
"type": "string",
"description": "The type of aggregation which auto-sets the search and total values."
},
"level": {
"type": "string",
"description": "The level of user the aggregation should be processed for (similar to Decisions.level)."
},
"aggregationResults": {
"type": "array",
"items": {
# --- truncated at 32 KB (1305 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/payrix/refs/heads/main/json-schema/payrix-assessments-response-result-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-assessments-response-result"
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.