{"info":{"_postman_id":"fa4f143b-3819-4e62-bbb3-49274bd0c140","name":"Autoagent MuniciPay Integrations","description":"

Autoagent has several options available for integration into MuniciPay including:

REST API (more advanced integrations)
\n
Form POST (simpler integrations)
\n

NOTE: If you are looking for our previous documentation for MuniciPay REST v0, you can access it here. While there is no current plan to discontinue support for v0, we recommend any new integrations utilize v1 listed in this document.

In addition, there is a File Uploads and Downloads API for managing billing files and MuniciPay payment files

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7939161","collectionId":"fa4f143b-3819-4e62-bbb3-49274bd0c140","publishedId":"2s8YKAnPmF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2024-07-09T14:57:39.000Z"},"item":[{"name":"REST API","item":[{"name":"Cart","item":[{"name":"Requests","item":[{"name":"Payapp","item":[{"name":"getPaymentResult","id":"d4cc0f70-9c5b-4506-b932-253cc1079810","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{apiUrl}}/payapp/api/v1/carts/{{cartId}}/payments","description":"

Retrieves transaction details for the specified cart.

Request Fields

N/A. cartId provided as a path variable

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description

Defines payload content-type formatting

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"item_number\": \"7abb41f680d9418bb12d1e47b6d5be8c\",\n \"item_selections\": {\n \"2025\": 1\n },\n \"amount\": \"1.00\"\n }\n ]\n}"},"url":"{{apiUrl}}/api/v1/rest/cart/create","description":"

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
items	Required array containing the cartItem to add to the shopping cart.
webhook_url	Optional The URL to POST the successful transactions to. See documentation below.
redirect_url	Optional The URL to redirect the user to after payment is successful. User will be informed of their successful payment and redirected within several seconds to the URL specified. If a redirect_url is provided, no receipt will be shown.
cancel_url	Optional URL that a shopping cart user should be redirected to after canceling a cart

cartItem Array Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
item_number	Required Unique identifier for the item being paid. Must match identifier at Autoagent. This value directly relates to a merchant's bank account that will receive deposits from MuniciPay.
item_selections	Required Object containing the year:installment to apply this payment. If item being paid does not contain a year, pass the current year. If the item does not contain an installment, pass 1.
amount	Required The amount being paid, excluding any special characters or comma formatting.
input_fields	Optional Array containing key:value pairs. If included, these input fields will be associated with the item. These input fields must be communicated to and configured by MuniciPay before they will display. End users and office staff with access to reporting will see these key/values and can opt to display them on receipts. Reserved/Default input_fields: bill_number : String containing any detailed information about the item being paid. Can be a single bill number, comma delimited values, etc. Max length is 500 characters. MuniciPay strongly recommends including a unique bill_number on every request, to ensure customers have a point of reference between an ISVs system and MuniciPay.
custom_fields	Optional Array containing key:value pairs. If included, these fields will be returned in getCartResult() and the paymentSuccess webhook. Merchant & Payer will not see these key/values.

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
status	SUCCESS or REQUEST_FAILED
errors	Array containing strings of issues identified with your request
message	String containing a clear response of your request status
data	Array containing the cartDetails

cartDetails Array Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
cart_id	Unique ID for this cart. Utilize this ID as it relates to any webhook responses.
checkout_link	Unique URL for this cart request. URL will be active for 15 minutes or one use.
total_processed	The number of items received and added to your cart request
items_in_cart	Array containing the items added to your cart
failed_items	Array containing the items that failed to be added to the cart and the reason why.

Defines payload content-type formatting

\n"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"item_number\": \"7abb41f680d9418bb12d1e47b6d5be8c\",\n \"item_selections\": {\n \"2025\": 1\n },\n \"amount\": \"2.10\",\n \"input_fields\": {\n \"bill_number\": \"123456\",\n \"name\": \"John Smith\"\n },\n \"custom_fields\": {\n \"internal_id\": \"abcd\",\n \"unique_id\": \"xyz\"\n }\n },\n {\n \"item_number\": \"985uigf680d9418bb12d1e47b6897gf\",\n \"item_selections\": {\n \"2025\": 1\n },\n \"amount\": \"50.00\",\n \"custom_fields\": {\n \"internal_id\": \"efgh\",\n \"unique_id\": \"zyx\"\n }\n }\n ],\n \"redirect_url\": \"www.autoagent.com/redirect\",\n \"webhook_url\": \"www.autoagent.com/webhook\",\n \"cancel_url\": \"www.autoagent.com/cancel\"\n}"},"url":"{{apiUrl}}/api/v1/rest/cart/create","description":"

Here is a CreateCart that includes multiple items, with both input_fields that will display to the end user, and custom_fields that will only be returned in the JSON data sent to the webhook_url and/or in the getCartResult response.

