Monite · Schema
BatchPaymentLinkWithPaymentIntents
Response schema for a batch payment link with payment intents. Used for GET /batch_payment_links/{link_id} endpoint.
CompanyEmbedded FinanceInvoicingAccounts PayablePaymentsB2BFintechSoftware-as-a-Service
Properties
| Name | Type | Description |
|---|---|---|
| id | string | |
| created_at | string | |
| error | object | |
| expires_at | string | |
| payment_intents | array | |
| payment_page_url | string | |
| status | object | |
| total_amount | integer |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/monite/json-schema/monite-batch-payment-link-with-payment-intents-schema.json",
"title": "BatchPaymentLinkWithPaymentIntents",
"description": "Response schema for a batch payment link with payment intents.\nUsed for GET /batch_payment_links/{link_id} endpoint.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/monite-batch-payment-links-api-openapi.yml#/components/schemas/BatchPaymentLinkWithPaymentIntents",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"error": {
"type": "object"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"payment_intents": {
"items": {
"$ref": "#/$defs/PaymentIntentResponse"
},
"type": "array"
},
"payment_page_url": {
"type": "string",
"maxLength": 2083,
"minLength": 1,
"format": "uri"
},
"status": {
"$ref": "#/$defs/PaymentsBatchPaymentStatus"
},
"total_amount": {
"type": "integer"
}
},
"type": "object",
"required": [
"id",
"created_at",
"expires_at",
"payment_intents",
"payment_page_url",
"status"
],
"$defs": {
"AllowedCountries": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"IC",
"CV",
"KY",
"CF",
"EA",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"SZ",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"AN",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"MK",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"SH",
"KN",
"LC",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"SS",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW",
"BL",
"BQ",
"CW",
"MF",
"SX"
]
},
"BankAccount": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The ID of the bank account."
},
"account_holder_name": {
"type": "string",
"description": "The name of the person or business that owns this bank account."
},
"account_number": {
"type": "string",
"description": "The bank account number. Typically used for UK and US bank accounts. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits."
},
"bic": {
"type": "string",
"maxLength": 11,
"description": "The BIC/SWIFT code of the bank."
},
"country": {
"allOf": [
{
"$ref": "#/$defs/AllowedCountries"
}
],
"description": "The country in which the bank account is registered, repsesented as a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
},
"currency": {
"allOf": [
{
"$ref": "#/$defs/CurrencyEnum"
}
],
"description": "The currency of the bank account, represented as a three-letter ISO [currency code](https://docs.monite.com/references/currencies)."
},
"display_name": {
"type": "string",
"maxLength": 200,
"description": "User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for entity bank accounts."
},
"iban": {
"type": "string",
"maxLength": 34,
"description": "The IBAN of the bank account."
},
"is_default": {
"type": "boolean",
"description": "Indicates whether this bank account is the default one for its currency.",
"default": false
},
"name": {
"type": "string",
"maxLength": 200,
"description": "User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for counterpart bank accounts."
},
"routing_number": {
"type": "string",
"description": "The bank's routing transit number (RTN). Typically used for US banks. US routing numbers consist of 9 digits."
},
"sort_code": {
"type": "string",
"description": "The bank's sort code. Typically used for UK banks."
},
"was_created_by_user_id": {
"type": "string",
"format": "uuid",
"description": "ID of the entity user who added this bank account, or `null` if it was added using a partner access token. Used only for entity bank accounts."
}
},
"type": "object",
"required": [
"id"
]
},
"CurrencyEnum": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SEK",
"SGD",
"SHP",
"SLE",
"SOS",
"SRD",
"SSP",
"SVC",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
]
},
"Invoice": {
"properties": {
"due_date": {
"type": "string",
"format": "date"
},
"file": {
"$ref": "#/$defs/InvoiceFile"
},
"issue_date": {
"type": "string",
"format": "date"
}
},
"additionalProperties": false,
"type": "object"
},
"InvoiceFile": {
"properties": {
"mimetype": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"url": {
"type": "string",
"maxLength": 2083,
"minLength": 1,
"format": "uri"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"mimetype",
"name",
"url"
]
},
"MoniteAllPaymentMethodsTypes": {
"type": "string",
"enum": [
"sepa_credit",
"us_ach",
"blik",
"card",
"bacs_direct_debit",
"bancontact",
"eps",
"giropay",
"ideal",
"p24",
"sepa_debit",
"sofort",
"applepay",
"googlepay",
"affirm",
"klarna"
]
},
"PayerAccountResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of a payment account"
},
"bank_accounts": {
"items": {
"$ref": "#/$defs/BankAccount"
},
"type": "array",
"description": "List of bank accounts"
},
"name": {
"type": "string",
"description": "Display name of a payment account"
},
"type": {
"allOf": [
{
"$ref": "#/$defs/PaymentAccountType"
}
],
"description": "Type of a payment account. Can be `entity` or `counterpart`"
}
},
"type": "object",
"required": [
"id",
"type"
]
},
"PaymentAccountType": {
"type": "string",
"enum": [
"entity",
"counterpart"
]
},
"PaymentIntentResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"amount": {
"type": "integer"
},
"application_fee_amount": {
"type": "integer"
},
"batch_payment_id": {
"type": "string",
"format": "uuid"
},
"currency": {
"type": "string"
},
"invoice": {
"$ref": "#/$defs/Invoice"
},
"object": {
"$ref": "#/$defs/PaymentObject"
},
"payer": {
"$ref": "#/$defs/PayerAccountResponse"
},
"payment_link_id": {
"type": "string",
"format": "uuid"
},
"payment_methods": {
"items": {
"$ref": "#/$defs/MoniteAllPaymentMethodsTypes"
},
"type": "array"
},
"payment_reference": {
"type": "string"
},
"provider": {
"type": "string"
},
"recipient": {
"$ref": "#/$defs/RecipientAccountResponse"
},
"selected_payment_method": {
"$ref": "#/$defs/MoniteAllPaymentMethodsTypes"
},
"status": {
"type": "string"
}
},
"type": "object",
"required": [
"id",
"updated_at",
"amount",
"currency",
"payment_methods",
"recipient",
"status"
]
},
"PaymentObject": {
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/$defs/PaymentObjectType"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"type"
]
},
"PaymentObjectType": {
"type": "string",
"enum": [
"payable",
"receivable"
]
},
"PaymentsBatchPaymentStatus": {
"type": "string",
"enum": [
"created",
"processing",
"partially_successful",
"succeeded",
"failed",
"expired"
]
},
"RecipientAccountResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of a payment account"
},
"bank_accounts": {
"items": {
"$ref": "#/$defs/BankAccount"
},
"type": "array",
"description": "List of bank accounts"
},
"name": {
"type": "string",
"description": "Display name of a payment account"
},
"type": {
"allOf": [
{
"$ref": "#/$defs/PaymentAccountType"
}
],
"description": "Type of a payment account. Can be `entity` or `counterpart`"
}
},
"type": "object",
"required": [
"id",
"type"
]
}
}
}
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/monite-batch-payment-link-with-payment-intents"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.