{"info":{"_postman_id":"c41b625a-4418-4bb3-9d32-e64fa34471fe","name":"MidMetrics Sandbox API","description":"

IMPORTANT: Set the apiKey collection variable to your API key before running any request in this collection -- every request will fail with 403 Forbidden until you do.

Once you have been given rights to generate api keys you can go to https://{{YourEnterpriseName}}.midmetrics.io/Home/About to create a new key. You will then need to email your account manager to request specific rights for that key. Or email service@midmetrics.com for your rights. Once you get your secret apikey, and it is granted rights you can use it in the Authorization header with \"Basic \" (without quotes).

**This is implementing HTTP Basic Authortization described in RFC 7617 https://datatracker.ietf.org/doc/html/rfc7617

Sandbox endpoints at sandbox.midmetrics.io (or test.midmetrics.io).

Authentication: set the apiKey collection variable to your raw API key value. The collection sends Authorization: Basic on every request.

All responses come from static sample data — no database writes ever occur in the sandbox.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18609562","collectionId":"c41b625a-4418-4bb3-9d32-e64fa34471fe","publishedId":"2sBYAuSBQK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-28T16:57:37.000Z"},"item":[{"name":"Representments API","item":[{"name":"GetDocumentTypes","id":"c614aa3a-ae4f-4b31-9997-1f77f46593b4","request":{"method":"GET","header":[],"url":"/api/chargeback/GetDocumentTypes","description":"

Returns the list of document type categories and types available for representment uploads in your enterprise (sample data returned here not representative).

Returns active custom dispute parameter types (grouped by business category) and document types (with IDs) for use in UpdateRepresentment for your enterprise (sample data returned here).

Uploads a Base64-encoded document and attaches it to a chargeback's draft representment.

Required: ImageContent (Base64), ImageContentName (filename with extension).\nIdentify the chargeback with ChargebackId OR ProcessorCaseId.\nAllowed extensions: .pdf .jpg .jpeg .png .gif .bmp

Required. The processor case ID of the chargeback.

\n"},{"key":"MidMetricsId","value":"12345","type":"text","description":"

Required. The MidMetrics internal chargeback ID.

\n"},{"key":"TrackingNumber","value":"1Z999AA10123456784","type":"text","description":"

Optional. Shipment tracking number.

\n"},{"key":"file","type":"file","description":"

Required. PDF representment document (Content-Type: application/pdf).

\n","src":[]}]},"url":"/api/chargeback/SubmitRepresentment","description":"

Submits a pre-built representment PDF for a chargeback.

Content-Type: multipart/form-data.\nRequired fields: ProcessorCaseId, MidMetricsId, and a PDF file part.\nOptional: TrackingNumber (triggers Shippo lookup in production).

Required. JSON payload. Identify the chargeback with MidMetricsId or ProcessorCaseId (or both). Omit fields to leave them unchanged; include null to clear.

\n"},{"key":"doc1","type":"file","description":"

Optional file part - key must match a Documents[].Key value in the data payload.

\n","src":[]}]},"url":"/api/chargeback/UpdateRepresentment","description":"

UpdateRepresentment

Updates representment data and/or attaches supporting documents for an existing chargeback.\nThe raw request payload is archived to blob storage ({tenant}-representmentupdates) for auditing.

Authentication

Standard Service API key — same header as all other api/chargeback endpoints.

Request

Content-Type: multipart/form-data

The request has two kinds of parts:

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

Part name	Content-Type	Required	Description
`data`	`application/json`	Yes	JSON payload (structure below)
{key}	(any)	No	One file part per entry in `Representment.Documents`, named to match that entry's `Key` field

JSON Payload (`data` part)

The 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  \"MidMetricsId\":    123,\n  \"ProcessorCaseId\": \"CB-20240115-001\",\n  \"SubmitResult\":    false,\n  \"Representment\": {\n    \"OrderInfo\": { ... },\n    \"RepresentmentTransactionInfo\": { ... },\n    \"CustomDisputeValues\": [ ... ],\n    \"Documents\": [ ... ]\n  }\n}\n

Top-level 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

Field	Type	Required	Description
`MidMetricsId`	`int`	One of these two	MidMetrics internal chargeback ID
`ProcessorCaseId`	`string`	One of these two	Processor-assigned case ID
`SubmitResult`	`bool`	No (default `false`)	When `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.
`Representment`	`object`	No	Container for all representment data; omit to skip all data updates

Partial-update semantics

These apply to all scalar fields inside Representment:

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

JSON	Effect
Field absent from payload	No change — existing value preserved
Field present with `null`	Clears the value in the database
Field present with a value	Sets the value

Arrays (Products, CustomDisputeValues, Documents) use full-replace semantics:

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

JSON	Effect
Array key absent	No change
Array present (even `[]`)	Existing rows deleted and replaced with the provided list

Representment.OrderInfo

Scalar fields match RepresentmentOrderInfoVM / OrderInfo entity properties directly.

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

Field	Type	Notes
`MerchantOrderId`	`string`
`TrackingNumber`	`string`	Setting a non-empty value triggers a Shippo tracking lookup
`DateOfOrder`	`datetime?`	ISO 8601
`DateShipped`	`datetime?`
`DateDelivered`	`datetime?`
`Email`	`string`
`IPAddress`	`string`
`Phone`	`string`
`DeliveryLocation`	`string`
`DeliveryNotes`	`string`
`Tax`	`decimal?`
`Shipping`	`decimal?`
`OrderAmount`	`decimal?`
`Currency`	`string`	e.g. `\"USD\"`
`InvoiceNumber`	`string`
`AccountId`	`string`
`Shipper_Id`	`int?`
`ReturnAttemptTooLate`	`bool?`
`CancelAttemptTooLate`	`bool?`
`MarketingSource`	`string`
`SubMarketingSource`	`string`
`Refundable`	`bool?`
`CarRentalDate`	`datetime?`	Hospitality / travel
`CarReturnDate`	`datetime?`
`FlightDate`	`datetime?`
`CheckInDate`	`datetime?`
`CheckOutDate`	`datetime?`
`AncillaryCharges`	`bool?`
`NoShow`	`bool?`
`BillingContact`	`object`	See Contact object below
`ShippingContact`	`object`	See Contact object below
`Products`	`array`	See Product item below — full-replace

Contact object

Contacts use object-level merge semantics: providing the contact object updates only the non-null fields within it.

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

Field	Type
`Name`	`string`
`Address`	`string`
`City`	`string`
`State`	`string`
`Zip`	`string`
`Country`	`string`

Product item

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

Field	Type	Notes
`Description`	`string`
`Sku`	`string`
`Quantity`	`int`
`PricePer`	`decimal`	Unit price
`WasReturned`	`bool?`

Representment.RepresentmentTransactionInfo

Scalar 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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type
`AuthCode`	`string`
`Cancelled`	`bool?`
`CancelDate`	`datetime?`
`CancelReason`	`string`
`WasCustomerServiceContacted`	`bool?`
`LastCustomerServiceContactDate`	`datetime?`
`LastCustomerServiceContactReason`	`string`
`DeviceId`	`string`
`GeoId`	`string`
`OTP_SMS`	`string`
`AddOns`	`bool?`
`HasProof`	`bool?`
`ProofDate`	`datetime?`
`ProofType`	`string`
`Recurring`	`bool?`
`RefundARN`	`string`
`RefundAuthCode`	`string`
`RefundAmount`	`decimal?`
`RefundDate`	`datetime?`
`ExternalRefundId`	`string`

Representment.CustomDisputeValues

Full-replace array. Each item:

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

Field	Type	Notes
`ParameterId`	`int?`	Preferred — looked up by DB id
`ParameterName`	`string`	Fallback if `ParameterId` absent
`ParameterValue`	`string`	The value to store

Representment.Documents

Full-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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Notes
`Key`	`string`	Must match the name of the file part in the multipart request
`Title`	`string`	Display title (defaults to filename if omitted)
`Notes`	`string`	Optional notes
`DocumentType_Id`	`int?`	Optional document type classification

Response

200 OK

{\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`MidMetricsId`	Chargeback ID
`RepresentmentId`	Representment record ID
`PdfPreviewUrl`	URL to retrieve the PDF — use `GET api/chargeback/GetRepresentmentLetter` (API-key authenticated). No longer the session-gated DisputeGenius URL.
`DocumentsAdded`	Number of documents successfully uploaded in this request
`SubmitRequested`	Whether `SubmitResult: true` was sent in the request
`Submitted`	Whether 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)
`PdfPages`	Number of pages in the generated PDF
`PdfSize`	Human-readable size of the generated PDF (e.g. `\"0.42 MB\"`)
`PdfOverBudget`	`true` if the PDF exceeds the processor's page or size limits
`PdfWarning`	Human-readable description of which limit was exceeded, or `null`

Error responses

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

Status	Condition
400 Bad Request	Missing `data` part, invalid JSON, or neither `MidMetricsId` nor `ProcessorCaseId` provided, or `ProcessorCaseId` provided with `MidMetricsId` but they refer to different chargebacks
403 Forbidden	Missing or invalid API key
404 Not Found	No chargeback found for the provided identifier
415 Unsupported Media Type	Request is not `multipart/form-data`
500 Internal Server Error	Unhandled exception — check server logs

Example — clear a field (set to null)

{\n  \"MidMetricsId\": 9801,\n  \"Representment\": {\n    \"RepresentmentTransactionInfo\": {\n      \"CancelDate\": null,\n      \"CancelReason\": null\n    }\n  }\n}\n

Sandbox Behaviour

Data is validated (chargeback identifier required) but not stored.
Submitted echoes back the value of SubmitRequested.
PdfPreviewUrl returns /api/chargeback/GetRepresentmentLetter — follow that URL with your API key to receive the sample PDF.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c41b625a-4418-4bb3-9d32-e64fa34471fe","id":"c41b625a-4418-4bb3-9d32-e64fa34471fe","name":"MidMetrics Sandbox API","type":"collection"}},"urlObject":{"path":["api","chargeback","UpdateRepresentment"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c0428e5b-5e2e-4fe4-9349-2505f9e7b32b","name":"Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"data","value":"{\n \"MidMetricsId\": 12345,\n \"ProcessorCaseId\": \"CB-2024-001\",\n \"SubmitResult\": true,\n \"Representment\": {\n \"OrderInfo\": {\n \"TrackingNumber\": \"1Z999AA10123456784\",\n \"BillingContact\": {\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Email\": \"jane.doe@example.com\"\n },\n \"ShippingContact\": {\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Address1\": \"123 Main St\",\n \"City\": \"Springfield\",\n \"State\": \"IL\",\n \"PostalCode\": \"62701\",\n \"Country\": \"US\"\n },\n \"Products\": [\n { \"ProductName\": \"Widget Pro\", \"Quantity\": 1, \"UnitPrice\": 99.99 }\n ]\n },\n \"RepresentmentTransactionInfo\": {\n \"AuthCode\": \"ABC123\"\n },\n \"CustomDisputeValues\": [\n { \"ParameterId\": 1, \"ParameterValue\": \"1Z999AA10123456784\" }\n ],\n \"Documents\": [\n { \"Key\": \"doc1\", \"Title\": \"Delivery Confirmation\", \"Notes\": \"Carrier confirmation\", \"DocumentType_Id\": 20 }\n ]\n }\n}","type":"text","description":"Required. JSON payload. Identify the chargeback with MidMetricsId or ProcessorCaseId (or both). Omit fields to leave them unchanged; include null to clear."},{"key":"doc1","type":"file","description":"Optional file part - key must match a Documents[].Key value in the data payload.","src":[]}]},"url":"/api/chargeback/UpdateRepresentment","description":"### UpdateRepresentment\n\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.\n\n#### Authentication\n\nStandard Service API key — same header as all other `api/chargeback` endpoints.\n\n#### Request\n\n**Content-Type:** `multipart/form-data`\n\nThe request has two kinds of parts:\n\n| Part name | Content-Type | Required | Description |\n| --- | --- | --- | --- |\n| `data` | `application/json` | Yes | JSON payload (structure below) |\n| _{key}_ | _(any)_ | No | One file part per entry in `Representment.Documents`, named to match that entry's `Key` field |\n\n#### JSON Payload (`data` part)\n\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```json\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```\n\n##### Top-level fields\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `MidMetricsId` | `int` | One of these two | MidMetrics internal chargeback ID |\n| `ProcessorCaseId` | `string` | One of these two | Processor-assigned case ID |\n| `SubmitResult` | `bool` | No (default `false`) | When `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| `Representment` | `object` | No | Container for all representment data; omit to skip all data updates |\n\n##### Partial-update semantics\n\nThese apply to all scalar fields inside `Representment`:\n\n| JSON | Effect |\n| --- | --- |\n| Field **absent** from payload | No change — existing value preserved |\n| Field present with **`null`** | Clears the value in the database |\n| Field present with a **value** | Sets the value |\n\nArrays (`Products`, `CustomDisputeValues`, `Documents`) use **full-replace** semantics:\n\n| JSON | Effect |\n| --- | --- |\n| Array key **absent** | No change |\n| Array present (even `[]`) | Existing rows deleted and replaced with the provided list |\n\n#### Representment.OrderInfo\n\nScalar fields match `RepresentmentOrderInfoVM` / `OrderInfo` entity properties directly.\n\n| Field | Type | Notes |\n| --- | --- | --- |\n| `MerchantOrderId` | `string` | |\n| `TrackingNumber` | `string` | Setting a non-empty value triggers a Shippo tracking lookup |\n| `DateOfOrder` | `datetime?` | ISO 8601 |\n| `DateShipped` | `datetime?` | |\n| `DateDelivered` | `datetime?` | |\n| `Email` | `string` | |\n| `IPAddress` | `string` | |\n| `Phone` | `string` | |\n| `DeliveryLocation` | `string` | |\n| `DeliveryNotes` | `string` | |\n| `Tax` | `decimal?` | |\n| `Shipping` | `decimal?` | |\n| `OrderAmount` | `decimal?` | |\n| `Currency` | `string` | e.g. `\"USD\"` |\n| `InvoiceNumber` | `string` | |\n| `AccountId` | `string` | |\n| `Shipper_Id` | `int?` | |\n| `ReturnAttemptTooLate` | `bool?` | |\n| `CancelAttemptTooLate` | `bool?` | |\n| `MarketingSource` | `string` | |\n| `SubMarketingSource` | `string` | |\n| `Refundable` | `bool?` | |\n| `CarRentalDate` | `datetime?` | Hospitality / travel |\n| `CarReturnDate` | `datetime?` | |\n| `FlightDate` | `datetime?` | |\n| `CheckInDate` | `datetime?` | |\n| `CheckOutDate` | `datetime?` | |\n| `AncillaryCharges` | `bool?` | |\n| `NoShow` | `bool?` | |\n| `BillingContact` | `object` | See Contact object below |\n| `ShippingContact` | `object` | See Contact object below |\n| `Products` | `array` | See Product item below — full-replace |\n\n##### Contact object\n\nContacts use **object-level merge** semantics: providing the contact object updates only the non-null fields within it.\n\n| Field | Type |\n| --- | --- |\n| `Name` | `string` |\n| `Address` | `string` |\n| `City` | `string` |\n| `State` | `string` |\n| `Zip` | `string` |\n| `Country` | `string` |\n\n##### Product item\n\n| Field | Type | Notes |\n| --- | --- | --- |\n| `Description` | `string` | |\n| `Sku` | `string` | |\n| `Quantity` | `int` | |\n| `PricePer` | `decimal` | Unit price |\n| `WasReturned` | `bool?` | |\n\n#### Representment.RepresentmentTransactionInfo\n\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| Field | Type |\n| --- | --- |\n| `AuthCode` | `string` |\n| `Cancelled` | `bool?` |\n| `CancelDate` | `datetime?` |\n| `CancelReason` | `string` |\n| `WasCustomerServiceContacted` | `bool?` |\n| `LastCustomerServiceContactDate` | `datetime?` |\n| `LastCustomerServiceContactReason` | `string` |\n| `DeviceId` | `string` |\n| `GeoId` | `string` |\n| `OTP_SMS` | `string` |\n| `AddOns` | `bool?` |\n| `HasProof` | `bool?` |\n| `ProofDate` | `datetime?` |\n| `ProofType` | `string` |\n| `Recurring` | `bool?` |\n| `RefundARN` | `string` |\n| `RefundAuthCode` | `string` |\n| `RefundAmount` | `decimal?` |\n| `RefundDate` | `datetime?` |\n| `ExternalRefundId` | `string` |\n\n#### Representment.CustomDisputeValues\n\nFull-replace array. Each item:\n\n| Field | Type | Notes |\n| --- | --- | --- |\n| `ParameterId` | `int?` | Preferred — looked up by DB id |\n| `ParameterName` | `string` | Fallback if `ParameterId` absent |\n| `ParameterValue` | `string` | The value to store |\n\n#### Representment.Documents\n\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| Field | Type | Notes |\n| --- | --- | --- |\n| `Key` | `string` | Must match the name of the file part in the multipart request |\n| `Title` | `string` | Display title (defaults to filename if omitted) |\n| `Notes` | `string` | Optional notes |\n| `DocumentType_Id` | `int?` | Optional document type classification |\n\n#### Response\n\n**200 OK**\n\n```json\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| Field | Description |\n| --- | --- |\n| `MidMetricsId` | Chargeback ID |\n| `RepresentmentId` | Representment record ID |\n| `PdfPreviewUrl` | URL to retrieve the PDF — use `GET api/chargeback/GetRepresentmentLetter` (API-key authenticated). No longer the session-gated DisputeGenius URL. |\n| `DocumentsAdded` | Number of documents successfully uploaded in this request |\n| `SubmitRequested` | Whether `SubmitResult: true` was sent in the request |\n| `Submitted` | Whether 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| `PdfPages` | Number of pages in the generated PDF |\n| `PdfSize` | Human-readable size of the generated PDF (e.g. `\"0.42 MB\"`) |\n| `PdfOverBudget` | `true` if the PDF exceeds the processor's page or size limits |\n| `PdfWarning` | Human-readable description of which limit was exceeded, or `null` |\n\n##### Error responses\n\n| Status | Condition |\n| --- | --- |\n| 400 Bad Request | Missing `data` part, invalid JSON, or neither `MidMetricsId` nor `ProcessorCaseId` provided, or `ProcessorCaseId` provided with `MidMetricsId` but they refer to different chargebacks |\n| 403 Forbidden | Missing or invalid API key |\n| 404 Not Found | No chargeback found for the provided identifier |\n| 415 Unsupported Media Type | Request is not `multipart/form-data` |\n| 500 Internal Server Error | Unhandled exception — check server logs |\n\n#### Example — clear a field (set to null)\n\n```json\n{\n \"MidMetricsId\": 9801,\n \"Representment\": {\n \"RepresentmentTransactionInfo\": {\n \"CancelDate\": null,\n \"CancelReason\": null\n }\n }\n}\n```\n\n#### Sandbox Behaviour\n\n- Data is validated (chargeback identifier required) but not stored.\n- `Submitted` echoes back the value of `SubmitRequested`.\n- `PdfPreviewUrl` returns `/api/chargeback/GetRepresentmentLetter` — follow that URL with your API key to receive the sample PDF."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\r\n \"MidMetricsId\": 12345,\r\n \"RepresentmentId\": 573,\r\n \"PdfPreviewUrl\": \"/api/chargeback/GetRepresentmentLetter?midMetricsId=12345\",\r\n \"DocumentsAdded\": 1,\r\n \"SubmitRequested\": true,\r\n \"Submitted\": true,\r\n \"PdfPages\": 3,\r\n \"PdfSize\": \"0.42 MB\",\r\n \"PdfOverBudget\": false,\r\n \"PdfWarning\": null\r\n}"}],"_postman_id":"d483f7a6-34cd-4389-bedb-12902ff0583e"},{"name":"GetRepresentmentLetter","id":"6b23daf9-3edc-46b4-9f9d-4c74fbb2407d","request":{"method":"GET","header":[],"url":"/api/chargeback/GetRepresentmentLetter?midMetricsId=12345","description":"

Returns 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.

Query Parameters

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

Parameter	Type	Required	Description
`midMetricsId`	int	One of these two is required	MidMetrics internal chargeback ID
`processorCaseId`	string	One of these two is required	Processor-assigned case ID

Response

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

Status	Description
`200 OK`	`application/pdf` — the submitted representment PDF
`400 Bad Request`	Neither `midMetricsId` nor `processorCaseId` was provided
`403 Forbidden`	API key not authorized for this chargeback's MID
`404 Not Found`	Chargeback not found, or no submitted PDF exists yet (chargeback is still in draft state)

Sandbox Behaviour

Returns a static one-page sample PDF (application/pdf) so the full GET → open-PDF flow can be tested without real data.

RoutePrefix: api/chargeback - dispute representment endpoints.

\n","_postman_id":"0eb38088-c2e9-45a4-bed4-12d3227bdaae","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c41b625a-4418-4bb3-9d32-e64fa34471fe","id":"c41b625a-4418-4bb3-9d32-e64fa34471fe","name":"MidMetrics Sandbox API","type":"collection"}}},{"name":"Event Subscription API","item":[{"name":"GetCompaniesAndMids","id":"56237cf7-e967-4673-bef4-71487b3c81b6","request":{"method":"GET","header":[],"url":"/api/EventSubscription/GetCompaniesAndMids","description":"

Returns the tree of companies and their MID identifiers that this API key is permitted to subscribe to. Use the Value tokens in the CompaniesAndMidsThisIsFor field of POST/PUT.

Returns all event subscriptions visible to this API key.

Returns a single event subscription by its ID.

Creates a new event subscription.

EventType values: 1=Alert, 2=Chargeback (check SubscribedEventType enum for full list).\nAuthType: 1=Basic, 2=ApiKey, 3=Bearer, 4=HMAC, 5=JWT.\nCompaniesAndMidsThisIsFor: 'All', or token list from GetCompaniesAndMids (e.g. '1!,1~101').\nReturns the new subscription ID on success.

Replaces an existing subscription. All fields are required (full replacement, not partial update).\nReturns the subscription ID on success.

Disables (soft-deletes) a subscription. Returns 200 OK on success.

RoutePrefix: api/EventSubscription - manage webhook/email event subscriptions.

\n","_postman_id":"568f0c6b-46a3-4f84-948b-1a3f6978a5f4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c41b625a-4418-4bb3-9d32-e64fa34471fe","id":"c41b625a-4418-4bb3-9d32-e64fa34471fe","name":"MidMetrics Sandbox API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"a8b559fb-1cae-4c03-9437-e20a10641bb5","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"9a16e421-5bd3-48ba-b073-17fcac54c8e6","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"apiKey","value":"","description":"Your API key Sent as: Authorization: Basic "},{"key":"subscriptionId","value":"","description":"EventSubscription ID used in GET/PUT/DELETE by-id requests."},{"key":"baseUrl","value":""}]}

UpdateRepresentment

Authentication

Request

JSON Payload (data part)

Top-level fields

Partial-update semantics

Representment.OrderInfo

Contact object

Product item

Representment.RepresentmentTransactionInfo

Representment.CustomDisputeValues

Representment.Documents

Response

Error responses

Example — clear a field (set to null)

Sandbox Behaviour

Query Parameters

Response

Sandbox Behaviour

JSON Payload (`data` part)