\n","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"f311d737-24ff-4f1e-a88f-b79dffc6f3c7","id":"f311d737-24ff-4f1e-a88f-b79dffc6f3c7","name":"Requests","type":"folder"}},"urlObject":{"path":["api","v1","rest","cart","create"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e6756b44-d5a3-491d-ad63-65f962f2e652"},{"name":"getCartResult","id":"a0f4118b-1e88-4c0c-b662-b32f649ca4c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{apiUrl}}/api/v1/rest/cart/payments?cart_id=80c44b97569785fcbb27f258a1933929","description":"

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
status_code	Numerical status code
status	Status of the transaction. Options are SUCCESS, REQUEST_FAILED, or VOIDED
message	String containing a clear response of your request status. If voided, the reason for the void is provided.
data	Array containing the paymentData of the transaction

paymentData Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Field
cart_id	Unique ID for this cart. This is the ID provided when you generated the create cart request
billing_amount	The amount charged to the payer. This amount should equal the total of all items in the cart you requested.
billing_service_fee	The amount charged to the payer for service fees. This amount is calculated based on merchant agreements.
confirmation_number	A unique confirmation number generated by Autoagent for each successful transaction.
billing_payee_name	Name of Merchant
billing_transaction_id	Unique ID for authorization
billing_first_name	The first name of the payer
billing_last_name	The last name of the payer
billing_address	The number and street address of the payer
billing_address2	The second address line, ie, apartment, unit, etc
billing_city	The city of the payer
billing_state	The 2 character state abbreviation of the payer
billing_zip	The billing zip code of the payer. Usually 5 or 9 digits if USA
billing_country	The country of the payer
billing_phone	The phone number of the payer.
billing_email	The email address of the payer
billing_timestamp	The time stamp the transaction completed. This is in GMT.
billing_method_name	The payment method utilized of the transaction. Credit Card or eCheck.
billing_last_four	The last four digits of the billing method
items	Array containing the item (key) and amount (value) allocated toward each. The sum of which equals the amount charged to the payer.
item_details	Array containing each item along with more extensive details on each: item_number: Number of Item item_amount: Amount Paid custom_fields: Array provided in createCart input_fields: Array provided in createCart

","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"f311d737-24ff-4f1e-a88f-b79dffc6f3c7","id":"f311d737-24ff-4f1e-a88f-b79dffc6f3c7","name":"Requests","type":"folder"}},"urlObject":{"path":["api","v1","rest","cart","payments"],"host":["{{apiUrl}}"],"query":[{"key":"cart_id","value":"80c44b97569785fcbb27f258a1933929"}],"variable":[]}},"response":[{"id":"ad0e006a-0bc6-4849-a0b9-7ff35c9e0eb4","name":"Successful Transction","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{apiUrl}}/api/v1/rest/cart/payments?cart_id=cf713235e515cf99cc3b3b8b09dbc31e","host":["{{apiUrl}}"],"path":["api","v1","rest","cart","payments"],"query":[{"key":"cart_id","value":"cf713235e515cf99cc3b3b8b09dbc31e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Fri, 28 Oct 2022 20:20:11 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.54 () OpenSSL/1.0.2k-fips PHP/8.1.9"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/8.1.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IjBlVWQvWW80NVdNQllseG53NytMWUE9PSIsInZhbHVlIjoiV24rbGlDR0p2Ti95VDB0dWZ1R1ZkdXQ5QUd3M21YOE9vWjZKdzQvLzRxRDNlSmxWM3gwemZNYUFjMnhGL1lDMThyMXpoRXJuTWI3OU5USW5qK2ZsKzVYcHRidjZKcHNLalE4YW85UUpmT1ZVUmwrVXNDamgxNUdGQnd0TXJ6RHYiLCJtYWMiOiJjOGE2ZGNhOTQ1ODlhNDA3OWExOGI3NTY2MDUyMTNhMjVmNGQ0ZTg4ODhkNDBjYjk1YTQ0N2E0YWUxNjZmMWVjIiwidGFnIjoiIn0%3D; expires=Fri, 28-Oct-2022 22:20:11 GMT; Max-Age=7200; path=/; domain=.govpayments.dev"},{"key":"Set-Cookie","value":"autoagent_ipayments_joe_session=eyJpdiI6InVzNkEzbS9IT25XVkNGdmRkSjN6VEE9PSIsInZhbHVlIjoicGl5ZC9MSk9OZFE2Um5kUU5VeW5CS0k3Z2dJeWtmVmw3bkpoaHE1Tnd5TFFWNGhiZWZQVTJVV2E0Z1NvSmJVY3BlUHo2VFA0ZnFwdDBVTEtBTzFwS1FxRmJsS0F3MGthekF6OXBIYWlkNjArTlJJMmZLbVlhVGFDK1EvZFZpV0ciLCJtYWMiOiI1MGU4ZWY4YTFkMjA4MzYwNjUwZTNlZDBlMGQ0YjUyZjEyMjVmOTViYTcxOGE5MjMwNjgzYTAwMjZiYzM5YThkIiwidGFnIjoiIn0%3D; expires=Fri, 28-Oct-2022 22:20:11 GMT; Max-Age=7200; path=/; domain=.govpayments.dev; httponly"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": \"200\",\n \"message\": \"SUCCESS\",\n \"status\": \"Payment completed successfully.\",\n \"data\": {\n \"cart_id\": \"781b89746a9aea9ea738634c54a2649f\",\n \"items_paid\": 1,\n \"billing_amount\": \"1005.50\",\n \"billing_service_fee\": \"26.64\",\n \"confirmation_number\": \"LFU3GFS9LR\",\n \"billing_first_name\": \"John\",\n \"billing_last_name\": \"Smith\",\n \"billing_address\": \"123 Anywhere\",\n \"billing_address2\": \"\",\n \"billing_city\": \"Test\",\n \"billing_state\": \"CA\",\n \"billing_zip\": \"12345\",\n \"billing_country\": \"US\",\n \"billing_phone\": \"(201) 444-3333\",\n \"billing_email\": \"test@test.com\",\n \"billing_timestamp\": \"2022-11-04T14:04:18.000000Z\",\n \"billing_method_name\": \"Credit Card\",\n \"items\": [\n {\n \"1001000071\": \"1005.50\"\n }\n ],\n \"item_details\": [\n {\n \"item_number\": \"1001000071\",\n \"item_amount\": \"1005.50\",\n \"custom_fields\": {\n \"custom1\": \"value\",\n \"custom2\": \"value2\",\n \"custom3\": \"value3\"\n },\n \"input_fields\": {\n \"bill_number\": \"12345\",\n \"input1\": \"value1\",\n \"input2\": \"value2\"\n }\n }\n ]\n }\n}"},{"id":"54ff0c71-78c6-4e40-8461-5e5f935d82e4","name":"Voided","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{apiUrl}}/api/v1/rest/cart/payments?cart_id=2dcd36de0c234d62bc1bee7778af07e7","host":["{{apiUrl}}"],"path":["api","v1","rest","cart","payments"],"query":[{"key":"cart_id","value":"2dcd36de0c234d62bc1bee7778af07e7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Nov 2022 13:43:47 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.54 () OpenSSL/1.0.2k-fips PHP/8.1.9"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"X-Powered-By","value":"PHP/8.1.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IitKaVdEUXl0M0M3eDcvWnpNTnpSTGc9PSIsInZhbHVlIjoiYnlmTi85K0lRRERKdXJsVDFDTnE0aDFIZTNKdFdsZDdxODdBTDd1SVR2Q0UwNHNRbm1xMzRVNmVRT1ZyQkZGdUlJeGpvV0xPdzhxMEpEaWxlbHBad2FLK28wVWE0cUkzdUJ0QUhUQWxVbVVPVGx5VHpRcFB5Q3FpMTZxOC9IM1QiLCJtYWMiOiIyNjdkMzU2OGY1MGRjZGFkMWY1N2NiYjBlZGI4YmE2NDI4NTk1ZDFkZTVhNDM0NmMxYzI0ZGM4ODFhNjhmZmY0IiwidGFnIjoiIn0%3D; expires=Fri, 04-Nov-2022 15:43:47 GMT; Max-Age=7200; path=/; domain=.govpayments.dev"},{"key":"Set-Cookie","value":"autoagent_ipayments_joe_session=eyJpdiI6Im5VQ1BUMVhyN2ZoNEZzcWU0dGl5eGc9PSIsInZhbHVlIjoiUXlIc3djK21udGZYaGZEbDRNaEtISlk5SXMyL3BVQlBjWjhLZnY1SkZRYkFZRlVoenhCVW1sTDFpZndPY0VTMHJUdk9DanFuRlJaeUdaa216Vkx6SVgwUS9yS2NKTGk4RVZPbkZkZ09qWmJScldBYjVuQnZ0U1hqOFUyVlpkRUsiLCJtYWMiOiI3YWJjZTZjMjg0MTg2NGViNzRiYTVlNzMyZTU1OWQ0ZDFmMGU4MGViY2UzNjI0ZTFhYjE4ZDg4YjkwMTQyN2I2IiwidGFnIjoiIn0%3D; expires=Fri, 04-Nov-2022 15:43:47 GMT; Max-Age=7200; path=/; domain=.govpayments.dev; httponly"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": \"200\",\n \"message\": \"VOIDED\",\n \"status\": \"Payment Reversed: Test\",\n \"data\": {\n \"cart_id\": \"2dcd36de0c234d62bc1bee7778af07e7\",\n \"items_paid\": 1,\n \"billing_amount\": \"1005.50\",\n \"billing_service_fee\": \"26.64\",\n \"confirmation_number\": \"BTYSHNXAFR\",\n \"billing_first_name\": \"John\",\n \"billing_last_name\": \"Smith\",\n \"billing_address\": \"123 Anywhere\",\n \"billing_address2\": \"\",\n \"billing_city\": \"Test\",\n \"billing_state\": \"AZ\",\n \"billing_zip\": \"12345\",\n \"billing_country\": \"US\",\n \"billing_phone\": \"(201) 444-3333\",\n \"billing_email\": \"test@test.com\",\n \"billing_timestamp\": \"2022-11-04T13:41:46.000000Z\",\n \"billing_method_name\": \"Credit Card\"\n }\n}"},{"id":"8b73f02a-cbe8-405a-b389-d4002e0608bc","name":"Fail","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{apiUrl}}/api/v1/rest/cart/payments?cart_id=80c44b97569785fcbb27f258a1933929","host":["{{apiUrl}}"],"path":["api","v1","rest","cart","payments"],"query":[{"key":"cart_id","value":"80c44b97569785fcbb27f258a1933929"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Nov 2022 15:37:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.54 () OpenSSL/1.0.2k-fips PHP/8.1.9"},{"key":"Vary","value":"Authorization"},{"key":"Upgrade","value":"h2,h2c"},{"key":"X-Powered-By","value":"PHP/8.1.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IlFMN1RRK1RINzhWM2RKTUh0eGtJREE9PSIsInZhbHVlIjoicXpIb04rRGcwd0s5TlA1RWc3OGU2R2Q5Vm1BdzZKVGZsTG8vcitTbzZNZm53TndFeHFwZGFXL3FFOE9HdXErUmxNZTB4MHpBRVR0YXZjTzkwYTBjNEx5cmNrV2twYTVObDczdkdEZUpnVDh0WEZEc0RVeGJrcm5MQ3RYMGNzSlEiLCJtYWMiOiI4YmJjY2VmZTJhNTQ3MDY4OTdjNWYxYTFkZDYyZDBiOTE4YTRhZmU5YjczMjc5NzNlNGU3NjhmYzM3NTI5MWYyIiwidGFnIjoiIn0%3D; expires=Thu, 03-Nov-2022 17:37:44 GMT; Max-Age=7200; path=/; domain=.govpayments.dev"},{"key":"Set-Cookie","value":"autoagent_ipayments_joe_session=eyJpdiI6Ii80bzY0SWlKOUxtZHRZSC9vUFVXclE9PSIsInZhbHVlIjoiREx6ZlY3dVV6NlZtRDlFMmV5eDYrZTRlZmJtQmdGdE9WQ2t1clVua3EvU2N2TXp0M2h5QVVQaUlpVGNoajFkbzFqREl1NDR4ejJMdnBHY0VKcFd5bnJwd0o1VXdBSTRCajNlSWxBTUNndjR0Y2l2V2g0YmV3K05CNnNFZ2J3eGIiLCJtYWMiOiI5NDc5ZDIyNzQ0YTRhMzFkNGZjZjQzNzMxMTJhYWU3NzQ0OTM2ZjdkZDM4YmM5ODNlM2I4MTQ4YmRkNjA1OWQ4IiwidGFnIjoiIn0%3D; expires=Thu, 03-Nov-2022 17:37:44 GMT; Max-Age=7200; path=/; domain=.govpayments.dev; httponly"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": \"404\",\n \"message\": \"REQUEST_FAILED\",\n \"status\": \"Payment not found.\",\n \"data\": {\n \"cart_id\": \"80c44b97569785fcbb27f258a1933929\"\n }\n}"}],"_postman_id":"a0f4118b-1e88-4c0c-b662-b32f649ca4c7"},{"name":"voidCart","id":"b7c98b04-ffe3-407a-9d0c-9d1c04a06f3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{apiUrl}}/api/v1/rest/cart/void?cart_id=80c44b97569785fcbb27f258a1933929","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"f311d737-24ff-4f1e-a88f-b79dffc6f3c7","id":"f311d737-24ff-4f1e-a88f-b79dffc6f3c7","name":"Requests","type":"folder"}},"urlObject":{"path":["api","v1","rest","cart","void"],"host":["{{apiUrl}}"],"query":[{"key":"cart_id","value":"80c44b97569785fcbb27f258a1933929"}],"variable":[]}},"response":[],"_postman_id":"b7c98b04-ffe3-407a-9d0c-9d1c04a06f3a"},{"name":"cancelCart","id":"1ed226c4-9189-4e77-8c35-a4bbf1ea5297","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{apiUrl}}/api/v1/rest/cart/cancel?cart_id=80c44b97569785fcbb27f258a1933929","description":"

Created carts are valid for 15 minutes or single use. Use this method to cancel a created cart immediately.

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
cart_id	Unique ID for this cart. Utilize this ID as it relates to any webhook responses.

Unique ID for this cart. Utilize this ID as it relates to any webhook responses.

\n","type":"text/plain"},"key":"cart_id","value":"80c44b97569785fcbb27f258a1933929"}],"variable":[]}},"response":[{"id":"cf193d15-c16d-480c-a013-ca5219ccd61d","name":"Success","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{apiUrl}/api/v1/rest/cart/cancel?cart_id=d6c9fa2ce46ae59423c08f375a6021ac","host":["{apiUrl}"],"path":["api","v1","rest","cart","cancel"],"query":[{"key":"cart_id","value":"d6c9fa2ce46ae59423c08f375a6021ac","description":"Unique ID for this cart. Utilize this ID as it relates to any webhook responses."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Nov 2022 15:38:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.54 () OpenSSL/1.0.2k-fips PHP/8.1.9"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/8.1.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6ImlYTGFFeWZPamJUUW1UZUM1aFd5OUE9PSIsInZhbHVlIjoiT3RTa3U4cHE2bEo2MXoySjZKYUMrRXpJanlnOENtTGFVdHdqaUlYcUtLOFpuY1kzd1VaMDdsVzVPSHRtU3E2MzN4M3VPRDZiVlZqS3RhUmFUWS92MXlxYzB2ZkNOTEl1clc4MThJNlVHZmJvVjNuaEhqMEQ4Wm9WZGc5Mjd6Y20iLCJtYWMiOiI4NzYxYjdmNDk2Y2ZiYTU2YTM3OTQzOTgzNTE3OTZkODg2NTYyY2Y3NWI1MmU0NGVhOTIzYmI5NDBiZjQ0ZGQ5IiwidGFnIjoiIn0%3D; expires=Thu, 03-Nov-2022 17:38:38 GMT; Max-Age=7200; path=/; domain=.govpayments.dev"},{"key":"Set-Cookie","value":"autoagent_ipayments_joe_session=eyJpdiI6IllsNk51ZENxdllxWUQ2M1gzdldtaUE9PSIsInZhbHVlIjoieC9BWGFldEE5NDlZcnpnckR5QnFXK2tibzlHTnFRb3YxbndPc1cvQThESDhqeFRRUktFNnY3aHdHSHVWUUlkZG9KUWRxMzJvYUhtUDBxZnh6NHFqdmwzTVZ5OFdyWVNOWUIvRitaODVrUGJGUDdQTDNERlQxU05oLzZsZUF4MEwiLCJtYWMiOiJhZWFjZmUwYzQ2NGVhZTA5MWRmMjUwYjVlNDYzNDcxNzBkMzVlY2RkOGJmYjE3NWY0MjAzOWMzYWI0NjNhYzNiIiwidGFnIjoiIn0%3D; expires=Thu, 03-Nov-2022 17:38:38 GMT; Max-Age=7200; path=/; domain=.govpayments.dev; httponly"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"status_code\": \"200\",\n \"message\": \"Cart has been cancelled.\"\n}"},{"id":"7f3a8eb2-bec2-43d0-b5d3-9b4da144ac3b","name":"Fail","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{apiUrl}}/api/v1/rest/cart/cancel?cart_id=973543087a2d71808a873c19d338685f","host":["{{apiUrl}}"],"path":["api","v1","rest","cart","cancel"],"query":[{"key":"cart_id","value":"973543087a2d71808a873c19d338685f","description":"Unique ID for this cart. Utilize this ID as it relates to any webhook responses."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Nov 2022 15:39:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.54 () OpenSSL/1.0.2k-fips PHP/8.1.9"},{"key":"Vary","value":"Authorization"},{"key":"X-Powered-By","value":"PHP/8.1.9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Set-Cookie","value":"XSRF-TOKEN=eyJpdiI6IlFsU2UzcFBtZjk2eXdjWHgwalpsYmc9PSIsInZhbHVlIjoiRmdyRU91d3k2S1A0UzdpcVYrZjJaTGNJOTRneklCTnVTN3FuR0I2TzluYlhtcG5jV3N4OFBSTWR4VGNYK3pPQkpLS3NSdk1WVG5NSzF6UTBTc2hsMWo4ZW1RNEFGYUtlbHJPVEdUSzhiWlplc1daVndySFNWdFRPRDEvQklBdUIiLCJtYWMiOiI1YTc5ZWM1ZTliY2Y3MWRhOTAyZTJlOThmOTkzMDc4MjRhZDE1MDQzZDFlZmFmNjZlMTk2NTJjMWFmYTRiOWVhIiwidGFnIjoiIn0%3D; expires=Thu, 03-Nov-2022 17:39:00 GMT; Max-Age=7200; path=/; domain=.govpayments.dev"},{"key":"Set-Cookie","value":"autoagent_ipayments_joe_session=eyJpdiI6IlJqdG9FS2N5SWc1TklIenBWV0pSNWc9PSIsInZhbHVlIjoiRWFySFJaSmpVanpuajZ1ajdERDd4ZlhvZzg1UGh3STc0NUtmUmYwa0tnNEpSQmFYT0tIRnJrYzVhTDlDTnpMdmh1YVhvaG9YQ1N4V3Z4VWlPYnhEVUJMbWZVZlRJMThOejFweTByQjF4M3BKZ2ovTkhkd2g4eG9oTVFPU29xbFoiLCJtYWMiOiJjZWNmYzQ0MWJkYzhmMjc5ZTU3ZTg0ZDJmYWVmYmI2ZGVjMDA0ZDA5ZTJlYjM1YjdjM2M2MGI1YmMxOWE3ZWNmIiwidGFnIjoiIn0%3D; expires=Thu, 03-Nov-2022 17:39:00 GMT; Max-Age=7200; path=/; domain=.govpayments.dev; httponly"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"REQUEST_FAILED\",\n \"status_code\": \"404\",\n \"message\": \"Active cart not found\"\n}"}],"_postman_id":"1ed226c4-9189-4e77-8c35-a4bbf1ea5297"}],"id":"f311d737-24ff-4f1e-a88f-b79dffc6f3c7","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"df08288a-7549-4a87-8c84-9f827ed2cf32","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eaae38a1-4667-4adb-b6f0-c56d5bb21b1e","type":"text/javascript","exec":[""]}}],"_postman_id":"f311d737-24ff-4f1e-a88f-b79dffc6f3c7","description":""},{"name":"Webhooks","item":[{"name":"paymentSuccess","id":"245feb6f-57c9-47b2-a1dc-3a16a8b33971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status_code\": \"200\",\n \"message\": \"SUCCESS\",\n \"status\": \"Payment completed successfully.\",\n \"data\": {\n \"cart_id\": \"781b89746a9aea9ea738634c54a2649f\",\n \"items_paid\": 1,\n \"billing_amount\": \"1005.50\",\n \"billing_service_fee\": \"26.64\",\n \"confirmation_number\": \"LFU3GFS9LR\",\n \"billing_first_name\": \"John\",\n \"billing_last_name\": \"Smith\",\n \"billing_address\": \"123 Anywhere\",\n \"billing_address2\": \"\",\n \"billing_city\": \"Test\",\n \"billing_state\": \"CA\",\n \"billing_zip\": \"12345\",\n \"billing_country\": \"US\",\n \"billing_phone\": \"(201) 444-3333\",\n \"billing_email\": \"test@test.com\",\n \"billing_timestamp\": \"2022-11-04T14:04:18.000000Z\",\n \"billing_method_name\": \"Credit Card\",\n \"items\": [\n {\n \"1001000071\": \"1005.50\"\n }\n ],\n \"item_details\": [\n {\n \"item_number\": \"1001000071\",\n \"item_amount\": \"1005.50\",\n \"custom_fields\": {\n \"custom1\": \"value\",\n \"custom2\": \"value2\",\n \"custom3\": \"value3\"\n },\n \"input_fields\": {\n \"bill_number\": \"12345\",\n \"input1\": \"value1\",\n \"input2\": \"value2\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

If a webhook_url parameter is provided in the initial cart/create, a POST is made when a successful transaction occurs.

The request expects the response of success along with an HTTP 200 status. If either of those fail, a second attempt will be made. If the second attempt fails, the transaction will be VOIDED and the payer will receive an error on screen that their payment can not be completed.

Webhook response contains the same result set as the getCartResult method.

A brief guide on testing the webhook functionality can be found here.

\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"245feb6f-57c9-47b2-a1dc-3a16a8b33971"}],"id":"f5ed7bcf-0506-4314-b236-1ba7d5fc3300","description":"

The following webhooks are available when certain events occur on MuniciPay.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4c06b21e-a4b5-4820-8d1f-5c9c3bbd59e6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ff84b9a7-7438-4175-a4a0-6dd46ec265c4","type":"text/javascript","exec":[""]}}],"_postman_id":"f5ed7bcf-0506-4314-b236-1ba7d5fc3300"}],"id":"110e2926-8559-415a-9beb-979c407a65de","description":"

Creates a custom shopping cart containing 1 or more items to be paid. Responses are generated containing payment details. An optional webhook_url and redirect_url can be initiated following successful transactions.

Below you will find examples of a the bare minimum required to create a cart (simple) as well as a request making use of each of the optional components (complex). Feel free to reach out to integrations@autoagent.com for advise on how to use these optional components to best fit your use case.

Test Payment Methods for Staging Environment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Credit Card	Expiration	CVV2
4111 1111 1111 1111	06/2029	321

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ACH Type	Routing Number	Account Number
Checking	490000018	123123123

","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"26820846-8eb3-4fbe-8e8d-3011e4e45d49","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8c631eb7-6ed3-4c82-98cd-dba530649825","type":"text/javascript","exec":[""]}}],"_postman_id":"110e2926-8559-415a-9beb-979c407a65de"},{"name":"Run Payment","item":[{"name":"Requests","item":[{"name":"Autopay","item":[{"name":"authorizeAutopay","id":"2fbc25d1-0cfb-4336-8a20-87f63a0b337b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"ref_id\": \"123\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"address1\": \"123 Test dr\",\n \"address2\": \"\",\n \"city\": \"Miami\",\n \"state\": \"FL\",\n \"zip\": \"33160\",\n \"country\": \"US\",\n \"phone\": \"9548888888\",\n \"phone_country\": \"US\"\n },\n \"items\": [\n {\n \"item_display_title\": \"787878-0 Billing Group 3\",\n \"item_number\": \"AB123456\",\n \"item_type\": \"M2\",\n \"item_selections\": {\n \"2024\": 1\n },\n \"amount\": \"10.99\",\n \"custom_fields\": {\n \"AccountNumber\": \"787878-0\",\n \"AccountCustomerID\": 313131,\n \"BillingGroupID\": 3\n },\n \"due_date\": \"2026-02-25\",\n \"autopay_enrolled_webhook_url\": \"http://somewebhookurl1.com\",\n \"autopay_cancelled_webhook_url\": \"http://somewebhookurl2.com\",\n \"payment_success_webhook_url\": \"http://somewebhookur3.com\"\n },\n {\n \"item_display_title\": \"767676-0 Billing Group 3\",\n \"item_number\": \"AB123456\",\n \"item_type\": \"M2\",\n \"item_selections\": {\n \"2024\": 1\n },\n \"amount\": \"50.62\",\n \"custom_fields\": {\n \"AccountNumber\": \"767676-0\",\n \"AccountCustomerID\": 313131,\n \"BillingGroupID\": 3\n },\n \"input_fields\": {\n \"bill_number\": \"1hhgy312476v54\"\n },\n \"autopay_enrolled_webhook_url\": \"http://somewebhookurl.com\",\n \"autopay_cancelled_webhook_url\": \"http://somewebhookurl2.com\",\n \"payment_success_webhook_url\": \"http://somewebhookur3.com\"\n }\n \n ],\n \"redirect_url\": \"http://somewebhookur4.com\",\n \"cancel_url\": \"http://somewebhookur5.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/api/v1/autopay/authorize","description":"

Note: This endpoint will be available Q1/2026

Provides a one-time link which will sign a user into MuniciPay. The user will then be able to add wallets and enroll in autopay for items passed in the request body.

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
items Array of CartItem objects	Required. An array of CartItem objects to display to the user in the Autopay management page. The user can choose to enroll one or more items in Autopay, or cancel Autopay for existing enrollments.
user User Object	Required. A User object representing the user who will be accessing autopay management page.
redirect_url String	Required. The url to redirect to after the user finishes their action

CartItem fields used by this endpoint

Note: For detailed field descriptions, refer to the CartItem object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Requirements
enrollment_id integer	Required if the item is already enrolled in Autopay.
item_number string	Required
item_display_title string	Optional/Recommended. If omitted, the UI will fall back to item_number. This field is for display only.
item_type string	Required
item_selections object	Required
amount string	Required if due_date is provided.
due_date string	Required if amount_is provided.
custom_fields object	Optional
autopay_enrolled_webhook_url string	Required
autopay_cancelled_webhook_url string	Required
payment_success_webhook_url string	Required

User fields used by this endpoint

Note: For detailed field descriptions, refer to the User object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Requirements
ref_id	Required
first_name	Required
last_name	Required
email	Optional
address1	Optional
address2	Optional
city	Optional
state	Optional
zip	Optional
country	Optional
phone	Optional
phone_country	Optional

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
status string	SUCCESS or REQUEST_FAILED
errors array	Array containing strings of issues identified with your request
message string	String containing a clear response of your request status
data LoginDetails.*	A LoginDetails object (described below)

LoginDetails Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
login_link string	Unique, one-time link which sends the user to the MuniciPay Autopay enrollment page
token_id integer	A unique ID for this request for debugging purposes
ref_id User.ref_id	A unique internal identifier in your system for the user the one-time link was generated for.

Note: This endpoint will be available Q1/2026

Cancel Autopay enrollment and delete all payments for a given enrollment.

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
ref_id User.ref_id	Optional. A unique internal identifier assigned to the user in your system, used to cancel that user’s autopayment enrollment.
enrollment_id CartItem.enrollment_id	Required. Unique identifier of the Autopay enrollment being canceled.

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
status string	SUCCESS or REQUEST_FAILED
errors array	Array containing strings of issues identified with your request
message string	String containing a clear response of your request status
data AutomatedItem.*	An AutomatedItem object (described below)

AutomatedItem Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
enrollment_id CartItem.enrollment_id	The unique identifier of the Autopay enrollment that was canceled.

Note: This endpoint will be available Q1/2026

Update payments for an existing Autopay enrollments.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
enrollments array	Required. List of enrollment objects. Maximum enrollments per batch is 500 (requests may take up to 30 seconds). Recommended batch size is 100–250 enrollments.

Enrollment Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
ref_id User.ref_id	Optional. A unique internal identifier assigned to the user in your system whose profile details are being updated.
enrollment_id CartItem.enrollment_id	Required. The unique enrollment identifier associated with the Autopay enrollment being updated.
amount CartItem.amount	Required. The next payment amount , excluding any special characters or comma formatting.
due_date CartItem.due_date	Required. Next due date provided in the the format YYYY-MM-DD

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
status string	SUCCESS or PARTIAL_SUCCESS or REQUEST_FAILED
errors array	Array containing strings of issues identified with your request
message string	String containing a clear response of your request status
data EnrollmentsUpdateDetails.*	A EnrollmentsUpdateDetails object (described below)

EnrollmentsUpdateDetails Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
failed_enrollments array	List of enrollment IDs that failed to update. An empty list indicates that all enrollments were updated successfully.

Autopay endpoints for managing a user’s automatic payment enrollments.

\n","_postman_id":"d3be7244-fb6d-42ed-ab0d-1c6c5b3430e8","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}},{"name":"Profile","item":[{"name":"Wallet","item":[{"name":"authorizeAddWallet","id":"a31f3644-bf89-4f51-b036-bbfafc595d76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"ref_id\": {{ref_id}},\n \"email\": \"{{email}}\",\n \"first_name\": \"{{first_name}}\",\n \"last_name\": \"{{last_name}}\",\n \"address1\": \"{{address1}}\",\n \"address2\": \"{{address2}}\",\n \"city\": \"{{city}}\",\n \"state\": \"{{state}}\",\n \"zip\": \"{{zip}}\",\n \"country\": \"{{country}}\",\n \"phone\": \"{{phone}}\",\n \"phone_country\": \"{{phone_country}}\"\n },\n \"redirect_url\": \"{{redirect_url}}\",\n \"cancel_url\": \"{{cancel_url}}\",\n \"webhook_url\": \"{{wallet_added_webhook_url}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/api/v1/profile/wallet/authorize","description":"

Note: This endpoint will be available Q1/2026

Provide a user and an action to receive a one-time link which will sign a user into MuniciPay. The user will then be able to add wallets to be used in later API calls to run payments.

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
user User object	Required. A User object representing the user who will be adding wallets on MuniciPay. Importnent: all fields from User object are required.
redirect_url string	Required. The url to redirect to after the user finishes their action.
cancel_url string	Required. The url to redirect to if the user decides to cancel their action.
webhook_url string	Required. Webhook URL to receive notification when a user adds a payment method to their wallet.

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
status string	SUCCESS or REQUEST_FAILED
errors array	Array containing strings of issues identified with your request
message string	String containing a clear response of your request status
data LoginDetails.*	A LoginDetails object (described below)

LoginDetails Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
login_link string	Unique, one-time link for this action request.
token_id integer	A unique ID for this request for debugging purposes.
ref_id User.ref_id	A unique internal integer identifier in your system for the user the one-time link was generated for.

Wallet endpoints for managing a user’s tokenized payment methods.

\n","_postman_id":"b3b75e11-4355-41d8-8859-e344173001a2","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}},{"name":"updateUserProfile","id":"ce26f09a-9312-4daf-90b4-b9f640f5910e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"ref_id\": {{ref_id}},\n \"first_name\": \"{{first_name}}\",\n \"last_name\": \"{{last_name}}\",\n \"address1\": \"{{address1}}\",\n \"address2\": \"{{address2}}\",\n \"city\": \"{{city}}\",\n \"state\": \"{{state}}\",\n \"zip\": \"{{zip}}\",\n \"country\": \"{{country}}\",\n \"phone\": \"{{phone}}\",\n \"phone_country\": \"{{phone_country}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/api/v1/profile/update","description":"

Note: This endpoint will be available Q1/2026

Update existing Autopay enrollment by a new payment.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
ref_id User.ref_id	Required. A unique internal identifier assigned to the user in your system whose profile details are being updated.
Any fields from a User object you wish to update	At least 1 field is required

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
status string	SUCCESS or REQUEST_FAILED
errors array	Array containing strings of issues identified with your request.
message string	String containing a clear response of your request status.
data User.*	All User object fields containig updated user profile details.

Profile endpoints for managing user-related details.

\n","_postman_id":"6f393209-00ba-4d5a-bfa9-fe46d44cfd81","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}},{"name":"Payment","item":[{"name":"runPayment","id":"b8185353-6b21-46c7-beae-9f673700dfb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"item_number\": \"{{item_number}}\",\n \"item_selections\": {\n \"{{item_year}}\": {{item_installment}}\n },\n \"amount\": \"{{item_amount}}\",\n \"input_fields\": {\n \"bill_number\": \"{{bill_number}}\"\n },\n \"custom_fields\": {}\n }\n ],\n \"payment_token\": \"{{payment_token}}\",\n \"run_date\": \"{{run_date}}\",\n \"is_suppress_receipt\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/api/v1/transaction/run","description":"

Run a transaction using a payment token created by a user

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
items Array of CartItem objects	Required. Array containing one or many CartItem objects to run a payment on
payment_token	Required a token received by the walletAdded webhook
is_suppress_receipt	Optional when true, does not email a receipt to the user the payment is being run for. Defaults to false
webhook_url	Optional a url to post to when the payment is run. Details on what is sent in this webhook can be found in the Webhooks/paymentCompleted documentation

CartItem Object Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
item_number	Required Unique identifier for the item being paid. Must match identifier at Autoagent. This value directly relates to a merchant's bank account that will receive deposits from MuniciPay.
item_selections	Required Object containing the year:installment to apply this payment. If item being paid does not contain a year, pass the current year. If the item does not contain an installment, pass 1.
amount	Required The amount being paid, excluding any special characters or comma formatting.
input_fields	Optional Array containing key:value pairs. If included, these input fields will be associated with the item. These input fields must be communicated to and configured by MuniciPay before they will display. Reserved/Default input_fields: bill_number : String containing any detailed information about the item being paid. Can be a single bill number, coma delimited values, etc. Max length is 500 characters. MuniciPay strongly reccomends including a unique bill_number on every request, to ensure you have a point of reference between your system and MuniciPay.
custom_fields	Optional Array containing key:value pairs. If included, these fields will be returned in the paymentCompleted webhook.

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
status	SUCCESS or REQUEST_FAILED
errors	Array containing strings of issues identified with your request
message	String containing a clear response of your request status
data	A paymentDetails object

paymentDetails Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
ind_checkout_id	Unique ID for this payment
confirmation	A ten-character alphanumeric confirmation number to reference if you need to contact support about a payment
timestamp_gmt	The timestamp when the payment was run, in GMT
batch_date	The date when the payment was run for merchant funding purposes, in YYYY-MM-DD format. In other words, will be the timestamp_gmt converted to the timezone of the merchant
amount	The total amount charged for all items in the payment
fee_amount	The fee charged for this payment
last_four	The last four of the bank account or card run in this payment
first_name	The first name of the user this payment was run for
last_name	The last name of the user this payment was run for
items	an array of paymentItem objects

paymentItem Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
item_id	Unique ID for this payment item
item_number	The item number passed in the original request
item_type	The item type passed in the original request
amount	The amount passed in the original request
input_fields	The input_fields included in the original request
custom_fields	The custom_fields included in the original request

","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}},"urlObject":{"path":["api","v1","transaction","run"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8185353-6b21-46c7-beae-9f673700dfb0"}],"id":"45c9402e-26c6-4fd1-83a0-19e93d19d55b","_postman_id":"45c9402e-26c6-4fd1-83a0-19e93d19d55b","description":"","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}}],"id":"d5fc1732-dd38-4172-89b8-928734734b53","_postman_id":"d5fc1732-dd38-4172-89b8-928734734b53","description":"","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}},{"name":"Webhooks","item":[{"name":"Autopay","item":[{"name":"autopayEnrolled","id":"99853ff0-07f4-441e-adb2-e80f49f91ac3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user\": {\n \"ref_id\": {{ref_id}},\n \"email\": \"{{email}}\",\n \"first_name\": \"{{first_name}}\",\n \"last_name\": \"{{last_name}}\",\n \"address1\": \"{{address1}}\",\n \"address2\": \"{{address2}}\",\n \"city\": \"{{city}}\",\n \"state\": \"{{state}}\",\n \"zip\": \"{{zip}}\",\n \"country\": \"{{country}}\",\n \"phone\": \"{{phone}}\",\n \"phone_country\": \"{{phone_country}}\"\n },\n \"item\": {\n \"item_number\": \"{{item_number}}\",\n \"item_selections\": {\n \"{{item_year}}\": {{item_installment}}\n },\n \"amount\": \"{{item_amount}}\",\n \"input_fields\": {\n \"bill_number\": \"{{bill_number}}\"\n },\n \"custom_fields\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{autopay_enrolled_webhook_url}}","description":"

Note: This webhook will be available Q1/2026

This webhook is sent when a user enrolls in Autopay

request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
user	The user object included in the original autorizeAction request. Represents the user which enrolled in Autopay
item	A cartItem passed in the original autorizeAutopayEnroll request

Note: This webhook will be available Q1/2026

This webhook is sent when a user cancels an Autopay enrollment

request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
user	The user object included in the original autorizeAction request. Represents the user which enrolled in Autopay
item	A cartItem passed in the original autorizeAutopayEnroll request

","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}},"urlObject":{"host":["{{autopay_cancelled_webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c6a5c14-4ef2-44df-980e-2c2924f5a6e0"}],"id":"dbcae612-d939-4265-92fd-bf3465e44d65","_postman_id":"dbcae612-d939-4265-92fd-bf3465e44d65","description":"","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}},{"name":"Profile","item":[{"name":"walletAdded","id":"44976669-27f5-44bf-81f7-adfd1d9688d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"payment_token\": \"78291A47-5862-4518-BF9F-D69B3258BC64\",\n \"payment_type\": \"Credit / Debit\",\n \"payment_type_id\": \"CR\",\n \"card_type\": \"VISA\",\n \"user\": {\n \"ref_id\": {{ref_id}},\n \"email\": \"{{email}}\",\n \"first_name\": \"{{first_name}}\",\n \"last_name\": \"{{last_name}}\",\n \"address1\": \"{{address1}}\",\n \"address2\": \"{{address2}}\",\n \"city\": \"{{city}}\",\n \"state\": \"{{state}}\",\n \"zip\": \"{{zip}}\",\n \"country\": \"{{country}}\",\n \"phone\": \"{{phone}}\",\n \"phone_country\": \"{{phone_country}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{wallet_added_webhook_url}}","description":"

Note: This webhook will be available Q1/2026

This webhook is sent whenever a user adds a new wallet

request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
payment_token	Unique UUID string used in future requests for running payment on this wallet
payment_type	One of the following: E-Check, Credit / Debit
payment_type_id	One of the following: EC, CR (E-Check and Credit / Debit, respectively)
card_type	One of the following: Checking, Savings, MASTERCARD, VISA, AMEX, DISCOVER
last_four	The last four digits of either the card number or the bank account number
nickname	The nickname the user chose for this wallet
user	The user object sent in the original request

","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}},"urlObject":{"host":["{{wallet_added_webhook_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"44976669-27f5-44bf-81f7-adfd1d9688d9"}],"id":"38929ea4-b7bf-4998-a1bc-4e47d32775cf","_postman_id":"38929ea4-b7bf-4998-a1bc-4e47d32775cf","description":"","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}},{"name":"Payment","item":[{"name":"paymentSuccess","id":"571c62c4-14a8-4e99-9c0a-921287410d7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status_code\": \"200\",\n \"message\": \"SUCCESS\",\n \"status\": \"Payment completed successfully.\",\n \"data\": {\n \"cart_id\": \"781b89746a9aea9ea738634c54a2649f\",\n \"items_paid\": 1,\n \"billing_amount\": \"{{item_amount}}\",\n \"billing_service_fee\": \"3.00\",\n \"confirmation_number\": \"LFU3GFS9LR\",\n \"billing_first_name\": \"{{first_name}}\",\n \"billing_last_name\": \"{{last_name}}\",\n \"billing_address\": \"{{address1}}\",\n \"billing_address2\": \"{{address2}}\",\n \"billing_city\": \"{{city}}\",\n \"billing_state\": \"{{state}}\",\n \"billing_zip\": \"{{zip}}\",\n \"billing_country\": \"{{country}}\",\n \"billing_phone\": \"{{phone}}\",\n \"billing_email\": \"{{email}}\",\n \"billing_timestamp\": \"2025-11-04T14:04:18.000000Z\",\n \"billing_method_name\": \"Credit Card\",\n \"items\": [\n {\n \"{{item_number}}\": \"{{item_amount}}\"\n }\n ],\n \"item_details\": [\n {\n \"item_number\": \"{{item_number}}\",\n \"item_amount\": \"{{item_amount}}\",\n \"custom_fields\": {},\n \"input_fields\": {\n \"bill_number\": \"{{bill_number}}\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{payment_success_webhook_url}}","description":"

If a webhook_url parameter is provided in the initial cart/create, a POST is made when a successful transaction occurs. In addition, a POST is also made when a scheduled payment or autopay is successful.

Webhook response contains the same result set as the getCartResult method.

A brief guide on testing the webhook functionality can be found here.

Note: This webhook will be available Q1/2026

\n","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"b121f895-ded9-4eb1-ab35-ae0fd4ead6f8"}],"id":"e73ab2be-cbec-4e91-90c1-6daafc9a6fed","_postman_id":"e73ab2be-cbec-4e91-90c1-6daafc9a6fed","description":"","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}}],"id":"fb333aa4-e786-43a3-8f0c-b83ca5052451","_postman_id":"fb333aa4-e786-43a3-8f0c-b83ca5052451","description":"","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":true,"source":{"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418","id":"24c088ac-cb1d-4ee1-b969-f909b0440418","name":"Run Payment","type":"folder"}}}],"id":"24c088ac-cb1d-4ee1-b969-f909b0440418","description":"

The Run Payment API allows your company to store users on our system, have them add their payment method, and gives you the ability to run transactions, schedule transactions in the future, and enroll the user in automated payments.

This API is currently in development, but documentation is provided for planning your implementation. Please contact integrations@autoagent.com if you are interested in using this API.

Common JSON Objects

Below are some shared objects used across this API collection. Whenever you see this object in the API request or response, you can refer to the layout here

CartItem Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
item_number string	Unique identifier for the item being paid. Must match identifier at Autoagent. This value directly relates to a merchant's bank account that will receive deposits from MuniciPay.
item_display_title string	User-friendly display name for the item.
item_selections object	Object containing the year:installment to apply this payment. If item being paid does not contain a year, pass the current year. If the item does not contain an installment, pass 1.
amount string	The amount being paid, in dollars and cents, excluding any special characters or comma formatting.
due_date string	YYYY-MM-DD of the item's upcoming due date.
input_fields object	Object containing key:value pairs. If included, these input fields will be associated with the item. These input fields must be communicated to and configured by MuniciPay integrations before they will display. Reserved/Default input_fields: bill_number : String containing any detailed information about the item being paid. Can be a single bill number, comma delimited values, etc. Max length is 500 characters. MuniciPay strongly recommends including a unique bill_number on every request, to ensure you have a point of reference between your system and MuniciPay.
custom_fields object	Object containing key:value pairs. If included, these fields will be returned in the paymentCompleted webhook.
autopay_enrolled_webhook_url string	A webhook URL on your system that MuniciPay will call when the user successfully enrolls in Autopay for the associated item.
autopay_cancelled_webhook_url string	A webhook URL on your system that MuniciPay will call when a user cancels Autopay enrollment for the associated item.
payment_success_webhook_url string	A webhook URL on your system that MuniciPay will call when an Autopay payment succeeds for the associated item.
due_date string	The date on which the payment for the associated item is due.
enrollment_id integer	The unique identifier of the Autopay enrollment associated with the item. Provided in the payload sent to your autopay_enrolled_webhook_url after a successful Autopay enrollment.

User Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
ref_id string	An internal, unique, integer ID stored in your system to identify this user. This will be used to identify the user in the future, even when other fields in the user are updated
email string	The user's email
first_name string	The user's first name
last_name string	The user's last name
address1 string	The user's address
address2 string	The user's address2
city string	Tthe user's city
state string	The user's state, as a 2-character code (e.g. NY, CA, OH)
zip string	The user's zip code
country string	The user's country, as a 2-character code (e.g. US, MX, CA)
phone string	The user's phone number, without spaces or dashes, and without a leading country code
phone_country string	The user's phone country, as a 2-digit code. Do not use the numeric country code (e.g. use 'US' instead of 1).

","auth":{"type":"bearer","bearer":{"token":"{{apiToken}}"},"isInherited":false},"_postman_id":"24c088ac-cb1d-4ee1-b969-f909b0440418"}],"id":"b42a79b3-b21a-442e-9cb4-cfc93a8e9e0d","description":"

REST Changelog

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Date	Description
01/18/2024	Add custom_fields to createCart Add input_fields to createCart Add item_details to getCartResult Deprecated bill_number in createCart
7/3/2024	Added billing_last_four to getCartResult Added billing_transaction_id to getCartResult Added billing_payee_name to getCartResult
12/20/2024	Added billing_service_fee to getCartResult
9/17/2025	Deprecated apiSlug variable in request endpoints Removed item_type from required fields Updated Test Payment Method Details Revised createCart section to include simple and complex and billing file specific versions for reference.

","_postman_id":"b42a79b3-b21a-442e-9cb4-cfc93a8e9e0d"},{"name":"FormPost","item":[{"name":"Requests","item":[{"name":"Single Item","id":"92d81282-3d1a-4ac5-b23f-18c3ee7b478a","protocolProfileBehavior":{"disableBodyPruning":true,"followRedirects":false},"request":{"method":"POST","header":[],"url":"{{apiUrl}}/api/v1/{{apiSlug}}/cart/create-from-form?apiToken={{apiToken}}&siteId={{siteId}}&urlKey={{urlKey}}&prodId={{prodId}}&refNum={{refNum}}&amount={{amount}}&redirectURL=https://www.yoursite.com&webhookURL=https://www.yourwebhook.com&cancelUri=https://www.yoursite.com/cancel","description":"

Example Form with apiToken:

<form action=\"{{apiUrl}}\" target=\"_blank\">\n  <input type=\"hidden\" name=\"apiToken\" value=\"{{apiToken}}\">\n  <label>Product ID:\n    <input type=\"text\" name=\"prodId\" value=\"\">\n  </label>\n  <label>Reference Number:\n    <input type=\"text\" name=\"refNum\" value=\"\">\n  </label>\n  <label>Amount:\n    <input type=\"text\" name=\"amount\" value=\"\" >\n  </label>\n  <label>Redirect URL:\n    <input type=\"text\" name=\"redirectURL\" value=\"\">\n  </label>\n  <label>Webhook URL:\n    <input type=\"text\" name=\"webhookURL\" value=\"\">\n  </label>\n  <input type=\"submit\" value=\"Submit\">\n</form>\n\n

Example Form with siteId and urlKey:

<form action=\"{{apiUrl}}\" target=\"_blank\">\n  <input type=\"hidden\" name=\"siteId\" value=\"{{siteId}}\">\n  <input type=\"hidden\" name=\"urlKey\" value=\"{{urlKey}}\">\n  <label>Product ID:\n    <input type=\"text\" name=\"prodId\" value=\"\">\n  </label>\n  <label>Reference Number:\n    <input type=\"text\" name=\"refNum\" value=\"\">\n  </label>\n  <label>Amount:\n    <input type=\"text\" name=\"amount\" value=\"\">\n  </label>\n  <label>Redirect URL:\n    <input type=\"text\" name=\"redirectURL\" value=\"\">\n  </label>\n  <label>Webhook URL:\n    <input type=\"text\" name=\"webhookURL\" value=\"\">\n  </label>\n  <input type=\"submit\" value=\"Submit\">\n</form>\n\n

\n","urlObject":{"path":["api","v1","{{apiSlug}}","cart","create-from-form"],"host":["{{apiUrl}}"],"query":[{"description":{"content":"

MP-provided token, REQUIRED without siteId and UrlKey

\n","type":"text/plain"},"key":"apiToken","value":"{{apiToken}}"},{"description":{"content":"

Department, MP-provided, REQUIRED without apiToken

\n","type":"text/plain"},"key":"siteId","value":"{{siteId}}"},{"description":{"content":"

Dept URL Key, MP-provided security token, REQUIRED without apiToken

\n","type":"text/plain"},"key":"urlKey","value":"{{urlKey}}"},{"description":{"content":"

Unique item ID, MP-provided, REQUIRED

\n","type":"text/plain"},"key":"prodId","value":"{{prodId}}"},{"description":{"content":"

Item Identifier, ISV-Provided; Account#, Invoice#, etc.\nREQUIRED

\n","type":"text/plain"},"key":"refNum","value":"{{refNum}}"},{"description":{"content":"

$ amount of the transaction, REQUIRED

\n","type":"text/plain"},"key":"amount","value":"{{amount}}"},{"description":{"content":"

Optional redirect after checkout. Must be url-encoded.

\n","type":"text/plain"},"key":"redirectURL","value":"https://www.yoursite.com"},{"description":{"content":"

Optional webhook for successful transactions. Must be url-encoded.

\n","type":"text/plain"},"key":"webhookURL","value":"https://www.yourwebhook.com"},{"description":{"content":"

Optional URL that a shopping cart user should be redirected to after canceling a cart

\n","type":"text/plain"},"key":"cancelUri","value":"https://www.yoursite.com/cancel"}],"variable":[]}},"response":[],"_postman_id":"92d81282-3d1a-4ac5-b23f-18c3ee7b478a"},{"name":"Multiple Items","id":"5416f7ae-8364-40aa-984a-a80ba2212eb8","protocolProfileBehavior":{"disableBodyPruning":true,"followRedirects":false},"request":{"method":"POST","header":[],"url":"{{apiUrl}}/api/v1/{{apiSlug}}/cart/create-from-form?apiToken={{apiToken}}&urlKey={{urlKey}}&siteId={{siteId}}&prodId_1={{prodId_1}}&refNum_1={{refNum_1}}&amount_1={{amount_1}}&prodId_2={{prodId_2}}&refNum_2={{refNum_2}}&amount_2={{amount_2}}&redirectURL=https://www.yoursite.com&webhookURL=https://www.yourwebhook.com&cancelUri=https://www.yoursite.com/cancel","description":"

Example Form:

<table class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>\naction=\"{{apiUrl}}\" target=\"_blank\">\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>siteID:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"apiToken\" value=\"\"/></td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>prodId:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"prodId_1\" value=\"\"/></td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>refNum:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"refNum_1\" value=\"\"/></td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>amount:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"amount_1\" value=\"\"/></td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>prodId:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"prodId_2\" value=\"\"/></td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>refNum:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"refNum_2\" value=\"\"/></td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>amount:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"amount_2\" value=\"\"/></td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>transactionId:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"transactionId\"\nvalue=\"\"/>&#013;</td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>urlKey:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"urlKey\"\nvalue=\"\"/>&#013;</td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>redirectURL:</td><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><input name=\"redirectURL\"\nvalue=\"http://www.yoursite.com?npsPaymentMethod=&npsCardType=&clientName=CityOfAnywhere\"/\n>&#013;</td></tr>\n<tr class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;><td class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; colspan=\"2\" align=\"right\"><input type=\"submit\" value=\"Submit\nForm\"/>&#013;</td></tr>\n</form>\n</table>\n\n

\n","urlObject":{"path":["api","v1","{{apiSlug}}","cart","create-from-form"],"host":["{{apiUrl}}"],"query":[{"description":{"content":"

MP-provided token, REQUIRED without siteId and UrlKey

\n","type":"text/plain"},"key":"apiToken","value":"{{apiToken}}"},{"description":{"content":"

Dept URL Key, MP-provided security token, REQUIRED without apiToken

\n","type":"text/plain"},"key":"urlKey","value":"{{urlKey}}"},{"description":{"content":"

Department, MP-provided, REQUIRED without apiToken

\n","type":"text/plain"},"key":"siteId","value":"{{siteId}}"},{"description":{"content":"

Unique item ID, MP-provided, REQUIRED

\n","type":"text/plain"},"key":"prodId_1","value":"{{prodId_1}}"},{"description":{"content":"

Item Identifier, ISV-Provided; Account#, Invoice#, etc.\nREQUIRED

\n","type":"text/plain"},"key":"refNum_1","value":"{{refNum_1}}"},{"description":{"content":"

$ amount of the transaction, REQUIRED

\n","type":"text/plain"},"key":"amount_1","value":"{{amount_1}}"},{"description":{"content":"

Unique item ID, MP-provided, REQUIRED

\n","type":"text/plain"},"key":"prodId_2","value":"{{prodId_2}}"},{"description":{"content":"

Item Identifier, ISV-Provided; Account#, Invoice#, etc.\nREQUIRED

\n","type":"text/plain"},"key":"refNum_2","value":"{{refNum_2}}"},{"description":{"content":"

$ amount of the transaction, REQUIRED

\n","type":"text/plain"},"key":"amount_2","value":"{{amount_2}}"},{"description":{"content":"

Optional redirect after checkout. Must be url-encoded.

\n","type":"text/plain"},"key":"redirectURL","value":"https://www.yoursite.com"},{"description":{"content":"

Optional webhook for successful transactions. Must be url-encoded.

\n","type":"text/plain"},"key":"webhookURL","value":"https://www.yourwebhook.com"},{"description":{"content":"

Optional URL that a shopping cart user should be redirected to after canceling a cart

\n","type":"text/plain"},"key":"cancelUri","value":"https://www.yoursite.com/cancel"}],"variable":[]}},"response":[],"_postman_id":"5416f7ae-8364-40aa-984a-a80ba2212eb8"}],"id":"ca9fcf78-b503-4f2f-b5c7-f93e95f124dd","_postman_id":"ca9fcf78-b503-4f2f-b5c7-f93e95f124dd","description":""},{"name":"Response","item":[{"name":"redirectURL","id":"168a402f-cb10-4773-a98e-a163e7f5b830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{redirectUrl}}?npsPaymentMethod&npsCardType&npsFirstName&npsLastName&npsCFAmount&npsTransactionId","description":"

NOTE: In addition to the fields listed above, MuniciPay will also accept unknown, custom fields

that are URL-encoded and appended to the redirectURL parameter, and simply return those values on response, enabling integrators to pass custom values. These fields/values are not stored on the MP payment server but are simply passed through and returned on.

For example: if you wanted to redirect the user to http://www.yoursite.com/ after checkout and wanted to query the values for all of the above 5 optional fields as well as pass your own custom value ofclientName=CityOfAnywhere, the redirectURL portion of your request, properly-encoded, would look like the following:

http://www.yoursite.com?npsPaymentMethod=&npsCardType=&npsFirstName=&npsLa\nstName=&npsTransactionId=&clientName=CityOfAnywhere\n\n

","urlObject":{"host":["{{redirectUrl}}"],"query":[{"description":{"content":"

Indicates if Credit Card or ECheck

\n","type":"text/plain"},"key":"npsPaymentMethod","value":null},{"description":{"content":"

Indicates credit card brand used

\n","type":"text/plain"},"key":"npsCardType","value":null},{"description":{"content":"

First name of payor

\n","type":"text/plain"},"key":"npsFirstName","value":null},{"description":{"content":"

Last name of payor

\n","type":"text/plain"},"key":"npsLastName","value":null},{"description":{"content":"

MP-convenience fee amount

\n","type":"text/plain"},"key":"npsCFAmount","value":null},{"description":{"content":"

MP-assigned transaction ID

\n","type":"text/plain"},"key":"npsTransactionId","value":null}],"variable":[]}},"response":[],"_postman_id":"168a402f-cb10-4773-a98e-a163e7f5b830"},{"name":"webhookURL","id":"0493c5b4-e5f7-4c2b-ab4e-d7e758165951","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status_code\": \"200\",\n \"message\": \"SUCCESS\",\n \"status\": \"Payment completed successfully.\",\n \"data\": {\n \"cart_id\": \"781b89746a9aea9ea738634c54a2649f\",\n \"items_paid\": 1,\n \"billing_amount\": \"1005.50\",\n \"confirmation_number\": \"LFU3GFS9LR\",\n \"billing_first_name\": \"John\",\n \"billing_last_name\": \"Smith\",\n \"billing_address\": \"123 Anywhere\",\n \"billing_address2\": \"\",\n \"billing_city\": \"Test\",\n \"billing_state\": \"CA\",\n \"billing_zip\": \"12345\",\n \"billing_country\": \"US\",\n \"billing_phone\": \"(201) 444-3333\",\n \"billing_email\": \"test@test.com\",\n \"billing_timestamp\": \"2022-11-04T14:04:18.000000Z\",\n \"billing_method_name\": \"Credit Card\",\n \"items\": [\n {\n \"1001000071\": \"1005.50\"\n }\n ],\n \"item_details\": [\n {\n \"item_number\": \"1001000071\",\n \"item_amount\": \"1005.50\",\n \"custom_fields\": {\n \"custom1\": \"value\",\n \"custom2\": \"value2\",\n \"custom3\": \"value3\"\n },\n \"input_fields\": {\n \"bill_number\": \"12345\",\n \"input1\": \"value1\",\n \"input2\": \"value2\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"description":"

If a webhookURL parameter is provided in the initial cart/create, a POST is made when a successful transaction occurs.

The request expects the response of \"success\" along with an HTTP 200 status. If either of those fail, a second attempt will be made. If the second attempt fails, the transaction will be VOIDED and the payer will receive an error on screen that their payment can not be completed.

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"0493c5b4-e5f7-4c2b-ab4e-d7e758165951"}],"id":"4fb09054-37a0-497f-a969-6da771c096a6","_postman_id":"4fb09054-37a0-497f-a969-6da771c096a6","description":""}],"id":"f928a14e-b0f3-4561-bc33-646d7202e7ad","description":"

