removedInput schema / $defs
Removed value: -{
- "BillDescription": {
- "properties": {
- "account": {
- "anyOf": [
- {
- "pattern": "^(([A-Za-z0-9\\s\\*\\.\\-#]{1,20})|(N/A))$",
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "User Account on the bill, if none ticket number",
- "title": "Account"
- },
- "amountDue": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Total balance due on the bill (the full amount owed), as read from the bill. This is NOT necessarily what the user will pay - see amount_to_pay.",
- "title": "Amountdue"
- },
- "amount_to_pay": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The amount the user wants to pay now. May be a partial payment, distinct from amountDue (the bill total). Ask the user how much they want to pay before calling; set equal to amountDue to pay in full. Passing it previews any fee for that amount in the result.",
- "title": "Amount To Pay"
- },
- "auth_token": {
- "anyOf": [
- {
- "pattern": "^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$",
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "authorization token attached to the user (if a user already exists from a previous bill payment). MUST be the most recent/current auth_token (check latest call with the same user id, possibly in a previous session). Depending how long ago the previous payment was made, may first need to obtain a new token.",
- "title": "Auth Token"
- },
- "billerName": {
- "description": "Name of the biller",
- "maxLength": 50,
- "minLength": 2,
- "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
- "title": "Billername",
- "type": "string"
- },
- "correspondenceAddress": {
- "anyOf": [
- {
- "$ref": "#/$defs/BillingAddress"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Biller correspondence address"
- },
- "dueDate": {
- "anyOf": [
- {
- "pattern": "\\d{1,2}\\s?(/|-)\\s?\\d{1,2}\\s?(/|-)\\s?(\\d{4}|\\d{2})",
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Due date for the bill in MM/DD/YYYY format MM/DD/YY is acceptable",
- "title": "Duedate"
- },
- "otherInfo": {
- "default": {},
- "description": "Other information extracted from the bill that helps identify the provider or complete the payment (like code, pin, pass ...). If the bill shows a payment phone number, include it here (e.g. 'pay_by_phone': '1-800-555-1234') - like the remit-to address it helps identify the correct biller. For a web-payment URL use the payUrl field instead, not this map.",
- "patternProperties": {
- "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "integer"
- },
- {
- "maxLength": 75,
- "minLength": 2,
- "pattern": "^[a-zA-Z0-9 \\-\\./,'&@*#:?=+()]+$",
- "type": "string"
- }
- ]
- }
- },
- "propertyNames": {
- "maxLength": 50,
- "minLength": 2
- },
- "title": "Otherinfo",
- "type": "object"
- },
- "payUrl": {
- "anyOf": [
- {
- "maxLength": 120,
- "minLength": 4,
- "pattern": "^[a-zA-Z0-9\\-._~:/?#\\[\\]@!$&'()*+,;=%]+$",
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The web address where the bill can be paid online (the 'pay at' / 'pay online' URL printed on the bill), e.g. https://www.biller.com/pay. Like the remit-to address it strongly identifies the correct biller, so include it whenever the bill shows one to reduce the risk of a misidentified, failed, or delayed payment. Must be a single URL of at most 120 characters (just the base 'pay online' address, no extra text); omit it rather than sending anything longer.",
- "title": "Payurl"
- },
- "remitAddress": {
- "anyOf": [
- {
- "$ref": "#/$defs/BillingAddress"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Biller remit-to address (where payment is sent). This is the key field for identifying the correct biller - an incorrect or missing remit-to address can cause the bill to be matched to the wrong biller, delaying or failing the payment. Always provide it from the bill. If the bill does not show a remit-to address, research the biller's official remit-to/payment address online and use that rather than leaving it empty."
- },
- "userAddress": {
- "anyOf": [
- {
- "$ref": "#/$defs/BillingAddress"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "User address"
- },
- "user_amount_statement": {
- "anyOf": [
- {
- "maxLength": 200,
- "minLength": 3,
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Required proof that you asked the user how much to pay and they answered: quote what the user actually said (e.g. 'pay the full 150' or 'just 50 this month'). You MUST have asked the user before setting amount_to_pay - never invent the amount or this quote.",
- "title": "User Amount Statement"
- },
- "user_id": {
- "anyOf": [
- {
- "pattern": "^[a-zA-Z0-9]{10}$",
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "identifier for the user if a user already exists from a previous bill payment",
- "title": "User Id"
- }
- },
- "required": [
- "billerName"
- ],
- "title": "BillDescription",
- "type": "object"
- },
- "BillingAddress": {
- "properties": {
- "address": {
- "maxLength": 100,
- "minLength": 5,
- "pattern": "^[a-zA-Z0-9\\s\\-\\.',#]+$",
- "title": "Address",
- "type": "string"
- },
- "city": {
- "maxLength": 50,
- "minLength": 2,
- "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
- "title": "City",
- "type": "string"
- },
- "name": {
- "maxLength": 50,
- "minLength": 2,
- "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
- "title": "Name",
- "type": "string"
- },
- "stateCode": {
- "pattern": "^[A-Z]{2}$",
- "title": "Statecode",
- "type": "string"
- },
- "zip": {
- "pattern": "^\\d{5}(-\\d{4})?$",
- "title": "Zip",
- "type": "string"
- }
- },
- "required": [
- "name",
- "address",
- "city",
- "stateCode",
- "zip"
- ],
- "title": "BillingAddress",
- "type": "object"
- }
-}
addedInput schema / properties / bill_description / properties
Added value: +{
+ "account": {
+ "anyOf": [
+ {
+ "pattern": "^(([A-Za-z0-9\\s\\*\\.\\-#]{1,20})|(N/A))$",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "User Account on the bill, if none ticket number",
+ "title": "Account"
+ },
+ "amountDue": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Total balance due on the bill (the full amount owed), as read from the bill. This is NOT necessarily what the user will pay - see amount_to_pay.",
+ "title": "Amountdue"
+ },
+ "amount_to_pay": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The amount the user wants to pay now. May be a partial payment, distinct from amountDue (the bill total). Ask the user how much they want to pay before calling; set equal to amountDue to pay in full. Passing it previews any fee for that amount in the result.",
+ "title": "Amount To Pay"
+ },
+ "auth_token": {
+ "anyOf": [
+ {
+ "pattern": "^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "authorization token attached to the user (if a user already exists from a previous bill payment). MUST be the most recent/current auth_token (check latest call with the same user id, possibly in a previous session). Depending how long ago the previous payment was made, may first need to obtain a new token.",
+ "title": "Auth Token"
+ },
+ "billerName": {
+ "description": "Name of the biller",
+ "maxLength": 50,
+ "minLength": 2,
+ "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
+ "title": "Billername",
+ "type": "string"
+ },
+ "correspondenceAddress": {
+ "anyOf": [
+ {
+ "properties": {
+ "address": {
+ "maxLength": 100,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9\\s\\-\\.',#]+$",
+ "title": "Address",
+ "type": "string"
+ },
+ "city": {
+ "maxLength": 50,
+ "minLength": 2,
+ "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
+ "title": "City",
+ "type": "string"
+ },
+ "name": {
+ "maxLength": 50,
+ "minLength": 2,
+ "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
+ "title": "Name",
+ "type": "string"
+ },
+ "stateCode": {
+ "pattern": "^[A-Z]{2}$",
+ "title": "Statecode",
+ "type": "string"
+ },
+ "zip": {
+ "pattern": "^\\d{5}(-\\d{4})?$",
+ "title": "Zip",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "city",
+ "stateCode",
+ "zip"
+ ],
+ "title": "BillingAddress",
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Biller correspondence address"
+ },
+ "dueDate": {
+ "anyOf": [
+ {
+ "pattern": "\\d{1,2}\\s?(/|-)\\s?\\d{1,2}\\s?(/|-)\\s?(\\d{4}|\\d{2})",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Due date for the bill in MM/DD/YYYY format MM/DD/YY is acceptable",
+ "title": "Duedate"
+ },
+ "otherInfo": {
+ "default": {},
+ "description": "Other information extracted from the bill that helps identify the provider or complete the payment (like code, pin, pass ...). If the bill shows a payment phone number, include it here (e.g. 'pay_by_phone': '1-800-555-1234') - like the remit-to address it helps identify the correct biller. For a web-payment URL use the payUrl field instead, not this map.",
+ "patternProperties": {
+ "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "maxLength": 75,
+ "minLength": 2,
+ "pattern": "^[a-zA-Z0-9 \\-\\./,'&@*#:?=+()]+$",
+ "type": "string"
+ }
+ ]
+ }
+ },
+ "propertyNames": {
+ "maxLength": 50,
+ "minLength": 2
+ },
+ "title": "Otherinfo",
+ "type": "object"
+ },
+ "payUrl": {
+ "anyOf": [
+ {
+ "maxLength": 120,
+ "minLength": 4,
+ "pattern": "^[a-zA-Z0-9\\-._~:/?#\\[\\]@!$&'()*+,;=%]+$",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The web address where the bill can be paid online (the 'pay at' / 'pay online' URL printed on the bill), e.g. https://www.biller.com/pay. Like the remit-to address it strongly identifies the correct biller, so include it whenever the bill shows one to reduce the risk of a misidentified, failed, or delayed payment. Must be a single URL of at most 120 characters (just the base 'pay online' address, no extra text); omit it rather than sending anything longer.",
+ "title": "Payurl"
+ },
+ "remitAddress": {
+ "anyOf": [
+ {
+ "properties": {
+ "address": {
+ "maxLength": 100,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9\\s\\-\\.',#]+$",
+ "title": "Address",
+ "type": "string"
+ },
+ "city": {
+ "maxLength": 50,
+ "minLength": 2,
+ "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
+ "title": "City",
+ "type": "string"
+ },
+ "name": {
+ "maxLength": 50,
+ "minLength": 2,
+ "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
+ "title": "Name",
+ "type": "string"
+ },
+ "stateCode": {
+ "pattern": "^[A-Z]{2}$",
+ "title": "Statecode",
+ "type": "string"
+ },
+ "zip": {
+ "pattern": "^\\d{5}(-\\d{4})?$",
+ "title": "Zip",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "city",
+ "stateCode",
+ "zip"
+ ],
+ "title": "BillingAddress",
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Biller remit-to address (where payment is sent). This is the key field for identifying the correct biller - an incorrect or missing remit-to address can cause the bill to be matched to the wrong biller, delaying or failing the payment. Always provide it from the bill. If the bill does not show a remit-to address, research the biller's official remit-to/payment address online and use that rather than leaving it empty."
+ },
+ "userAddress": {
+ "anyOf": [
+ {
+ "properties": {
+ "address": {
+ "maxLength": 100,
+ "minLength": 5,
+ "pattern": "^[a-zA-Z0-9\\s\\-\\.',#]+$",
+ "title": "Address",
+ "type": "string"
+ },
+ "city": {
+ "maxLength": 50,
+ "minLength": 2,
+ "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
+ "title": "City",
+ "type": "string"
+ },
+ "name": {
+ "maxLength": 50,
+ "minLength": 2,
+ "pattern": "^(([a-zA-Z0-9 \\-\\_.,'&]+)|(N/A))$",
+ "title": "Name",
+ "type": "string"
+ },
+ "stateCode": {
+ "pattern": "^[A-Z]{2}$",
+ "title": "Statecode",
+ "type": "string"
+ },
+ "zip": {
+ "pattern": "^\\d{5}(-\\d{4})?$",
+ "title": "Zip",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "address",
+ "city",
+ "stateCode",
+ "zip"
+ ],
+ "title": "BillingAddress",
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "User address"
+ },
+ "user_amount_statement": {
+ "anyOf": [
+ {
+ "maxLength": 200,
+ "minLength": 3,
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Required proof that you asked the user how much to pay and they answered: quote what the user actually said (e.g. 'pay the full 150' or 'just 50 this month'). You MUST have asked the user before setting amount_to_pay - never invent the amount or this quote.",
+ "title": "User Amount Statement"
+ },
+ "user_id": {
+ "anyOf": [
+ {
+ "pattern": "^[a-zA-Z0-9]{10}$",
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "identifier for the user if a user already exists from a previous bill payment",
+ "title": "User Id"
+ }
+}