Returns a tree of companies and merchant accounts (MIDs) that the authenticated API key is permitted to access. Use the Value tokens from this response to populate CompaniesAndMidsThisIsFor when creating or updating event subscriptions.
\nA restricted API key (Scope ≠ \"All\") only sees companies and MIDs it is authorized for. An unrestricted key sees all enabled MIDs.
\nArray of company nodes, ordered by name. Each company node:
\n"}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","EventSubscription","GetCompaniesAndMids"],"host":["","midmetrics","io"],"query":[],"variable":[]}},"response":[{"id":"fc5f9c11-7c21-42f9-a981-8a328f0eb032","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://.midmetrics.io/api/EventSubscription/GetCompaniesAndMids"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Name\": \"Acme Corp\",\n \"Value\": \"7!\",\n \"Mids\": [\n { \"Name\": \"Main Account\", \"Value\": \"7~42\" },\n { \"Name\": \"European Store\", \"Value\": \"7~55\" }\n ]\n },\n {\n \"Name\": \"mysubdomain\",\n \"Value\": \"0!\",\n \"Mids\": [\n { \"Name\": \"Legacy MID\", \"Value\": \"0~3\" }\n ]\n }\n]\n"}],"_postman_id":"3c72f9f2-523e-4f48-b8a8-bedc8ad10c59"}],"id":"8c6126fd-a797-4ecb-8cb0-7f06d45a81be","description":"The Events API allows you to receive notifications via an HTTP API callback when an Alert, Inform, Chargeback, Chargeback Update, or RDR happens in your enterprise. The API will make a call to a webhook that you configure and you have subscribed to one of these events.
\nIf you have questions about using our APIs, please email service@midmetrics.com
\nSchema
\n\nSubscribing to Alerts or Informs event will trigger MidMetrics to HTTP POST to the subscribed webhooks the following object when an Alert or Inform event occurs:
\npublic class AlertOrInformEvent\n{\n public string alertSource { get; set; }\n public string descriptor { get; set; }\n public string descriptorPhone { get; set; }\n public string caseEventType { get; set; }\n public SubscribedEventType eventType { get; set; }\n public string arn { get; set; }\n public string MID { get; set; }\n public string externalCaseId { get; set; }\n public string type { get; set; }\n public int midMetricsId { get; set; }\n public DateTime? chargeTransactionDate { get; set; }\n public decimal amount { get; set; }\n public string currency { get; set; }\n public string ccBrand { get; set; }\n public string ccIssuer { get; set; }\n public string ccBin { get; set; }\n public string ccLastFour { get; set; }\n public string ccFullNumber { get; set; }\n public string ccExpDate { get; set; }\n public string ccAuthCode { get; set; }\n public string externalTransactionId { get; set; }\n public string enterpriseName { get; set; }\n public DateTime? dateReceivedByProcessor { get; set; }\n public DateTime? dateReceivedByMIDMetrics { get; set; } \n}\n\n
\nExample JSON Payload
\n{\n \"alertSource\": \"Ethoca\",\n \"descriptor\": \"SAVERSEDGE 8885036816\",\n \"descriptorPhone\": \"8885036914\",\n \"caseEventType\": \"DISPUTE\",\n \"eventType\": \"Alert\",\n \"arn\": \"82306622314900018222679\",\n \"MID\": \"520002837881\",\n \"externalCaseId\": \"B35EST5Z5WNVUTMF8SSAER\",\n \"type\": \"A\",\n \"midMetricsId\": 201994,\n \"chargeTransactionDate\": \"2022-11-10T00:00:00\",\n \"amount\": 24.95,\n \"currency\": \"USD\",\n \"ccBrand\": \"MASTERCARD\",\n \"ccIssuer\": \"SECURITY SERVICE FEDERAL CREDIT UNION\",\n \"ccBin\": \"527505\",\n \"ccLastFour\": \"2825\",\n \"ccFullNumber\": null,\n \"ccExpDate\": \"0224\",\n \"ccAuthCode\": \"704274\",\n \"externalTransactionId\": \"7778396317\",\n \"enterpriseName\": \"acme\",\n \"dateReceivedByProcessor\": \"2022-11-21T15:40:29.153\",\n \"dateReceivedByMIDMetrics\": \"2022-11-21T14:40:43.693\"\n}\n\n
\nFor Inform events, eventType will be \"Inform\" and the type \"I\"
\nChargebacks
\nSubscribing to the Chargeback events will trigger MidMetrics to HTTP POST to the subscribed webhooks the following object when a Chargeback occurs:
\npublic class CBEvent\n{\n public string reasonCode { get; set; }\n public SubscribedEventType eventType { get; set; }\n public string arn { get; set; }\n public string MID { get; set; }\n public string externalCaseId { get; set; }\n public string type { get; set; }\n public int midMetricsId { get; set; }\n public DateTime? chargeTransactionDate { get; set; }\n public decimal amount { get; set; }\n public string currency { get; set; }\n public string ccBrand { get; set; }\n public string ccIssuer { get; set; }\n public string ccBin { get; set; }\n public string ccLastFour { get; set; }\n public string ccFullNumber { get; set; }\n public string ccExpDate { get; set; }\n public string ccAuthCode { get; set; }\n public string externalTransactionId { get; set; }\n public string enterpriseName { get; set; }\n public DateTime? dateReceivedByProcessor { get; set; }\n public DateTime? dateReceivedByMIDMetrics { get; set; }\n}\n\n
\nExample JSON Payload
\n{\n \"reasonCode\": \"10.4\",\n \"eventType\": \"Chargeback\",\n \"arn\": \"2418152013900010500436\",\n \"MID\": \"910900031854606\",\n \"externalCaseId\": \"202032009821\",\n \"type\": \"C\",\n \"midMetricsId\": 20845,\n \"chargeTransactionDate\": \"2022-01-12T04:09:01\",\n \"amount\": 24.95,\n \"currency\": \"USD\",\n \"ccBrand\": \"VISA\",\n \"ccIssuer\": \"BARCLAYS BANK US\",\n \"ccBin\": \"439707\",\n \"ccLastFour\": \"1267\",\n \"ccFullNumber\": \"439707xxxxx1267\",\n \"ccExpDate\": \"0725\",\n \"ccAuthCode\": \"07052C\",\n \"externalTransactionId\": \"689308709\",\n \"enterpriseName\": \"acme\",\n \"dateReceivedByProcessor\": \"2022-02-01T00:00:00\",\n \"dateReceivedByMIDMetrics\": \"2022-02-02T08:56:38.68\"\n}\n\n
\nChargebackUpdate
\nSubscribing to the ChargebackUpdate events will trigger MidMetrics to HTTP POST to the subscribed webhooks the following object when a Chargeback Cycle or Action occurs
\npublic class ChargebackUpdate\n{\n public string reasonCode { get; set; }\n public SubscribedEventType eventType { get; set; }\n public string arn { get; set; }\n public string MID { get; set; }\n public string externalCaseId { get; set; }\n public string type { get; set; }\n public int midMetricsId { get; set; }\n public DateTime? chargeTransactionDate { get; set; }\n public decimal amount { get; set; }\n public string currency { get; set; }\n public string ccBrand { get; set; }\n public string ccIssuer { get; set; }\n public string ccBin { get; set; }\n public string ccLastFour { get; set; }\n public string ccFullNumber { get; set; }\n public string ccExpDate { get; set; }\n public string ccAuthCode { get; set; }\n public string externalTransactionId { get; set; }\n public string enterpriseName { get; set; }\n public DateTime? dateReceivedByProcessor { get; set; }\n public DateTime? dateReceivedByMIDMetrics { get; set; }\n public List<ChargebackActionEvent> Actions { get; set; }\n public List<ChargebackCycleEvent> Cycles { get; set; }\n}\npublic class ChargebackActionEvent\n{\n public string Action { get; set; }\n public string ActionBy { get; set; }\n public string Notes { get; set; }\n public DateTime? Date { get; set; }\n}\npublic class ChargebackCycleEvent\n{\n public string Cycle { get; set; }\n public string CycleState { get; set; }\n public string SourceCycleState { get; set; }\n public string ActionBy { get; set; }\n public DateTime? Date { get; set; }\n}\n\n
\nRDRs
\nSubscribing to the RDRs events will trigger MidMetrics to HTTP POST to the subscribed webhooks the following object when an RDR occurs
\nNote the RDR object is very similiar to the Chargeback object except it has the additional fields status and statusCode
\npublic class RDREvent\n{\n public string reasonCode { get; set; }\n public string status { get; set; }\n public int? statusCode { get; set; }\n public SubscribedEventType eventType { get; set; }\n public string arn { get; set; }\n public string MID { get; set; }\n public string externalCaseId { get; set; }\n public string type { get; set; }\n public int midMetricsId { get; set; }\n public DateTime? chargeTransactionDate { get; set; }\n public decimal amount { get; set; }\n public string currency { get; set; }\n public string ccBrand { get; set; }\n public string ccIssuer { get; set; }\n public string ccBin { get; set; }\n public string ccLastFour { get; set; }\n public string ccFullNumber { get; set; }\n public string ccExpDate { get; set; }\n public string ccAuthCode { get; set; }\n public string externalTransactionId { get; set; }\n public string enterpriseName { get; set; }\n public DateTime? dateReceivedByProcessor { get; set; }\n public DateTime? dateReceivedByMIDMetrics { get; set; }\n}\n\n
\nExample JSON Payload
\n{\n \"reasonCode\": \"10.4\",\n \"status\": \"Accepted\",\n \"statusCode\": 103,\n \"eventType\": \"RDR\",\n \"arn\": \"2418195226900011631570\",\n \"MID\": \"910900006894219\",\n \"externalCaseId\": \"4313168\",\n \"type\": \"R\",\n \"midMetricsId\": 3464,\n \"chargeTransactionDate\": \"2022-09-23T00:00:00\",\n \"amount\": 24.95,\n \"currency\": \"USD\",\n \"ccBrand\": \"VISA\",\n \"ccIssuer\": \"BANK OF AMERICA, N.A.\",\n \"ccBin\": \"435603\",\n \"ccLastFour\": \"7314\",\n \"ccFullNumber\": \"435603xxxxxx7314\",\n \"ccExpDate\": \"1024\",\n \"ccAuthCode\": \"110061\",\n \"externalTransactionId\": \"761127055\",\n \"enterpriseName\": \"acme\",\n \"dateReceivedByProcessor\": \"2022-10-08T08:35:08\",\n \"dateReceivedByMIDMetrics\": \"2022-10-08T00:00:00\"\n}\n\n
\nThe eventType parameter will be: Alert, Inform, Chargeback, or RDR.
\nWebhooks
\nWhen your webhook is called, MidMetrics will provide via Basic Auth the username and password you provided in the Subscribe API call.
\n","_postman_id":"8c6126fd-a797-4ecb-8cb0-7f06d45a81be","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}}},{"name":"Representments API","item":[{"name":"GetDocumentTypes","id":"43136739-b641-4b02-b5b0-574f054c4615","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://.midmetrics.io/api/chargeback/GetDocumentTypes","description":"Retrieves a categorized list of available document types for a tenant.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","chargeback","GetDocumentTypes"],"host":["","midmetrics","io"],"query":[],"variable":[]}},"response":[{"id":"c437f724-db96-4b5a-91ad-e5a442746391","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://.midmetrics.io/api/chargeback/GetDocumentTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"1035"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 28 Mar 2025 22:15:39 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d5d7734f-f522-4898-ad87-d7cf6e51537a"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"DocumentTypes\": [\n {\n \"Category\": \"Card Present - Invalid CB \",\n \"DocumentTypes\": [\n {\n \"DocumentType\": \"Chip-Initiated \"\n },\n {\n \"DocumentType\": \"Emergency Cash Disbursement\"\n },\n {\n \"DocumentType\": \"Fallback transaction\"\n },\n {\n \"DocumentType\": \"PIN and an imprint of the card \"\n },\n {\n \"DocumentType\": \"Authorization POS Entry Mode code 90 \"\n },\n {\n \"DocumentType\": \"Contactless transaction \"\n },\n {\n \"DocumentType\": \"Mobile Push Payment \"\n },\n {\n \"DocumentType\": \"EMV PIN-Compliant Acceptance Device \"\n },\n {\n \"DocumentType\": \"Face to face transaction \"\n },\n {\n \"DocumentType\": \" POS Entry Mode code 05, 07, 90, or 91\"\n },\n {\n \"DocumentType\": \"Card present - keyed entry\"\n },\n {\n \"DocumentType\": \"Emergency Cash Disbursement\"\n }\n ]\n },\n {\n \"Category\": \"Order Documents\",\n \"DocumentTypes\": [\n {\n \"DocumentType\": \"Customer Service Records\"\n },\n {\n \"DocumentType\": \"Signed Contract\"\n },\n {\n \"DocumentType\": \"Call Transcript\"\n },\n {\n \"DocumentType\": \"Service was Provided\"\n },\n {\n \"DocumentType\": \"Customer Acquisition \"\n },\n {\n \"DocumentType\": \"Fraud Tools\"\n },\n {\n \"DocumentType\": \"Purchase Process\"\n },\n {\n \"DocumentType\": \"Purchase Terms\"\n },\n {\n \"DocumentType\": \"Transaction History\"\n },\n {\n \"DocumentType\": \"Invoice\"\n },\n {\n \"DocumentType\": \"Evidence Cardholder is Related to Customer\"\n },\n {\n \"DocumentType\": \"Product Image\"\n },\n {\n \"DocumentType\": \"Product Description\"\n },\n {\n \"DocumentType\": \"Proof Customer No Longer Wishes to Dispute\"\n },\n {\n \"DocumentType\": \"Identity Verification\"\n },\n {\n \"DocumentType\": \"CDRN/Alert\"\n },\n {\n \"DocumentType\": \"Cancelled\"\n },\n {\n \"DocumentType\": \"Other\"\n },\n {\n \"DocumentType\": \"Evidence of Refund\"\n }\n ]\n },\n {\n \"Category\": \"Other Document\",\n \"DocumentTypes\": [\n {\n \"DocumentType\": \"Other\"\n }\n ]\n },\n {\n \"Category\": \"Proof Of Delivery\",\n \"DocumentTypes\": [\n {\n \"DocumentType\": \"Shipping Provider Proof\"\n },\n {\n \"DocumentType\": \"Fulfillment\"\n },\n {\n \"DocumentType\": \"Usage History\"\n },\n {\n \"DocumentType\": \"Login History\"\n },\n {\n \"DocumentType\": \"Proof of Site or App Access\"\n },\n {\n \"DocumentType\": \"Proof of Product Download\"\n },\n {\n \"DocumentType\": \"Proof of Activation or Usage\"\n },\n {\n \"DocumentType\": \"Warranty Registration\"\n },\n {\n \"DocumentType\": \"Evidence Service Was Provided\"\n }\n ]\n },\n {\n \"Category\": \"Travel Documents\",\n \"DocumentTypes\": [\n {\n \"DocumentType\": \"Flight Manifest\"\n },\n {\n \"DocumentType\": \"Travel Purchase\"\n },\n {\n \"DocumentType\": \"Travel history and rewards usage\"\n },\n {\n \"DocumentType\": \"Hotel or Vacation Rental Final Bill\"\n },\n {\n \"DocumentType\": \"Food/Beverages Signed to Room\"\n },\n {\n \"DocumentType\": \"Parking Ticket\"\n },\n {\n \"DocumentType\": \"Traffic Fine\"\n },\n {\n \"DocumentType\": \"Other\"\n },\n {\n \"DocumentType\": \"Car Rental Agreement\"\n },\n {\n \"DocumentType\": \"Toll Receipt\"\n },\n {\n \"DocumentType\": \"Collision/Damage Proof\"\n },\n {\n \"DocumentType\": \"Gas Receipt\"\n },\n {\n \"DocumentType\": \"Car Return Late Fee Receipt\"\n },\n {\n \"DocumentType\": \"Room Service\"\n },\n {\n \"DocumentType\": \"Recreational Activities\"\n },\n {\n \"DocumentType\": \"In-Room charges\"\n },\n {\n \"DocumentType\": \"Damage Proof\"\n },\n {\n \"DocumentType\": \"In-Flight services\"\n },\n {\n \"DocumentType\": \"Upgrade\"\n },\n {\n \"DocumentType\": \"Baggage Fees\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"43136739-b641-4b02-b5b0-574f054c4615"},{"name":"UploadDocument","id":"6bb036c4-150f-4404-b7c0-de3bbb4213e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ChargebackId\": 31663,\r\n \"ProcessorCaseId\": \"2025084027182\",\r\n \"DocumentType\": \"Signed Contract\",\r\n \"Title\": \"Test\",\r\n \"Notes\": \"test notes.\",\r\n \"ImageContent\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUSEhMWFhUWGBYYGRgXFxoaGBcYFxoXGBcYGBYeHiggGB8lHxcYITEhJSkrLi4uGB8zODMsNygtLisBCgoKDg0OGxAQGi0lICUtLS0tLS0tLS0tLS8tLS0tLS0tLS0tLSstLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLf/AABEIALEBHAMBIgACEQEDEQH/xAAcAAACAwEBAQEAAAAAAAAAAAAABQMEBgIHAQj/xABGEAABAwIEAwUFBQUGAwkAAAABAAIRAyEEEjFBBVFhBiJxgZETMqGxwRQjQtHwM1JicuEHFUOSsvEWotI0NVNUY3OCs8L/xAAZAQEAAwEBAAAAAAAAAAAAAAAAAQIDBAX/xAAvEQACAgEDAwEHAgcAAAAAAAAAAQIRAxIhMQRBURMUIjJhkaGxUnEVM0KB0fDx/9oADAMBAAIRAxEAPwDw1CEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEIQgBCEIAQhCAEKSlRc6zWl3gCfkrtPgWJP+C8fzDL0/FCAXITj/hjFf+F/zs/6lMzsliSJhgPIvE+PL47qLRGpeRChaal2JxB1dTA594//AJVodh4PfrjqAz6lwTUiNSMehbt/Y3DxAq1J590iecQPmuaPYqhPfrvI6NDY8zMqNSI9SPkwyFv6fYrCn/Gq/wDJ8/6Lt/YvCAWqVif5qYH+kqdSGuJ56hehs7E4Wbvr/wCan8sq+DsJRIMOra2MsPqIlLROtHnqFu3f2dkmW1nRtNOfWHKB/YBwHerhvKabo9UtDUjFoWrZ2MN5xDAdoab+MxC5qdh634KtJ3O7hf8Ay3S0NS8mWQtP/wADYm8Ook8vaAE/5gB6qk3srjCQ0UHEnkWkeswFJaxKhW8bwytRJFWk9hGuZpA9dFUQAhCEAIQhACEIQAhCu0eE13AFtGoQdDlMHzQFJC0+A7FVnCapFMcjc/MD4+S0/BewNAwX+0qnlBbT3iXWPKyrqRGpHmKZUez+LcJbhqxHP2bo9Yhe18O4bhsJ7jaVM7kNLnf5j+a6xHHabpDc5PMgH6x5lHJEOSR49h+x+Nf/AIDm9XQPVXsP2GqT97UYzoJcfot5isU4y51SJ0a12Y+caBV8rfeDXG257pO8kQqa2+DN5H2M7h+yeGae9nqHkXQPgAfinfD+yIBBp4UWvL4Mde+pafaClSu0Maf4TJnrA+BlL8b2qcRGd5BvyHXkVrHFkl2Zm8qXL+hqKPC3x97WYwbAEvPjawXzEYjBss7M8g/hGUepJn1WH/vsxo4j+aB5wvjOLwJFMX6b+Kt7Nm/T+Cnrx8GxqcXptH3eHpt6vGc/GUuxHGqn77vIQB8PkqnBeFYnF2FNopzBe4GG/HWDpqtjwrs7h6Lc5zVCD+MnL4htx6ys54sidMmLyT42RjW8RNQ5QKj3cmjNdXWYHEuAyYWoRzIyj1MLeUcZAGRrSd8ggfBT0cJi6l3FrR1kx5KPS8mqxfM8+qcKxY1Zl9D8Qqr8FVBOYzbcGPG4XqD+zAdd9VxuDAgD810zs7TEa26m/U3+UK2iJPpI8vp8OqAA928mzQB/VSPwLtS5wHOIHwsvTh2ZoE3pfEx/qXVXsvQIgMA8AE0RCxI8xo4EnWqPT+n1VhmEI3nrY/Vbmr2VaPdkb9PRJcR2UeHH7uRtDjedZBZA+PkrLHDyT6dCVrH7N+H6CKld4F7c+qsVuEU2OILnMI2cCLb3BPyChxOELQIDXA/xEn9byp9H5kaWV3V2HXKelvkuXU2cr7EW+MqhXw9MyDTv0LZnzaJUjOHtjuV3g/xMOXTTceis+m+f+/co0/BbZSaTdxHkDPnIjzVfiZytaaclsAuDiLGLkhhdbpfRVHVsQxwzezd0OYT0MaK/h6+YCW5Y2Fj4hw+t1m8Tx7yVoo6e1GfxPGKgBy0mlu8S4dJBA+Sh+30qzb4OmXNgktpMab2EwRNzyOy0lfB0nyDIB1nr4R6nql2J7MiCKT2O5e0BkEcnC/whdmLJ0zVNUSrRmMZhcMHZTh61N0xAf/1NdM+K4/ujDF4aa1WiJj7ymx0dSQ9p+CdcQ7O1AyRTqOAuTScHAAQC1zSGkOnfLceFktVsHK2qbbamf4gYNr7GPNdK6fDNbfn/AKaqTR3U7JON6GIw9YXgNfleY/heB80UOwfEHgup4ZzwN2uafS8ld4biWLomWl0QbOZLXAi4iLiNgnPDv7QMSywjLbuxIEfu2ssZ9DL+kspmHxuBq0XZK1N9N0Tle0tdB0MEAwq69Wxf9oXtWhtakXC4lsg9bfT1Sl2J4V/5RpO5L6rTO/da8AeEBYPpcq7FtaPQML2KwuG7wblH4jMW0jdynqUKF8gJdNoEk9Zd81navFHOcT3oO2b5kASqOO4tlaQ50NOrWjX6+pXEnqdRVmcsqNcXUKfequZoYE5nTvYSP1qqzuPUdRmMe6zKACdr7eq85rcfvDWzyjXw3VGpXrPJDu4AASXmzWmALE3mRtuu3H0OV/FSM/Uk+Ea/iXaJjnAuDcw/dk+AiY9E4pcKDqjGVsTQpl7c2UPBfAEmWwGtI3k7HWF54/igpPmmWzEOOSS4gyHAFzmCCAR4abKRzW4gOqfdC81JaGGwklveJg8mtnkFt/D4d2yUv1G84s/C0APZy6ZIqOqUnsscpzNFmwSNYNwkeN7Y1QGsYaLDSt7QMEmJOhkNIFgADOttAjfj/vAykG+yY1jMsb2zvAJJEkTDiT7s30z+JxGYzv1Jdr4row9JCPYt+w4xHEfbVDUcGtvOeCC48y0Wkm50+i+vxgLYpMAIIzVXCbXBIbcgTuElLjlAbB3MTmnr6bJt2Xr0vtQfinTTAe58gnPlaTlIHP8ALmumUUlfgrpRbwOAaSczs9mkE2F4Aho56CeWmq1fB+AioGnK9sxlzAM11ytMuECb92+6n4VwdlTFlzfaMwp77A14LKpcBkzAuIDBB7pAIsFr+KYWrTaKroMAxlcZnUEx7x/M6rz82dt0jSMER4bhz6n3QdTbTbADG73kEgD9XT6rw2m1veEjcHQ+PRJuyeLc55dUytzbkx6Bap9ZjpbI5Ljk3ZoiHBNG4FtOg6K5mSx1Is0mFaoV5tuqklkMXT4aJJAC4D19MHVQCKli2OMA6if9+SsQuGNA0AC7QHxC+kr4gIMRhQ4QQD4gFIOI8BYQYAafC3w0WnXNRoNipToHknaHs9UFwPMGR/miRpusVWr18O85hLfJ1+pnQ+i9w4ph3sOZhtuCsvxzs59pZ7SkAHA95ugPURpp4XuuvFnraXBnKPgxeA7Vh3dqNa5swQDLrbgDbqrf3NS9Co5rv3XGQekTKXcT7HYkD2hwwc070nBzxylrTI06hJsMXCwOYDZ1nN84uuj04SVxKP5mlPEqlMllSnmbOoFwOcRfwgK1Q4pT2eW8xE68+WvNKsLji5sHvjY6kLv7G499gLgNx7w/XquafTwb8FXF9h4KhHUG1ne9y5yqWP4XSrjvszERdktcALHYgx1+KU0cQWkQ5wv09CDY+d0zw+OB0aC70mdbbeS53hy4ncX9Cu4vrcANERh67hUD2ujPaoNWGPdESNQfe5JTiqLg0e3pMB1Y7IWyNwTSg7WzA+MLWe3a4iQ5p/iu2w5i49LJhg30nH2NWmDmBLXEkFri0wQ+bCYuDvK2x9bNOpr/ACWjK9mea4hhLw1lOqCdASKrjyDXBgMRtdVftBbYO9J+hW2xWBxWEJdRcCxzQHNIbma3NOUPgHbne2qzeP47ULzkZ7MC2UufOpMkZ7a6Cy9PFl1r3d0SzSVMT33U2OaC0HM5zmhreZubxpbc8tVGELHuvVaym4jM6oA/NB/FeQQSDHdECSVR4lisO7OaYqAS3Iw+5ABDiRqbzBJLl9rcZD2mkyiGtLg4ZSS5oyhr2tJEwSAY2yjeSssPTrHGooqo+St/eeSoH0ZblzQe7N5i0REEayqNXEuc9z57ziSepJk2XVWuXQCJIsNZAGwv5+a5oMBcActyLkkAc5I0XWkkWIwJVxmMdDWvJawXAa0C+kxIn12U5c0WphuWCTd3vN3a8XIEj000SzU/G6fEDurUJgEmAPptfouxRBbIJLuQafid1Aumu/Wo9FIO3Uy0B1xOm2msevxU+AqXymHB0AglwNjNoPMqzg6LSzvggEi/ev1tb1CufZ6boaAco5gweWuyzlNcA0XDOJ1qLMlMnKRYTYRHWy0eA4u57WtxeYgGRFiZ1vuPDwWY4MG6Ocxg1BMzblH1Tagwg6gjmHNv1svNyJWaI3ODOEe2Q0s65nT87qbCYhtNxDMx6kz6JBw5wtcfNaLCUhqQPRczVF0NqOPB5q0x7XXCpU8kXU9PLsqElmAvoA2UTXhd+0CgHcIKjNYL7mQH0oBXwBBcgOlxWdZfK1UNCo42vFkB94i8ZJ23WWxVZ9J2alJbuNx5bhO6tbuunks4yv37bmI6LSKIY5wdd+bT3oJgRfdY3t32JzPdjMLJJEvaLnMTchnzj0K9K4W1jmXa3yH6KkxWHDe+wRGsGJCmGRwlaDVo/OzaBPeZNOpyAlr4m7eRsr3CeKXDXw2oNdQD4/mvTOMdm8PiXOzB1F77io397m5ps74HqsF2j7P1MO/JUIfqW1GgjM0RciTlMkiJOmq7I5Y5NmZuLQzqmhVdmqMAfziTy8D4pTh+D1HPc2m0vLRJgbdQq2BrWyk+B5LVdmuNilVis6xGp0232VHqithSZnW5m2gyp6WLdEQAIv3fjEKl23/bvq0H911y3k46kHkdR47wkWMr1qWUPL7tBgkwJuATsYiy1jhWSK+ZnJPsacY+qO6RmYTebes6hL8XWpB3vDzAMeay/tHvlwk3E6nWwvvqPVR1XuaS1wIcNQQQR4grWHSRhwylSH/HaNDX7UxzqeVopta5+YgDM7PlAjSxiYKVVMG7P3GvbuC4ZRrEyDzgCFLw/hrnElzW2bmDXWkGYNo3G5XA4g/3fcmAQ05csbNG3OVsrWydmpDRa0E5wZk3ObS+kRfXVXH4VhDXezJa4A5i/I6QA28tLYnYSebl84ziQGimx7HtkmQBI0s4xc/xTfkpeyXA24ys6k+r7OGOLTElzxGVgaSJJ7xjk0o37up7BIj4nisPkbSp0e8xjQakw5z5l8i8jUanQRF5oYXChzgHPDG7nUgfAfEK5j+Bmk9zPbUH5f3KgjWN4vvHzVCqGCMpLiNSRDTygax6K0arZgkxmHAdDM2WAQHEOdB092y5w7WCS8mRtEz48l9w9N1WoGsMOcbXi/l9E5w3Cbln2hgqBw7tTMBmm1iNDzgg2SUlFU2CvgeLtADckAaXzeV06wdelUMuDRI2dBv4W9Ugx/cqZXMpve10TSd3Db3YAvfw312dYIMJc4NbMDNlBJGUXAJsALTEaBYZYxqwWqtBrbgi+n6BXdHHZTAFuioGrLrAFXqdGb2EeX9Fg15JHuAxjjBFlrOG1jAzFYnBFsTIkbXPodE+pVWwPvAB6Fc00XRrqeMbup6WOBWVdj2BvdIzesqKjxN0rLQWs25xbQu6dYFZIcTJIMj1XTu0Gw+ajQxZrnV2jdQ/bJ005rJnimbUqN3EnGzdN00CzZP4g1ogKB2MJWcw2KcXdFcfiyBZNIsb1cVJvoPml+JxElL/ALSTZcYiuG3KlIHfFcVDYG6QUsX3mknQo4li5MHdK8E01HCNOa1jHYq2eh9m4d3g60m07rTESEp7P0w2mAI62TVu655clxZiMKQe6bfLoeYWX/tA4O59Jr6Y77L2MWi8c9jHRP8AtBinUcrg1xa4httjrfkmFNjalO/ekaK0ZOLTIe5+dKFdx98Q4awE7w4FVuXRw06p92j7PMbWc6mT3jmIMWPIf1UOD4WwS7KZHz9dPBdU+oh2MqoUYbh9VzsocRqAbwf4TF7kxHVXqHZ+liKDzUztxDP2QMhpcHQW6mBAaJ2JFubqoWZQXU2nYmLjzSwYr2ZOW3gfkVj7U72DaRlcZw3Ehwc/2rSHOcCJzNz6kMMQZGoIH07ZxDF0+6WvqxABcA7KAA0MGZpIAA0t4Lb4jjL6jS4U3Ft3SBmyg2IJ3HySSpjROnoCtX1WR7aEyrdCfguHY2nnr1C0EfieQImwa3fUX62TPgmIwYD3OyvpE5XNY1rK1gb5nGSDANiN9dFk8ZQGGcAHiqYcA1zCMh0zBpJvmmJF4XXC+CVKuWDIn3QSLc12ygmnJy5LD3tFw7DeyBwD8wADqjXsDntzF0zWA1B/AdspvKU8M4ZWyiq2s2lmJGd5LRJzjKGtaS5xDXWAtprC+4rh9bC1g+nYsgtjNOZpt7tx5lKcRi6hcXOJzFxdOjgdLR7ovsBoOSvBNxpOwMe0nAK+HDX1HtqscSGva4m41aWnvNOmyoYPAVKjmMYAXG7QBJIkkusDmiD4R0Udd7XOL3Pe8kCS73nOi/eJNupv0TSr2oqmhToMa2mKcZXMBzyJvmJsYO2su5q/v0lz9iBvwLA0GNr+3p1W1AJ9tVApik7WnDTLu84kTM2bEJBSrtaXVPfgsMkQSfTnPzTbg/EazqNX2r6Rp5Mk1cty6XMaH+8DIJDRtJspcI4YRoecNSef/UioBlvMe7JFrg6SNVjbTd7sMR1+IOrVQ9wOcfugDxJMbfqE3oVqhb7Jtw4g5TJOa99ZkyfFGI7U4msA2mGUg1/tAaQ9m7cXLbkAOIvZfcHxR1JrqgqgF1iGCMttM1pJG4k31upmnVUCXDVHCQWZchh0gZgSdHb+RTSgwuaXAWG+3qbLLYrHB1QVBTbUfuHS+dJcWz7xvJuFfrcTpPkvqSJkNDSTzJB8egA8FnPE+QmaXCsaS0PJEmDA0HOT+Sr419NriWnuzaTtssxV40wANpscTeSTY3tGpA67rrDYt9QtGVgBMepjle8KnoSW7J1D2jjsxjQeCmLnmS0ggdPoqVGuacw1t5AcTMf/ABiCfhbRD8Q5xBnTYANHk0WVHEWWhWedD56K81rYB9pmcdgD3fEnXyCWMfP+wTDCkDQX/XoqyJsZYcEaqVuKa1U203G5Jhc16P7oPms9ibHNPHCLlfTxLNIFgFnaeHqONhZXmUYETpr+ShxSGoZDFho6lVcXxW3gl2Kc6JFz8lQbIIzc9PipjFMaifHYnvAxqBPidVd4bcgbc0pqUHOOYmBrKd8FDXGDIaCBO5JurS2QR6LwGMqv18QGuy9JSbAV2sbDbhXOJ0srM8y63ouV8mhBXxbXzTdpPruF3hnhlm2CyuIxLnQRNidbWVqhiXtLc5IG0zBHirOJFkfHqYLi8a/AjW6WV6vdmxkRa2hBHyHqrvEcW0idpj1SOuY00PL6qFjtlGR1MRt8J3VCu1zSKgJEEQdYOold446OiQlePxuWm4AEjpqPy8V0Y8KvZFGhice9rA9lVxLZkARlggyDPe1ClOEL+8XMvf8ACPhNlmuH8ZY2zgWkgCTfzcbEeh8U+oY1sXMeABVsyljfBS/Jia+I9ue9YtYe86oTZu3e52AA3O6ZcB4l7AVu8M2UBliSSTGotuLdFSocOD3QXijTzRmqwcpdZshok6XMQJXH91nO6m2HVG2gOaQ4icxYdCIgi4t8PRai1pfBcuY7iNYg06l5946AGdGka9fMbKGjgaRDu93sls3dax2+7ibwATGqrYnFZhFQmo4H3s8NDRms225IPy1U+B4qGF0t7jmuGRoEExDJc4GACS6w58ymlpbAXOoECTAkAgTcg6W/WhXDYvM9IMetlbqVKTy2S9gLpcAAWtnUsaSPSbcyrLOHszZMwLoghxDCHHcnKbCf6rRzrkgnwuJbUaA5rKbGSWsaLGwDnOJlzz1JjoFWxTwe/mIbPdkzm2Jay0ARCu0uCV6rAylSa5wJByHUHbM4wT08FPjeBup9zEMDGtaXNdShxdmBfAlwzZScpvYkQDN8VKCfJNGeqVXOJcbE6wAB6BOuBdm8RiCXMbOQSGlzQXa2ZJubH9aROoUGsBGfMBcPaZJ1sPd5QOk+DV/aKtXZSpCp7H2QMPzZS4WADi0Ay2XRGzipnOVe6ilpciPH4B9J5ZUysfYOY0zrqDllvQidQQq/shtKfcH7P1MQ1xaQGU2nvEjb3WhutyTtzKe9nOzuHdRqvxDHktLIc0wGz+EgSDO5vtoqT6iGNbsp70uDL8M4d7SoBSo1KpifZtGY2jUtvl6xumj+yuLyuc+iaLRs4ZXOHhEujmdJW3wuPbhWu+yimym9pdb3i+2VpknxjlKjPaCpW7zyQWnuwYvmzNMDcTHgFwz6537q+pbQuGzK4Xsu5pmRmjeRaNgRdMKPC6Ydle6SADYjJcAwXT12/qrDqzr3sRqTM7wQvrcM9wzGIAHLTw5Lnl1E5csLbhElalTLvu2w0aAAD46n1UtJsGw9FGMrI3BtMxf+GPJFdpzADztEDlCxlOT7l7LVN7Z7zonxPryUjGiZOm3LxjdUA0TraR8NLK0cRAMa6TyHTx/JVJUi/VqgSBAFp8TtKV1XzKjdUOxVOq8zBMIpEORadVaLDdc0qLSS46RpzP6lVnVRsNN0Pr5Wq0HLUqIT3KXEcYTYLjAY6HBpBubeKgr1HEO9mxz3RMNBJiYmB1I9VxgMJUY4GvSeyo6zQ5rm5ZJAkEC/62XqKK0l7PUeHVxAVjimMzAjoPTkkFKpka24M7jRfOKYxzch2dI8xFlx6dzSwxQqF2doJDQC6I05xqrr+Kg0jRdfdhjQ63+XmlDOIkEmSIBAtGtjfzVaq4OyhpE666Sr6fJFnytWJ7p0PwUT2zoVHjqoD8szlETz5mFA2sL+BV0iCHGVNQCq+LZmoOnYgtdA10gHcXVeoLwZ6KTDOaWua90WtK2SoqZbh7TnDC1hImz5g7wTIjx6qxi8U5roNMU+TQ92nW5k7eSXYioS8md7H6yrlDGtAio0OOxc0Ex4k+K75R7lTcYDhmFqBtapmzEHKYP4bEZgIET8Ul7QYbC03MGHZLjm1bInSSJED18F6BxTE03FrXkayAIkWiBFulkww3ZSk9kezb3tS6T8V5cc+l27NNJ5hwTsVVxmFqYmnVY+oHENpmxdlse9IDXXEA2gbJXg+yOMqCRRLW5spNQhkbEw4hxA5gFej4vsfWw5jCuADnSQHEeUQrp7N13AvxNYEEzAvfwAA+K29rkrpquxGk85wPZFzqpYCahkwGCBAOrnH3RHIFNsL2SDJDyGvme8JdPISbDzJXqnAsFQpt7pNrxzJ3PpoFHxjgTcS/PlDo/FmLTb8Jj3lhLqpt7stoPJeK4l2HgU6oLmmZEmD6623OwSCtxOpUILnS6ZnKLEnUAeJt1XovbLsYWsdUGHDWi5ewhxtMEtmbTrdZDgvAHucIaXlziwMDJJi+YH8I0uV1YsmPRfcymndDH+6auKDSAG5YyucY90RZv62Tyv2LpMplzqhfVIMmBEwL96fmttwbstlbTNY3EEMabAxuYun9LhFMd6CD4n0hcUuofCL+mu549hez1ZjHPoFxpvDWvgRJ3A5gaJ5hqLqOGLAHZ3GXS20RbbZenimAIAgJV2gphzILXO/lEkRdc+WTm7ZKxqPB5VisJVEvc1wBEnYX1ka+qiD7Df4WTDi9R7DmzEtfIg3+lkmymJ16cvNYMxlKnRbp12g841G3gp6mLcXWhoOw0iLW6qD7E5rGG2R/e5wbiOcxB8wuiwTnP68ksJM7dSOYZttOqsOqkyHabncqM1S0uJsQPnoqbDIzHc2+ZUh0i/TqgnK0QOe/jK5fJE7SoWPE6aqQuME7D58h8Ue4sq16xmF8bc3228OSiZTLiXfqV2BcDcIiidkWLrim3MfIc11wPh9bGPEQ1l5OttoCX45vtXgTZto6rUUeKtwuHJETHwXfDHoiq+J/YtFW9+DYcKo4TBMysIzx3nuiXE8yNuQSDCcTZi6zqrnGGP7kAQT3QA61xr1vsvOavFKlRwql5DBOc6xePPUR4rddm3h1ECjTLAyHEiJe437ztJM2/lVp4XBXLk2jK+C7xLFhwDXDMATP4Zi1uSz1fFmmQDMC4E5iNPoAnHFmgtDKZBLS4WkwZBykxrc+nVP+yPZxl6tVoLibDYfmfgqJqKtluTNZ6uIZNNji0e8YtHjolYpubfLIB2GnovcaTAAAAAOQFvRZPtdhmU2uqwBMN01Gh8bKscu9US0eb8TaC+RFwPkqNJ890+SbVsAwljc/4PfJOVxBgbW/2vdJQS0kjb9aLpjwUZyTNjtH9PmunYQnUtbrc2mdp3lcCoM4dG+nTkmRqB0w0XkQrNtEGLxWBcT7sayRoeRjbqqbIFnZgfGPhC01Wi0ghwuNCLEH8ikONGVwDgCYFzE/1Xbiyatip6hwrDH2gfUIteOZ6jkFoMX2kFMWI63WF4mK1GMo9qXalvdZT6Xu7czpsqwrMbL3OzmQAyBJcdInbyXm+lq3NLo9D4ZxptV0NMkz5c1PjuJAtcxsufBgcyOir9nuzdWrS++JoAkFrWBodGsuNwPDVa7A8Fo0vdbJ3c4y4+J+mi55OKZdGLZhsZ7PPUaKZIgHMLCdwDZW8B2jcPuRSqF4tYGJB56Fbi3JcikNYCrrvlChfRruvmi9iFPgqLGDutA8AApXYMEypWYYBVJOwV0Soy2FDiXwNdlAIuIY1rATO4HqlfG+LhrO6TJIaHDadJG949Uk7QuDiWiqW93McwtqABbqfgkDK1QUnNpn2hkXbJyASdTvt6wqtlHKhjjcNmptqe0JaTEWgST3vAjkk1WnTFeXOlrTbLFze3LUDyV/GcMGHjPVNRr2OMARlqEWBE3E72VAOpsaAwhxhwNoAnxm/ny5KrMZfMjxpJ7rbXnu2EWAAG1lFDdCNNVaoE6l0DqbRBj56KpXdmdeJ6WHiqkX3OqtLO/nMT4D4lR4uBblPlyUrnBuhvuR5WBVV1YOcAFYiTJMN3W5ovoPPU/rmoq9QRGY+WijxlYm2w0VemCShRvsTUnmFYpaE6kqBlO8eS7xIIEAnqrQi5OkSkIeOVnMeQ1xggE+KrY+vUfRZUvA7pBFjBJB+Ku8ewls4sAIM7/wBZ+aRVMY/2Zpz3Z9OgXuYVcI1yi0dmxnw2mHUg0tsSXHreB4xC2XZjEPJ9k12UGfpfxsshwqrLWwIi3putTwupFgL2WGfezWJs8Jw6SBvaXbmFssBRDWgBZ7g1wOa0lJ0BedJmqJMRiA0SSkGMxFJ7Qa4E5jkBM2IsSNBolHbPHusGG7ZMc9/okrcFWxAZSdSNJrfdc4y515c8kdAB+rWjDa2GxR2wxI+0VGNADWkZQBAFgbDzSB1WZJ1P6KfdscOwPY+ke64QDMyWAAnoZhZupVHnF5+MLtxq4qjJ8ndESQFciAYMxHn+aX4d3eF4B3TyvgGZWupVM0gTNjm5AKZbMIRY+pkkm2/Tn5ql9opVAHNqupGAHNJ/EBBItobfLaS34tgy+mRYOiINuSygwL9xB5EH6BdGHS1zuQzfD/s2K8KP+tySdmP+96f85/0FCFlj+Gf7P8It3P0TR0ClKELyjUGr6viEB2uyvqEBSxm3iPqq2J0CEIDE9qtXfyfVL+zejP8A3mfJCFXuYv4jrtB7rPB30WeH5oQqSMsnJNuPD8lyfePkhCqiqOMVof1uoMFqfB3yQhXIfJHV0HgvuF1HivqEIXJYp+8fNfK+oQhXx8s1XAr7Re4f5j81ma/7Mfzu+TUIXr9D/K/uyq5HXCvcZ4Bafg/7QeS+IVMvLNkekcH0Tp2nkUIXnPk2POe1P7cfrda2h+zp/wAiELSXwoqjyrjH7HDfy1f/ALXpXiPfPihC7YcfUyZFTTbg3vN8QhCmfBKJO0HuO8D9Ujq6+vzK+IU4uA+T/9k=\", \r\n \"ImageContentName\": \"huury.jpg\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://.midmetrics.io/api/chargeback/uploaddocument","description":"Uploads a document (base64 encoded) to associate with a chargeback. Auto-creates a draft representment if one doesn't exist.
\nExamploe paylod:
\n{
\"ChargebackId\": 45678,
\"ProcessorCaseId\": \"CASE98765\",
\"DocumentType\": \"Signed Contract\",
\"Title\": \"Customer Agreement\",
\"Notes\": \"Signed contract received from the customer on March 25, 2025.\",
\"ImageContent\": \"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8...\", // shortened Base64 string
\"ImageContentName\": \"signed_contract.pdf\"
}
\nImageContent should be a base64-encoded string of the file contents
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","chargeback","uploaddocument"],"host":["","midmetrics","io"],"query":[],"variable":[]}},"response":[{"id":"b0feaaf2-59ed-4b17-9170-7d55f0f91215","name":"Example Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ChargebackId\": \"9924069185 - 01\",\r\n \"ProcessorCaseId\": \"9924069185 - 01\",\r\n \"DocumentType\": \"Signed Contract\",\r\n \"Title\": \"Customer Agreement\",\r\n \"Notes\": \"Signed contract received from the customer on March 25, 2025.\",\r\n \"ImageContent\": \"SGVsbG8gZnJvbSBDaGF0R1BUISE=\", // shortened Base64 string\r\n \"ImageContentName\": \"signed_contract.pdf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://.midmetrics.io/api/chargeback/uploaddocument"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"144"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 28 Mar 2025 22:30:02 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d5d7734f-f522-4898-ad87-d7cf6e51537a"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"\"File uploaded successfully.\""},{"id":"ff686d23-40af-404a-9630-4c73e06f1752","name":"Example with bad chargeback id","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ChargebackId\": 45678,\r\n \"ProcessorCaseId\": \"CASE98765\",\r\n \"DocumentType\": \"Signed Contract\",\r\n \"Title\": \"Customer Agreement\",\r\n \"Notes\": \"Signed contract received from the customer on March 25, 2025.\",\r\n \"ImageContent\": \"SGVsbG8gZnJvbSBDaGF0R1BUISE=\", // shortened Base64 string\r\n \"ImageContentName\": \"signed_contract.pdf\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://.midmetrics.io/api/chargeback/uploaddocument"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"32"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 28 Mar 2025 22:25:12 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"Cache-Control","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Pragma","value":"no-cache"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d5d7734f-f522-4898-ad87-d7cf6e51537a"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"Message\": \"No such chargeback\"\n}"}],"_postman_id":"6bb036c4-150f-4404-b7c0-de3bbb4213e8"},{"name":"SubmitRepresentment","id":"723d6ed9-4b6f-470f-b848-e3cd40419545","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"MidMetricsId","value":"","type":"text","uuid":"70f7c9cb-a3f7-414e-84f5-f9723309ab90"},{"key":"ProcessorCaseId","value":"","type":"text","uuid":"3e349bc9-341d-48d1-8d3e-fa2f4b833873"},{"key":"TrackingNumber","value":"","type":"text","uuid":"51a5fee4-45cc-4a87-a1ec-dd44222a4352"},{"key":"File","type":"file","uuid":"adf7fda2-4daa-44f5-aea2-8601b75c5e70","value":null}]},"url":"https://.midmetrics.io/api/Chargeback/SubmitRepresentment","description":"Submit Representment
\nThis endpoint is used to submit a representment letter for a chargeback to the specified processor. A representment is a process where a merchant disputes a chargeback with supporting documentation. The file submitted should be the complete representment letter to be submitted to the processor.
\n\n\nRequest Body
\nThe request body must be sent as form-data and should include the following parameters:
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\nMidMetricsId | \ntext | \nThe unique identifier for the Chargeback inside midmetrics. This value must be retrieved by the Events webhook | \n
\n\nProcessorCaseId | \ntext | \nThe unique identifier for the processor case.
For testing, use the value \"test.
In test mode the system will verify the API call is valid and not process the request. | \n
\n\nTrackingNumber | \ntext | \nThe tracking number associated with the shipment. | \n
\n\nFile | \nfile | \nA file containing the Representment Letter. | \n
\n\n
\n
Response Structure
\nUpon successful submission, the response will return the following
\n{\n \"ProcessorId\": {processorCaseId},\n \"TrackingNumber\": {trackingNumber},\n \"BytesSaved\": {bytesOfSubmittedFile},\n \"Message\": \"Representment queued for submission\",\n}\n\n
\n\nProcessorId**:** The processor id submitted with the request.
\nTrackingNumber**:** The tracking number submitted with the request.
\nBytesSaved**:** The number of bytes of the submitted file.
\nMessage: String \"Representment queued for submission\" if submission succesful.
\n
\nExample Request
\nPOST /api/Chargeback/SubmitRepresentment\nContent-Type: multipart/form-data\n{\n \"MidMetricsId\": \"100\", \n \"ProcessorCaseId\": \"123456\",\n \"TrackingNumber\": \"ABC123456\",\n \"File\": <binary file>\n}\n\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","Chargeback","SubmitRepresentment"],"host":["","midmetrics","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"723d6ed9-4b6f-470f-b848-e3cd40419545"},{"name":"UpdateRepresentment","id":"fb5f8c49-c459-451d-bd74-69f11b100fb6","request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"data","type":"text","contentType":"application/json","value":"{\n \"MidMetricsId\": 9801,\n \"SubmitResult\": false,\n \"Representment\": {\n \"OrderInfo\": {\n \"MerchantOrderId\": \"ORD-20240115\",\n \"DateOfOrder\": \"2024-01-10T00:00:00Z\",\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"DateShipped\": \"2024-01-11T00:00:00Z\",\n \"DateDelivered\": \"2024-01-13T00:00:00Z\",\n \"OrderAmount\": 149.99,\n \"Currency\": \"USD\",\n \"BillingContact\": {\n \"Name\": \"Jane Smith\",\n \"Address\": \"123 Main St\",\n \"City\": \"Springfield\",\n \"State\": \"IL\",\n \"Zip\": \"62701\",\n \"Country\": \"US\"\n },\n \"Products\": [\n { \"Description\": \"Widget Pro\", \"Sku\": \"WGT-001\", \"Quantity\": 2, \"PricePer\": 74.99 }\n ]\n },\n \"RepresentmentTransactionInfo\": {\n \"AuthCode\": \"AUTH42\",\n \"WasCustomerServiceContacted\": true,\n \"LastCustomerServiceContactDate\": \"2024-01-16T10:00:00Z\",\n \"LastCustomerServiceContactReason\": \"Customer disputed delivery\"\n },\n \"CustomDisputeValues\": [\n { \"ParameterName\": \"ReturnPolicyUrl\", \"ParameterValue\": \"https://example.com/returns\" }\n ],\n \"Documents\": [\n { \"Key\": \"invoice\", \"Title\": \"Order Invoice\", \"DocumentType_Id\": 3 },\n { \"Key\": \"proof\", \"Title\": \"Delivery Confirmation\" }\n ]\n }\n}\n"},{"key":"invoice","type":"file","value":null},{"key":"proof","type":"file","value":null}]},"url":"https://.midmetrics.io/api/chargeback/UpdateRepresentment","description":"UpdateRepresentment
\nUpdates representment data and/or attaches supporting documents for an existing chargeback.\nThe raw request payload is archived to blob storage ({tenant}-representmentupdates) for auditing.
\nAuthentication
\nStandard Service API key — same header as all other api/chargeback endpoints.
\nRequest
\nContent-Type: multipart/form-data
\nThe request has two kinds of parts:
\n\n\n\n| Part name | \nContent-Type | \nRequired | \nDescription | \n
\n\n\n\ndata | \napplication/json | \nYes | \nJSON payload (structure below) | \n
\n\n| {key} | \n(any) | \nNo | \nOne file part per entry in Representment.Documents, named to match that entry's Key field | \n
\n\n
\n
JSON Payload (data part)
\nThe JSON structure mirrors the response returned by GET api/representment/GetRepresentmentInfo.\nAll sections and fields within Representment are optional — send only what you want to change.
\n{\n \"MidMetricsId\": 123,\n \"ProcessorCaseId\": \"CB-20240115-001\",\n \"SubmitResult\": false,\n \"Representment\": {\n \"OrderInfo\": { ... },\n \"RepresentmentTransactionInfo\": { ... },\n \"CustomDisputeValues\": [ ... ],\n \"Documents\": [ ... ]\n }\n}\n
\nTop-level fields
\n\n\n\n| Field | \nType | \nRequired | \nDescription | \n
\n\n\n\nMidMetricsId | \nint | \nOne of these two | \nMidMetrics internal chargeback ID | \n
\n\nProcessorCaseId | \nstring | \nOne of these two | \nProcessor-assigned case ID | \n
\n\nSubmitResult | \nbool | \nNo (default false) | \nWhen true, renders the representment to PDF via DocRaptor, uploads it to blob storage, creates a RepresentmentSubmission record, logs a chargeback action, updates the chargeback state (DISPUTED or NEEDSMANUALSUBMISSION depending on the processor's submission type), and queues transmission to the processor. Check Submitted in the response to confirm this actually completed. | \n
\n\nRepresentment | \nobject | \nNo | \nContainer for all representment data; omit to skip all data updates | \n
\n\n
\n
Partial-update semantics
\nThese apply to all scalar fields inside Representment:
\n\n\n\n| JSON | \nEffect | \n
\n\n\n\n| Field absent from payload | \nNo change — existing value preserved | \n
\n\nField present with null | \nClears the value in the database | \n
\n\n| Field present with a value | \nSets the value | \n
\n\n
\n
Arrays (Products, CustomDisputeValues, Documents) use full-replace semantics:
\n\n\n\n| JSON | \nEffect | \n
\n\n\n\n| Array key absent | \nNo change | \n
\n\nArray present (even []) | \nExisting rows deleted and replaced with the provided list | \n
\n\n
\n
Representment.OrderInfo
\nScalar fields match RepresentmentOrderInfoVM / OrderInfo entity properties directly.
\n\n\n\n| Field | \nType | \nNotes | \n
\n\n\n\nMerchantOrderId | \nstring | \n | \n
\n\nTrackingNumber | \nstring | \nSetting a non-empty value triggers a Shippo tracking lookup | \n
\n\nDateOfOrder | \ndatetime? | \nISO 8601 | \n
\n\nDateShipped | \ndatetime? | \n | \n
\n\nDateDelivered | \ndatetime? | \n | \n
\n\nEmail | \nstring | \n | \n
\n\nIPAddress | \nstring | \n | \n
\n\nPhone | \nstring | \n | \n
\n\nDeliveryLocation | \nstring | \n | \n
\n\nDeliveryNotes | \nstring | \n | \n
\n\nTax | \ndecimal? | \n | \n
\n\nShipping | \ndecimal? | \n | \n
\n\nOrderAmount | \ndecimal? | \n | \n
\n\nCurrency | \nstring | \ne.g. \"USD\" | \n
\n\nInvoiceNumber | \nstring | \n | \n
\n\nAccountId | \nstring | \n | \n
\n\nShipper_Id | \nint? | \n | \n
\n\nReturnAttemptTooLate | \nbool? | \n | \n
\n\nCancelAttemptTooLate | \nbool? | \n | \n
\n\nMarketingSource | \nstring | \n | \n
\n\nSubMarketingSource | \nstring | \n | \n
\n\nRefundable | \nbool? | \n | \n
\n\nCarRentalDate | \ndatetime? | \nHospitality / travel | \n
\n\nCarReturnDate | \ndatetime? | \n | \n
\n\nFlightDate | \ndatetime? | \n | \n
\n\nCheckInDate | \ndatetime? | \n | \n
\n\nCheckOutDate | \ndatetime? | \n | \n
\n\nAncillaryCharges | \nbool? | \n | \n
\n\nNoShow | \nbool? | \n | \n
\n\nBillingContact | \nobject | \nSee Contact object below | \n
\n\nShippingContact | \nobject | \nSee Contact object below | \n
\n\nProducts | \narray | \nSee Product item below — full-replace | \n
\n\n
\n
Contacts use object-level merge semantics: providing the contact object updates only the non-null fields within it.
\n\n\n\n| Field | \nType | \n
\n\n\n\nName | \nstring | \n
\n\nAddress | \nstring | \n
\n\nCity | \nstring | \n
\n\nState | \nstring | \n
\n\nZip | \nstring | \n
\n\nCountry | \nstring | \n
\n\n
\n
Product item
\n\n\n\n| Field | \nType | \nNotes | \n
\n\n\n\nDescription | \nstring | \n | \n
\n\nSku | \nstring | \n | \n
\n\nQuantity | \nint | \n | \n
\n\nPricePer | \ndecimal | \nUnit price | \n
\n\nWasReturned | \nbool? | \n | \n
\n\n
\n
Representment.RepresentmentTransactionInfo
\nScalar fields match RepresentmentTransactionVM / RepresentmentTransactionInfo entity properties.\nRead-only derived fields returned by GetRepresentmentInfo (e.g. Descriptor, AVSCodeDescription) are silently ignored if sent.
\n\n\n\n| Field | \nType | \n
\n\n\n\nAuthCode | \nstring | \n
\n\nCancelled | \nbool? | \n
\n\nCancelDate | \ndatetime? | \n
\n\nCancelReason | \nstring | \n
\n\nWasCustomerServiceContacted | \nbool? | \n
\n\nLastCustomerServiceContactDate | \ndatetime? | \n
\n\nLastCustomerServiceContactReason | \nstring | \n
\n\nDeviceId | \nstring | \n
\n\nGeoId | \nstring | \n
\n\nOTP_SMS | \nstring | \n
\n\nAddOns | \nbool? | \n
\n\nHasProof | \nbool? | \n
\n\nProofDate | \ndatetime? | \n
\n\nProofType | \nstring | \n
\n\nRecurring | \nbool? | \n
\n\nRefundARN | \nstring | \n
\n\nRefundAuthCode | \nstring | \n
\n\nRefundAmount | \ndecimal? | \n
\n\nRefundDate | \ndatetime? | \n
\n\nExternalRefundId | \nstring | \n
\n\n
\n
Representment.CustomDisputeValues
\nFull-replace array. Each item:
\n\n\n\n| Field | \nType | \nNotes | \n
\n\n\n\nParameterId | \nint? | \nPreferred — looked up by DB id | \n
\n\nParameterName | \nstring | \nFallback if ParameterId absent | \n
\n\nParameterValue | \nstring | \nThe value to store | \n
\n\n
\n
Representment.Documents
\nFull-replace array. Each item describes one file attachment.\nThe corresponding file must be sent as a named multipart part whose name matches Key.
\n\n\n\n| Field | \nType | \nNotes | \n
\n\n\n\nKey | \nstring | \nMust match the name of the file part in the multipart request | \n
\n\nTitle | \nstring | \nDisplay title (defaults to filename if omitted) | \n
\n\nNotes | \nstring | \nOptional notes | \n
\n\nDocumentType_Id | \nint? | \nOptional document type classification | \n
\n\n
\n
Response
\n200 OK
\n{\n \"MidMetricsId\": 123,\n \"RepresentmentId\": 456,\n \"PdfPreviewUrl\": \"/api/chargeback/GetRepresentmentLetter?midMetricsId=123\",\n \"DocumentsAdded\": 2,\n \"SubmitRequested\": true,\n \"Submitted\": true,\n \"PdfPages\": 3,\n \"PdfSize\": \"0.42 MB\",\n \"PdfOverBudget\": false,\n \"PdfWarning\": null\n}\n
\n\n\n\n| Field | \nDescription | \n
\n\n\n\nMidMetricsId | \nChargeback ID | \n
\n\nRepresentmentId | \nRepresentment record ID | \n
\n\nPdfPreviewUrl | \nURL to retrieve the PDF — use GET api/chargeback/GetRepresentmentLetter (API-key authenticated). No longer the session-gated DisputeGenius URL. | \n
\n\nDocumentsAdded | \nNumber of documents successfully uploaded in this request | \n
\n\nSubmitRequested | \nWhether SubmitResult: true was sent in the request | \n
\n\nSubmitted | \nWhether the PDF was actually generated and transmission was queued, as distinct from SubmitRequested (what was asked). false if SubmitRequested was true but the template or PDF generation failed (the data save still succeeded) | \n
\n\nPdfPages | \nNumber of pages in the generated PDF | \n
\n\nPdfSize | \nHuman-readable size of the generated PDF (e.g. \"0.42 MB\") | \n
\n\nPdfOverBudget | \ntrue if the PDF exceeds the processor's page or size limits | \n
\n\nPdfWarning | \nHuman-readable description of which limit was exceeded, or null | \n
\n\n
\n
Error responses
\n\n\n\n| Status | \nCondition | \n
\n\n\n\n| 400 Bad Request | \nMissing data part, invalid JSON, or neither MidMetricsId nor ProcessorCaseId provided, or ProcessorCaseId provided with MidMetricsId but they refer to different chargebacks | \n
\n\n| 403 Forbidden | \nMissing or invalid API key | \n
\n\n| 404 Not Found | \nNo chargeback found for the provided identifier | \n
\n\n| 415 Unsupported Media Type | \nRequest is not multipart/form-data | \n
\n\n| 500 Internal Server Error | \nUnhandled exception — check server logs | \n
\n\n
\n
Example — clear a field (set to null)
\n{\n \"MidMetricsId\": 9801,\n \"Representment\": {\n \"RepresentmentTransactionInfo\": {\n \"CancelDate\": null,\n \"CancelReason\": null\n }\n }\n}\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","chargeback","UpdateRepresentment"],"host":["","midmetrics","io"],"query":[],"variable":[]}},"response":[{"id":"d78dac4f-5f39-47fd-8fa2-b19dec3fdec6","name":"Example Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"data","type":"text","contentType":"application/json","value":"{\n \"MidMetricsId\": 9801,\n \"SubmitResult\": false,\n \"Representment\": {\n \"OrderInfo\": {\n \"MerchantOrderId\": \"ORD-20240115\",\n \"DateOfOrder\": \"2024-01-10T00:00:00Z\",\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"DateShipped\": \"2024-01-11T00:00:00Z\",\n \"DateDelivered\": \"2024-01-13T00:00:00Z\",\n \"OrderAmount\": 149.99,\n \"Currency\": \"USD\",\n \"BillingContact\": {\n \"Name\": \"Jane Smith\",\n \"Address\": \"123 Main St\",\n \"City\": \"Springfield\",\n \"State\": \"IL\",\n \"Zip\": \"62701\",\n \"Country\": \"US\"\n },\n \"Products\": [\n { \"Description\": \"Widget Pro\", \"Sku\": \"WGT-001\", \"Quantity\": 2, \"PricePer\": 74.99 }\n ]\n },\n \"RepresentmentTransactionInfo\": {\n \"AuthCode\": \"AUTH42\",\n \"WasCustomerServiceContacted\": true,\n \"LastCustomerServiceContactDate\": \"2024-01-16T10:00:00Z\",\n \"LastCustomerServiceContactReason\": \"Customer disputed delivery\"\n },\n \"CustomDisputeValues\": [\n { \"ParameterName\": \"ReturnPolicyUrl\", \"ParameterValue\": \"https://example.com/returns\" }\n ],\n \"Documents\": [\n { \"Key\": \"invoice\", \"Title\": \"Order Invoice\", \"DocumentType_Id\": 3 },\n { \"Key\": \"proof\", \"Title\": \"Delivery Confirmation\" }\n ]\n }\n}\n"}]},"url":"https://.midmetrics.io/api/chargeback/UpdateRepresentment"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"MidMetricsId\": 123,\n \"RepresentmentId\": 456,\n \"PdfPreviewUrl\": \"/DisputeGenius/GetRepresentmentLetter?representmentId=456\",\n \"DocumentsAdded\": 2,\n \"SubmitRequested\": false\n}\n"}],"_postman_id":"fb5f8c49-c459-451d-bd74-69f11b100fb6"},{"name":"GetEnterpriseParameters","id":"e058678b-5830-408c-810f-54541a72d7eb","request":{"method":"GET","header":[],"url":"https://.midmetrics.io/api/chargeback/GetEnterpriseParameters","description":"GetEnterpriseParameters
\nReturns all active custom dispute parameter types and document types configured for this enterprise.\nUse this endpoint to populate dropdowns and validate values before calling POST api/chargeback/UpdateRepresentment.
\nThe same data is also available at GET api/representment/GetEnterpriseParameters (identical response, different controller).
\nAuthentication
\nStandard Service API key — same header as all other api/chargeback endpoints.
\nRequest
\nGET api/chargeback/GetEnterpriseParameters\n
No request body or query parameters.
\nResponse
\n200 OK - application/json
\n{\n \"CustomDisputeParameters\": [\n {\n \"BusinessCategory\": \"All\",\n \"CustomParameters\": [\n {\n \"Id\": 12,\n \"Name\": \"ReturnPolicyUrl\",\n \"DataType\": \"string\",\n \"EnumValues\": null\n },\n {\n \"Id\": 14,\n \"Name\": \"ShipmentCarrier\",\n \"DataType\": \"enum\",\n \"EnumValues\": \"UPS,FedEx,USPS,DHL\"\n }\n ]\n },\n {\n \"BusinessCategory\": \"Travel\",\n \"CustomParameters\": [\n {\n \"Id\": 20,\n \"Name\": \"FlightNumber\",\n \"DataType\": \"string\",\n \"EnumValues\": null\n }\n ]\n }\n ],\n \"DocumentTypes\": [\n {\n \"Category\": \"Proof of Delivery\",\n \"DocumentTypes\": [\n {\n \"Id\": 3,\n \"DocumentType\": \"Signed Delivery Receipt\",\n \"Tooltip\": \"Carrier signature confirmation\",\n \"WhereToFindData\": \"Carrier portal or tracking email\"\n }\n ]\n },\n {\n \"Category\": \"Terms\",\n \"DocumentTypes\": [\n {\n \"Id\": 7,\n \"DocumentType\": \"Terms and Conditions\",\n \"Tooltip\": null,\n \"WhereToFindData\": null\n }\n ]\n }\n ]\n}\n
\nCustomDisputeParameters
\nTop-level array grouped by BusinessCategory.
\n\n\n\n| Field | \nDescription | \n
\n\n\n\nBusinessCategory | \nThe category this group applies to. \"All\" means the parameter applies to all merchants regardless of their business category. | \n
\n\nCustomParameters | \nOrdered list of parameters in this category (by DisplayOrder). | \n
\n\n
\n
Each parameter entry:
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\nId | \nint | \nUse as ParameterId in UpdateRepresentment.Representment.CustomDisputeValues | \n
\n\nName | \nstring | \nHuman-readable parameter name; use as ParameterName if Id is unavailable | \n
\n\nDataType | \nstring | \nOne of string, number, boolean, date, enum | \n
\n\nEnumValues | \nstring? | \nComma-separated list of allowed values when DataType is \"enum\"; null otherwise | \n
\n\n
\n
DocumentTypes
\nTop-level array grouped by Category.
\n\n\n\n| Field | \nDescription | \n
\n\n\n\nCategory | \nDocument category label | \n
\n\nDocumentTypes | \nList of document types in this category | \n
\n\n
\n
Each document type entry:
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\nId | \nint | \nUse as DocumentType_Id in UpdateRepresentment.Representment.Documents | \n
\n\nDocumentType | \nstring | \nDisplay name of the document type | \n
\n\nTooltip | \nstring? | \nShort description of when/why to use this type | \n
\n\nWhereToFindData | \nstring? | \nHint to the merchant about where to obtain this document | \n
\n\n
\n
Error responses
\n\n\n\n| Status | \nCondition | \n
\n\n\n\n| 403 Forbidden | \nMissing or invalid API key | \n
\n\n| 500 Internal Server Error | \nUnhandled exception - check server logs | \n
\n\n
\n
Usage with UpdateRepresentment
\nTypical workflow:
\n\n- Call
GetEnterpriseParameters once to discover the available parameter IDs and document type IDs. \n- Build your
UpdateRepresentment payload using those IDs: \n
\n{\n \"MidMetricsId\": 9801,\n \"Representment\": {\n \"CustomDisputeValues\": [\n { \"ParameterId\": 12, \"ParameterValue\": \"https://example.com/returns\" },\n { \"ParameterId\": 14, \"ParameterValue\": \"FedEx\" }\n ],\n \"Documents\": [\n { \"Key\": \"receipt\", \"Title\": \"Delivery Receipt\", \"DocumentType_Id\": 3 }\n ]\n }\n}\n
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","chargeback","GetEnterpriseParameters"],"host":["","midmetrics","io"],"query":[],"variable":[]}},"response":[{"id":"19562f93-fb28-4d30-9b39-a298fc3f67b5","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://.midmetrics.io/api/chargeback/GetEnterpriseParameters"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"CustomDisputeParameters\": [\n {\n \"BusinessCategory\": \"All\",\n \"CustomParameters\": [\n {\n \"Id\": 12,\n \"Name\": \"ReturnPolicyUrl\",\n \"DataType\": \"string\",\n \"EnumValues\": null\n },\n {\n \"Id\": 14,\n \"Name\": \"ShipmentCarrier\",\n \"DataType\": \"enum\",\n \"EnumValues\": \"UPS,FedEx,USPS,DHL\"\n }\n ]\n },\n {\n \"BusinessCategory\": \"Travel\",\n \"CustomParameters\": [\n {\n \"Id\": 20,\n \"Name\": \"FlightNumber\",\n \"DataType\": \"string\",\n \"EnumValues\": null\n }\n ]\n }\n ],\n \"DocumentTypes\": [\n {\n \"Category\": \"Proof of Delivery\",\n \"DocumentTypes\": [\n {\n \"Id\": 3,\n \"DocumentType\": \"Signed Delivery Receipt\",\n \"Tooltip\": \"Carrier signature confirmation\",\n \"WhereToFindData\": \"Carrier portal or tracking email\"\n }\n ]\n },\n {\n \"Category\": \"Terms\",\n \"DocumentTypes\": [\n {\n \"Id\": 7,\n \"DocumentType\": \"Terms and Conditions\",\n \"Tooltip\": null,\n \"WhereToFindData\": null\n }\n ]\n }\n ]\n}\n"}],"_postman_id":"e058678b-5830-408c-810f-54541a72d7eb"},{"name":"GetRepresentmentLetter","id":"e2ead22d-1169-43cd-b6ec-df65813693a6","request":{"method":"GET","header":[],"url":"https://.midmetrics.io/api/chargeback/GetRepresentmentLetter?midMetricsId=9801","description":"GetRepresentmentLetter
\nReturns the submitted representment PDF for a chargeback, authenticated via API key. Replaces the session-gated /DisputeGenius/GetRepresentmentLetter URL that was previously returned in UpdateRepresentment responses.
\nAuthentication
\nStandard Service API key — same header as all other api/chargeback endpoints.
\nRequest
\nGET api/chargeback/GetRepresentmentLetter\n
Query Parameters
\n\n\n\n| Parameter | \nType | \nRequired | \nDescription | \n
\n\n\n\nmidMetricsId | \nint | \nOne of these two is required | \nMidMetrics internal chargeback ID | \n
\n\nprocessorCaseId | \nstring | \nOne of these two is required | \nProcessor-assigned case ID | \n
\n\n
\n
Response
\n\n\n\n| Status | \nDescription | \n
\n\n\n\n200 OK | \napplication/pdf — the submitted representment PDF | \n
\n\n400 Bad Request | \nNeither midMetricsId nor processorCaseId was provided | \n
\n\n403 Forbidden | \nAPI key not authorized for this chargeback's MID | \n
\n\n404 Not Found | \nChargeback not found, or no submitted PDF exists yet (chargeback is still in draft state) | \n
\n\n
\n
Example Request
\nGET api/chargeback/GetRepresentmentLetter?midMetricsId=9801\nAuthorization: Basic {apiKey}\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["api","chargeback","GetRepresentmentLetter"],"host":["","midmetrics","io"],"query":[{"key":"midMetricsId","value":"9801"}],"variable":[]}},"response":[],"_postman_id":"e2ead22d-1169-43cd-b6ec-df65813693a6"}],"id":"2aab7cd8-9a58-4545-a35b-ff3426e7c75b","description":"The representments API allows you to upload a document (Base64 encoded) to associate with a chargeback. Auto-creates a draft representment if one doesn't exist.
\n","_postman_id":"2aab7cd8-9a58-4545-a35b-ff3426e7c75b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"54d4292d-f97f-45e7-b0cc-d3b47acbe5b6","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"fdc42732-a157-407a-9653-c6977070aa0b","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"enterpriseName","value":""},{"key":"APIKey","value":"YourAPIKey"}]}