You can create a one-time shopping cart link on MuniciPay using a hosted form on a your website that makes a POST to the below endpoint.

On POST, an internal token is created represeneting your payload and the user will be redirected to MuniciPay's hosted payment page containing all contents of the shopping cart you sent over.

Test Payment Methods

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Credit Card	Expiration	CVV2
371449635398431	06/2024	1234

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ACH Type	Routing Number	Account Number
Checking	044000037	123123123

","_postman_id":"f928a14e-b0f3-4561-bc33-646d7202e7ad"},{"name":"File Uploads and Downloads","item":[{"name":"startSession","id":"01047246-735d-41ce-856f-e74d587909e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"j_username","value":"{{j_username}}","type":"text"},{"key":"j_password","value":"{{j_password}}","type":"text"}]},"url":"{{apiUrl}}/api/file/start-session","description":"

Unlike the other API collections, this collection authenticates via cookies. After making a call to this endpoint, include the cookies it returns in all future requests for this collection

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
j_username	Required Your auth username provided to you by MuniciPay Integrations
j_password	Required Your auth password provided to you by MuniciPay Integrations

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
authenticated	Returns true if authenticated sucessfully

","urlObject":{"path":["api","file","start-session"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"01047246-735d-41ce-856f-e74d587909e0"},{"name":"downloadBatchFile","id":"5c633226-36ef-49b0-ac1b-52902fdf4a86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{apiUrl}}/api/file/download-batch?targetDate={{targetDate}}","description":"

Downloads a batch file for the given date. The response will be raw text in a format you have specified to MuniciPay Integrations

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
targetDate	Required The date you wish to receive a batch file for, formated as YYYY-MM-DD

","urlObject":{"path":["api","file","download-batch"],"host":["{{apiUrl}}"],"query":[{"key":"targetDate","value":"{{targetDate}}"}],"variable":[]}},"response":[],"_postman_id":"5c633226-36ef-49b0-ac1b-52902fdf4a86"},{"name":"uploadFile","id":"346db01e-9e43-4c10-a1b0-2395ed798e00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/michael/Downloads/collector_tax_file_18717.zip","/Users/michael/Downloads/collector_tax_file_1020909.zip"],"src":"/Users/michael/Downloads/collector_tax_file_1020909.zip"}]},"url":"{{apiUrl}}/api/file/upload-file","description":"

Upload a billing file matching the specifications you have discussed with the MuniciPay integrations team

Request Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
file	Required the billing file you wish to upload

","urlObject":{"path":["api","file","upload-file"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"346db01e-9e43-4c10-a1b0-2395ed798e00"}],"id":"d53b57f4-177f-449d-bc47-61eff2b763aa","description":"

Automate the uploading of billing files and the downloading of MuniciPay payment files with this API. Contact integrations@autoagent.com for help configure your setup.

\n","_postman_id":"d53b57f4-177f-449d-bc47-61eff2b763aa"}],"event":[{"listen":"prerequest","script":{"id":"2bc64370-4ee5-4d00-ac77-93c1279ac2dd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d430e281-2491-47c5-9a20-61746ff5f40a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"apiWebhookUrl","value":"","type":"string"},{"key":"apiRedirectUrl","value":"","type":"string"}]}