{"info":{"_postman_id":"448aebba-5df7-4b56-a283-b0bead561b19","name":"MidMetrics Public APIs","description":"

MidMetrics provides the leading chargeback management and payment accounts analytics solution by integrating chargeback prevention, dispute resolution, and payment accounts analytics into one platform.

Our API has two parts:

Events API - Allows a merchant to subscribe to events that happen in midmetrics. The events are Chargeback, RDR, Alert, or Inform. When one of the events occurs, a webhook call will be made to inform the merchant of these events.
\n
Order API - Allows a merchant to upload the information about orders that occur in their CRM. The information is used to provide dispute resolution.
\n

All requests to the API should be made to the base URL https://{EnterpriseName}.midmetircs.io/ where {EnterpriseName} is your enterprise name in MidMetrics. For example if your enterprise is named acme then API calls must be made to https://acme.midmetrics.io/. This URL is the same base URL that you access MidMetrics by.

Authentication

Example:

curl --location --request POST 'https://{{YourEnterpriseName}}.midmetrics.io/api/EventSubscription' \\\n--header 'Authorization: Basic SecretAPIKey'\n\n

Please email service@midmetrics.com for your secret **APIKey. Once you get your secret apikey, 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

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"8636185","collectionId":"448aebba-5df7-4b56-a283-b0bead561b19","publishedId":"UVXhqc18","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2025-08-21T11:57:16.000Z"},"item":[{"name":"Events API","item":[{"name":"Subscribe","id":"0a433468-8d99-4d9a-a6fe-0f9613a02c36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Email\": \"jeff@midmetrics.io\",\r\n \"ExternalUrl\": \"https://YourCallBackURL/api/ReceiveRDR\",\r\n \"UserName\": \"YourCallbackUsername\",\r\n \"Password\": \"YourCallbackPassword\",\r\n \"EventType\": \"RDR\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://YourEnterpriseName.midmetrics.io/api/EventSubscription","description":"

Subscribe an external system's HTTP endpoints to events that occur in MidMetrics. When the event fires, MidMetrics POSTs a JSON payload to the subscribed URL with the configured authentication scheme applied (e.g. a CRM receiving an API call on every Chargeback).

Event Subscriptions can also be managed inside the MidMetrics portal via our UI:

\n\n

Payload Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
`EventType`	string/enum	yes	Event to subscribe to. One of: `Alert`, `Chargeback`, `RDR`, `Inform`, `ChargebackUpdate`
`ExternalUrl`	string	yes	URL MidMetrics will POST the event JSON to
`Email`	string	yes	Address notified when a webhook delivery fails (e.g. after retries are exhausted)
`AuthType`	int	no (default `1`)	Authentication scheme. See Auth Types. Defaults to `1` (Basic)
`UserName`	string	conditional	Basic auth username. Also used as `client_id` when `AuthType = 6` (JWT)
`Password`	string	conditional	Basic auth password. Also used as `client_secret` when `AuthType = 6` (JWT)
`BearerToken`	string	conditional	Static bearer token. Used when `AuthType = 2`
`ApiKeyName`	string	conditional	API key header name or query-param name. Used when `AuthType = 3` or `4`
`ApiKeyValue`	string	conditional	API key value. Used when `AuthType = 3` or `4`
`HmacSecret`	string	conditional	Shared secret used to sign the request body. Used when `AuthType = 5`
`JwtTokenUrl`	string	conditional	OAuth2 token endpoint. Used when `AuthType = 6`. Grant type: `client_credentials`
`ExtraHeadersJson`	string (JSON object)	no	Extra headers applied to every webhook request regardless of `AuthType`. Example: `\"{\\\"X-Tenant\\\":\\\"acme\\\",\\\"X-Source\\\":\\\"MidMetrics\\\"}\"`
`Disabled`	bool	no	`true` disables delivery for this subscription

Auth Types

The AuthType integer on the payload selects how MidMetrics authenticates when calling ExternalUrl.

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

`AuthType`	Name	How the outbound webhook is authenticated
`1`	`Basic` (default)	`Authorization: Basic base64(UserName:Password)`
`2`	`BearerToken`	`Authorization: Bearer {BearerToken}` (static token)
`3`	`ApiKeyHeader`	Custom header: `{ApiKeyName}: {ApiKeyValue}`
`4`	`ApiKeyQuery`	Adds `?{ApiKeyName}={ApiKeyValue}` to the URL
`5`	`HmacSha256`	Signs `{unixTimestamp}.{body}` with `HmacSecret`. Sends `X-Timestamp: {ts}` and `X-Signature: sha256={hex}`
`6`	`Jwt`	POSTs `grant_type=client_credentials&client_id={UserName}&client_secret={Password}` to `JwtTokenUrl`, caches the returned `access_token` until `expires_in` (30s skew), and sends `Authorization: Bearer {access_token}` on webhook calls

HMAC signature details (`AuthType = 5`)

Algorithm: HMAC-SHA256
\n
Signed payload: \"{unix_seconds}.{raw_request_body}\"
\n
Headers sent:
\n
- X-Timestamp: {unix_seconds}
  \n
- X-Signature: sha256={lowercase_hex}
  \n
\n
Recommended receiver check: reject if |now - X-Timestamp| > N seconds, then recompute HMAC over timestamp + \".\" + body and constant-time compare.
\n

JWT details (`AuthType = 6`)

Token endpoint: JwtTokenUrl
\n
Grant type: client_credentials (only grant supported)
\n
Sent as application/x-www-form-urlencoded:
\n
- client_id = UserName
  \n
- client_secret = Password
  \n
\n
Expected response JSON: { \"access_token\": \"...\", \"expires_in\": 3600 }
\n
Token is cached in-process and reused until 30 seconds before expires_in
\n

Request Delivery

Method: POST
\n
Content-Type: application/json
\n
Timeout: 12,000 ms (send + read)
\n
ExtraHeadersJson is applied after auth headers for every AuthType
\n
On delivery failure, LastError is updated on the subscription record and the Email contact is notified after retries are exhausted
\n

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

Status	Meaning
`200 OK`	Body is the new subscription `Id` (integer)
`400 Bad Request`	`\"Illegal Event Type\"` — `EventType` missing or invalid
`403 Forbidden`	`\"Not authorized\"` — caller failed API auth
`409 Conflict`	`\"Duplicate subscription\"` — a subscription already exists with the same `Email` + `ExternalUrl` + `EventType`

Examples

Basic auth (default)

POST https://YourEnterpriseName.midmetrics.io/api/EventSubscription\nContent-Type: application/json\n{\n  \"EventType\": \"Chargeback\",\n  \"ExternalUrl\": \"https://crm.example.com/hooks/midmetrics\",\n  \"Email\": \"ops@example.com\",\n  \"AuthType\": 1,\n  \"UserName\": \"midmetrics\",\n  \"Password\": \"s3cret\"\n}\n\n

Bearer token

{\n  \"EventType\": \"Alert\",\n  \"ExternalUrl\": \"https://crm.example.com/hooks/midmetrics\",\n  \"Email\": \"ops@example.com\",\n  \"AuthType\": 2,\n  \"BearerToken\": \"eyJhbGciOi...\"\n}\n\n

API key in header

{\n  \"EventType\": \"RDR\",\n  \"ExternalUrl\": \"https://crm.example.com/hooks/midmetrics\",\n  \"Email\": \"ops@example.com\",\n  \"AuthType\": 3,\n  \"ApiKeyName\": \"X-Api-Key\",\n  \"ApiKeyValue\": \"ak_live_abc123\"\n}\n\n

API key in query string

{\n  \"EventType\": \"Inform\",\n  \"ExternalUrl\": \"https://crm.example.com/hooks/midmetrics\",\n  \"Email\": \"ops@example.com\",\n  \"AuthType\": 4,\n  \"ApiKeyName\": \"api_key\",\n  \"ApiKeyValue\": \"ak_live_abc123\"\n}\n\n

HMAC-SHA256 signed

{\n  \"EventType\": \"ChargebackUpdate\",\n  \"ExternalUrl\": \"https://crm.example.com/hooks/midmetrics\",\n  \"Email\": \"ops@example.com\",\n  \"AuthType\": 5,\n  \"HmacSecret\": \"whsec_abcdef0123456789\"\n}\n\n

OAuth2 JWT (client_credentials)

{\n  \"EventType\": \"Chargeback\",\n  \"ExternalUrl\": \"https://crm.example.com/hooks/midmetrics\",\n  \"Email\": \"ops@example.com\",\n  \"AuthType\": 6,\n  \"JwtTokenUrl\": \"https://auth.example.com/oauth/token\",\n  \"UserName\": \"client_id_value\",\n  \"Password\": \"client_secret_value\",\n  \"ExtraHeadersJson\": \"{\\\"X-Tenant\\\":\\\"acme\\\"}\"\n}\n\n

This API is used to subscribe an external system's API to events that occur in MidMetrics so that an external system can receive notification about an event (such as a CRM that needs to receive an API call on every Chargeback).

Payload schema:

\n\n\n\n\n\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 Name	Description
EventType	Type of event to subscribe to. Must be one of: Alert Chargeback RDR Inform
ExternalUrl	URL to send notifications of the event to
UsernName	Username Midmetrics will send when calling the URL. The username and password are provided using HTTP Basic Auth
Password	Password Midmetrics will send when calling the URL. The username and password are provided using HTTP Basic Auth
Email	The email address to be notified when an error occurs sending a webhook message. For example, we are unable to send to the endpoint after 5 retries

","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","EventSubscription","{{IdOfSubscriptionToUpdate}}"],"host":["YourEnterpriseName","midmetrics","io"],"query":[],"variable":[]}},"response":[{"id":"addfaac6-ce4a-4491-b895-5cc8e5700eb6","name":"Subscribe to Alert","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"EventType\": \"Alert\",\r\n \"ExternalUrl\": \"https://YourCallBackURL/api/ReceiveAlert\",\r\n \"UserName\": \"YourCallbackUsername\",\r\n \"Password\": \"YourCallbackPassword\",\r\n \"Email\": \"jeff@midmetrics.io\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://acme.midmetrics.io/api/EventSubscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"120"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"}],"cookie":[],"responseTime":null,"body":"7"},{"id":"d034dfab-285c-4240-a86c-92cefedbf096","name":"Subscribe to Chargeback","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"EventType\": \"Chargeback\",\r\n \"ExternalUrl\": \"https://YourCallBackURL/api/ReceiveCB\",\r\n \"UserName\": \"YourCallbackUsername\",\r\n \"Password\": \"YourCallbackPassword\",\r\n \"Email\": \"jeff@midmetrics.io\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://YourEnterpriseName.midmetrics.io/api/EventSubscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"121"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d5d7734f-f522-4898-ad87-d7cf6e51537a"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Set-Cookie","value":"ARRAffinity=6f0eb6f3ca0caaa98cb47e00a643a1a299f5f53a14aa0e8e29700c686cf97948;Path=/;HttpOnly;Secure;Domain=sts.midmetrics.io"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=6f0eb6f3ca0caaa98cb47e00a643a1a299f5f53a14aa0e8e29700c686cf97948;Path=/;HttpOnly;SameSite=None;Secure;Domain=sts.midmetrics.io"},{"key":"Date","value":"Thu, 13 Jan 2022 06:20:28 GMT"}],"cookie":[],"responseTime":null,"body":"6"},{"id":"4095f637-db69-4393-b1b8-ba5cb4a954a2","name":"Subscribe to RDR","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"EventType\": \"RDR\",\r\n \"ExternalUrl\": \"https://YourCallBackURL/api/ReceiveRDR\",\r\n \"UserName\": \"YourCallbackUsername\",\r\n \"Password\": \"YourCallbackPassword\",\r\n \"Email\": \"jeff@midmetrics.io\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://YourEnterpriseName.midmetrics.io/api/EventSubscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"120"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d5d7734f-f522-4898-ad87-d7cf6e51537a"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Set-Cookie","value":"ARRAffinity=6f0eb6f3ca0caaa98cb47e00a643a1a299f5f53a14aa0e8e29700c686cf97948;Path=/;HttpOnly;Secure;Domain=sts.midmetrics.io"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=6f0eb6f3ca0caaa98cb47e00a643a1a299f5f53a14aa0e8e29700c686cf97948;Path=/;HttpOnly;SameSite=None;Secure;Domain=sts.midmetrics.io"},{"key":"Date","value":"Thu, 13 Jan 2022 06:18:45 GMT"}],"cookie":[],"responseTime":null,"body":"5"}],"_postman_id":"04a945c3-5a32-4740-bf0e-24c7610ab6a7"},{"name":"View Subscriptions","id":"2f93f2d2-1c69-4c11-b4d5-717bdfad4eb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YourEnterpriseName.midmetrics.io/api/EventSubscription","description":"

Returns a list of subscriptions for your enterprise.

You can use this to see all events you subscribe to and the webhooks called on an event.

Deletes a subscription with a specified Subscription Id. The Subscription Id is the value returned from the Subscribe call and the View Subscriptions call.

The Subscription Id should be passed at the end of the URL.

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.

If you have questions about using our APIs, please email service@midmetrics.com

Schema

Alerts and Informs

Subscribing 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:

public 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

Example JSON Payload

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

For Inform events, eventType will be \"Inform\" and the type \"I\"

Chargebacks

Subscribing to the Chargeback events will trigger MidMetrics to HTTP POST to the subscribed webhooks the following object when a Chargeback occurs:

public 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

Example JSON Payload

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

ChargebackUpdate

Subscribing to the ChargebackUpdate events will trigger MidMetrics to HTTP POST to the subscribed webhooks the following object when a Chargeback Cycle or Action occurs

public 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

RDRs

Subscribing to the RDRs events will trigger MidMetrics to HTTP POST to the subscribed webhooks the following object when an RDR occurs

Note the RDR object is very similiar to the Chargeback object except it has the additional fields status and statusCode

public 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

Example JSON Payload

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

The eventType parameter will be: Alert, Inform, Chargeback, or RDR.

Webhooks

When 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":"Order API","item":[{"name":"Post Order","id":"9c542a3c-e973-48db-bcee-2cb554d56c1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"OrderId\": \"1234567\",\r\n \"OrderDate\": \"2024-01-01T10:00:00\",\r\n \"TransactionDate\": \"2024-01-01T10:00:00\",\r\n \"MID\": null,\r\n \"CardBrand\": \"visa\",\r\n \"CardLast4\": \"1234\",\r\n \"CardFirst6\": \"411111\",\r\n \"CardExpMonth\": \"01\",\r\n \"CardExpYear\": \"25\",\r\n \"OrderAmount\": 100.00,\r\n \"AVS\": null,\r\n \"CVV\": null,\r\n \"Email\": \"example@example.com\",\r\n \"Phone\": \"1234567890\",\r\n \"Refunded\": true,\r\n \"RefundedAmount\": 100.00,\r\n \"SubscriptionCycle\": 0,\r\n \"SubscriptionParentId\": \"1234567\",\r\n \"IPAddress\": \"192.168.1.1\",\r\n \"DeviceId\": null,\r\n \"Currency\": \"USD\",\r\n \"ProcessorAuthCode\": \"AUTH123\",\r\n \"GatewayTransactionId\": \"TX1234567890\",\r\n \"BillingFirstName\": \"John\",\r\n \"BillingLastName\": \"Doe\",\r\n \"BillingStreetAaddress1\": \"123 Main St\",\r\n \"BillingStreetAddress2\": \"\",\r\n \"BillingCity\": \"Anytown\",\r\n \"BillingState\": \"CA\",\r\n \"BillingPostcode\": \"12345\",\r\n \"BillingCountry\": \"US\",\r\n \"MarketingSource\": null,\r\n \"SubMmarketingSources\": [\"\", \"\", \"\", \"\", \"\"],\r\n \"Evidence\": {\r\n \"ShippingDetails\": [\r\n {\r\n \"Carrier\": \"\",\r\n \"Trackingnumber\": \"\",\r\n \"FirstName\": \"John\",\r\n \"Lastname\": \"Doe\",\r\n \"StreetAddress1\": \"123 Main St\",\r\n \"StreetAddress2\": \"\",\r\n \"City\": \"Anytown\",\r\n \"State\": \"CA\",\r\n \"Postalcode\": \"12345\",\r\n \"Country\": \"US\"\r\n }\r\n ],\r\n \"Proof\": null\r\n },\r\n \"Items\": [\r\n {\r\n \"Id\": \"1\",\r\n \"Name\": \"Sample Product\",\r\n \"Price\": 100.00,\r\n \"Quantity\": 1,\r\n \"SKU\": \"SP123\",\r\n \"Description\": null\r\n }\r\n ],\r\n \"Notes\": [\r\n {\r\n \"Timestamp\": \"2024-01-01T10:00:00\",\r\n \"Value\": \"Order created via API\"\r\n },\r\n {\r\n \"Timestamp\": \"2024-01-01T10:05:00\",\r\n \"Value\": \"Email updated\"\r\n }\r\n ],\r\n \"AlertDate\": null,\r\n \"TypeOfAlert\": null,\r\n \"AlertId\": 0,\r\n \"CancellationDate\": null,\r\n \"CancellationReason\": null,\r\n \"CampaignName\": \"\",\r\n \"AffiliateName\": \"\",\r\n \"AffiliateId\": \"\",\r\n \"SourceValue1\": \"\",\r\n \"SourceValue2\": null,\r\n \"SourceValue3\": null,\r\n \"SourceValue4\": null,\r\n \"SourceValue5\": null,\r\n \"Details\": null,\r\n \"DetailsV3\": {\r\n \"Receipt\": {\r\n \"OrderDate\": \"2024-01-01T10:00:00Z\",\r\n \"OrderNumber\": \"1234567\",\r\n \"PurchaseCategory\": null,\r\n \"InvoiceNumber\": null,\r\n \"DownloadDateTime\": null,\r\n \"SubTotalAmount\": null,\r\n \"TaxAmount\": null,\r\n \"TaxDescription\": null,\r\n \"ShippingAndHandlingAmount\": null,\r\n \"OrderTotalAmount\": {\r\n \"Amount\": 100.00,\r\n \"Currency\": \"USD\"\r\n },\r\n \"PaymentInformation\": {\r\n \"PaymentMethod\": null,\r\n \"BillingName\": \"John Doe\",\r\n \"BillingAddressDetails\": {\r\n \"Address1\": \"123 Main St\",\r\n \"Address2\": \"\",\r\n \"City\": \"Anytown\",\r\n \"Region\": \"CA\",\r\n \"PostalCode\": \"12345\",\r\n \"Country\": \"US\"\r\n },\r\n \"PaymentSubTotalAmount\": null,\r\n \"PaymentShippingAndHandlingAmount\": null,\r\n \"PaymentTotalBeforeTax\": null,\r\n \"PaymentTaxAmount\": null,\r\n \"PaymentTaxDescription\": null,\r\n \"PaymentTotalAmount\": null,\r\n \"CvvChecked\": null\r\n },\r\n \"ProductsPurchasedList\": [\r\n {\r\n \"ProductType\": null,\r\n \"ProductDescription\": \"Sample Product\",\r\n \"ProductUrl\": null,\r\n \"ArtistOrSeller\": null,\r\n \"UnitPriceAmount\": {\r\n \"Amount\": 100.00,\r\n \"Currency\": \"USD\"\r\n },\r\n \"Quantity\": 1,\r\n \"CreditReimbursementSequenceNumber\": null,\r\n \"DeliveryDetails\": {\r\n \"ShippingCarrier\": null,\r\n \"TrackingNumber\": \"\",\r\n \"DateOfShipment\": null,\r\n \"DateOfDelivery\": null,\r\n \"DeliveryStatus\": null,\r\n \"OtherStatusDescription\": null\r\n }\r\n }\r\n ]\r\n },\r\n \"MerchantInformation\": {\r\n \"MerchantName\": null,\r\n \"MerchantUrl\": null,\r\n \"WebsiteUrl\": null,\r\n \"MerchantContactPhone\": null,\r\n \"MerchantAddress\": null,\r\n \"TermsAndConditions\": null,\r\n \"StoreDetails\": {\r\n \"StoreName\": null,\r\n \"StoreContactPhone\": null,\r\n \"StoreLocation\": null\r\n }\r\n },\r\n \"CustomerInformation\": {\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"LengthOfRelationship\": \"\",\r\n \"AccountId\": null,\r\n \"EmailAddress\": \"example@example.com\"\r\n },\r\n \"DeliveryAddress\": {\r\n \"Address1\": \"123 Main St\",\r\n \"Address2\": \"\",\r\n \"City\": \"Anytown\",\r\n \"Region\": \"CA\",\r\n \"PostalCode\": \"12345\",\r\n \"Country\": \"US\"\r\n },\r\n \"RecipientCustomerName\": null,\r\n \"Device\": {\r\n \"DeviceType\": null,\r\n \"DeviceName\": null,\r\n \"DeviceId\": null,\r\n \"IpAddress\": null,\r\n \"DeviceFingerprint\": null,\r\n \"DeviceLocation\": null\r\n },\r\n \"CreditReimbursementList\": null,\r\n \"FlightDetails\": null,\r\n \"HotelDetails\": null,\r\n \"CarRentalDetails\": null,\r\n \"RideShareDetails\": null,\r\n \"DigitalReceiptLink\": null,\r\n \"Communications\": null\r\n },\r\n \"SecureCode3D\": \"no\",\r\n \"ShipDate\": null,\r\n \"DeliverDate\": null,\r\n \"ReturnDate\": null,\r\n \"LastContactDate\": null,\r\n \"CRMId\": 0,\r\n \"RequestingObjectType\": null,\r\n \"RequestingObjectId\": null,\r\n \"CampaignId\": \"51\",\r\n \"OriginalCrmData\": null,\r\n \"ShipTodifferent\": false,\r\n \"CRMUserName\": null\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://YourEnterpriseName.midmetrics.io/api/orders/order","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","orders","order"],"host":["YourEnterpriseName","midmetrics","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c542a3c-e973-48db-bcee-2cb554d56c1f"}],"id":"fa864627-acf7-4c98-a8e0-8bcfda2bda84","description":"

The Order API takes information about an order from a CRM. If the order information already exists, it updates the information.

Schema

public class Order\n{\n    public string OrderId { get; set; }\n    public DateTime OrderDate { get; set; }\n    public DateTime TransactionDate { get; set; }\n    public string MID { get; set; }\n    public string CardBrand { get; set; }\n    public string CardLast4 { get; set; }\n    public string CardFirst6 { get; set; }\n    public string CardExpMonth { get; set; }\n    public string CardExpYear { get; set; }\n    public decimal OrderAmount { get; set; }\n    public string AVS { get; set; }\n    public string CVV { get; set; }\n    public string Email { get; set; }\n    public string Phone { get; set; }\n    public bool Refunded { get; set; }\n    public decimal RefundedAmount { get; set; }\n    public int SubscriptionCycle { get; set; }\n    public string SubscriptionParentId { get; set; }\n    public string IPAddress { get; set; }\n    public string DeviceId { get; set; }\n    public string Currency { get; set; }\n    public string ProcessorAuthCode { get; set; }\n    public string GatewayTransactionId { get; set; }\n    public string BillingFirstName { get; set; }\n    public string BillingLastName { get; set; }\n    public string BillingStreetAaddress1 { get; set; }\n    public string BillingStreetAddress2 { get; set; }\n    public string BillingCity { get; set; }\n    public string BillingState { get; set; }\n    public string BillingPostcode { get; set; }\n    public string BillingCountry { get; set; }\n    public string MarketingSource { get; set; }\n    public string[] SubMmarketingSources { get; set; }\n    public Evidence Evidence { get; set; }\n    public Item[] Items { get; set; }\n    public Note[] Notes { get; set; }\n\n    public DateTime? AlertDate { get; set; }\n    public string TypeOfAlert { get; set; }\n    public int AlertId { get; set; }\n\n    public DateTime? CancellationDate { get; set; }\n    public string CancellationReason { get; set; }\n\n    public string CampaignName { get; set; } \n    public string AffiliateName { get; set; } \n    public string AffiliateId { get; set; }\n    public string SourceValue1 { get; set; } \n    public string SourceValue2 { get; set; } \n    public string SourceValue3 { get; set; } \n    public string SourceValue4 { get; set; } \n    public string SourceValue5 { get; set; } \n\n    public DTO.OI.Details Details { get; set; }\n    public DTO.OI_V3.OrderLookupResponse DetailsV3 { get; set; }\n\n\n    public string SecureCode3D { get; set; }\n    public DateTime? ShipDate {  get; set; }\n    public DateTime? DeliverDate { get; set; }\n    public DateTime? ReturnDate { get; set; }\n    public DateTime? LastContactDate { get; set; }\n\n\n    public int? CRMId { get; set; }\n    public BillableObjectType? RequestingObjectType { get; set; }\n    public int? RequestingObjectId { get; set; }\n    public string CampaignId { get; set; }\n    public string OriginalCrmData { get; set; }\n\n\n    public bool? ShipTodifferent { get; set; } = null;\n    public string CRMUserName { get; set; } = null;\n}\n\npublic class Evidence\n{\n    public ShippingDetails[] ShippingDetails { get; set; }\n    public Proof[] Proof { get; set; }\n}\n\npublic class ShippingDetails\n{\n    public string Carrier { get; set; }\n    public string Trackingnumber { get; set; }\n    public string FirstName { get; set; }\n    public string Lastname { get; set; }\n    public string StreetAddress1 { get; set; }\n    public string StreetAddress2 { get; set; }\n    public string City { get; set; }\n    public string State { get; set; }\n    public string Postalcode { get; set; }\n    public string Country { get; set; }\n}\n\npublic class Proof\n{\n    public string Type { get; set; }\n    public DateTime Value { get; set; }\n}\n\npublic class Item\n{\n    public string Id { get; set; }\n    public string Name { get; set; }\n    public decimal Price { get; set; }\n    public int Quantity { get; set; }\n    public string SKU { get; set; }\n    public string Description { get; set; }\n}\n\npublic class Note\n{\n    public DateTime Timestamp { get; set; }\n    public string Value { get; set; }\n}\n\n\npublic class Details\n{\n    public Transactiondetail transactionDetail { get; set; }\n    public Customerinformation customerInformation { get; set; }\n  \n    public List<Productpurchased> productPurchased { get; set; }\n    public Deliverydetails deliveryDetails { get; set; }\n    public List<Crmdetail> crmDetails { get; set; }\n    public List<Attachment> attachments { get; set; }\n}\n\npublic class Transactiondetail\n{\n    public List<double> taxAmount { get; set; }\n    public List<string> taxAmountCurrency { get; set; }\n    public List<double> shippingAndHandlingAmount { get; set; }\n    public List<string> shippingAndHandlingCurrency { get; set; }\n    public double totalAmount { get; set; }\n    public string totalAmountCurrency { get; set; }\n    public Billingaddressdetails billingAddressDetails { get; set; }\n    public List<Shippingaddressdetail> shippingAddressDetails { get; set; }\n    public bool avsChecked { get; set; }\n    public bool cvvChecked { get; set; }\n    public string refundAmount { get; set; }\n    public string refundCurrency { get; set; }\n    public DateTime? dateOfRefund { get; set; }\n    public string deviceName { get; set; }\n    public string deviceId { get; set; }\n    public string ipAddress { get; set; }\n    public string termsAndConditions { get; set; }\n    public string notes { get; set; }\n}\n\npublic class Billingaddressdetails\n{\n    public List<string> address { get; set; }\n    public string city { get; set; }\n    public string state { get; set; }\n    public string zip { get; set; }\n    public string country { get; set; }\n}\n\npublic class Shippingaddressdetail\n{\n    public List<string> address { get; set; }\n    public string city { get; set; }\n    public string state { get; set; }\n    public string zip { get; set; }\n    public string country { get; set; }\n}\n\npublic class Customerinformation\n{\n    public string firstName { get; set; }\n    public string lastName { get; set; }\n    public DateTime? dateOfBirth { get; set; }\n\n    [JsonIgnore]\n    public DateTime? firstTransactionDate { get; set; }\n    public string lengthOfRelationship { get; set; }\n    public string notes { get; set; }\n    public string productName { get; set; }\n    public List<Phonenumber> phoneNumber { get; set; }\n    public List<Emailaddress> emailAddress { get; set; }\n}\n\npublic class Phonenumber\n{\n    public string phoneNumber { get; set; }\n}\n\npublic class Emailaddress\n{\n    public string emailAddress { get; set; }\n}\n\npublic class Deliverydetails\n{\n    public List<Physicalfulfillment> physicalFulfillment { get; set; }\n\n}\n\npublic class Physicalfulfillment\n{\n    public string shippingCarrierUrl { get; set; }\n    public string trackingNumber { get; set; }\n    public DateTime? dateOfShipment { get; set; }\n    public DateTime? dateOfDelivery { get; set; }\n\n}\n\npublic class Digitalservicedelivery\n{\n    public string proofOfDelivery { get; set; }\n    public string proofOfUsage { get; set; }\n    public string locationOfUsage { get; set; }\n    public string frequencyOfUsage { get; set; }\n    public string notes { get; set; }\n}\n\npublic class Pasttransaction\n{\n    public DateTime? dateOfPurchase { get; set; }\n    public double amountOfPurchase { get; set; }\n    public string creditCardBin { get; set; }\n    public string creditCardFour { get; set; }\n    public string recurringTransaction { get; set; }\n}\n\npublic class Productpurchased\n{\n    public string productName { get; set; }\n\n    public string productUrl { get; set; }\n    public string productImageUrl { get; set; }\n    public string unitPriceCurrency { get; set; }\n    public double unitPriceAmount { get; set; }\n    public string quantity { get; set; }\n    public Industrydetails industryDetails { get; set; }\n}\n\npublic class Industrydetails\n{\n    public List<Flightdetail> flightDetails { get; set; }\n    public List<Hoteldetail> hotelDetails { get; set; }\n}\n\npublic class Flightdetail\n{\n    public string flightNumber { get; set; }\n    public DateTime? flightDate { get; set; }\n    public string manifest { get; set; }\n    public string memberRewardsNumber { get; set; }\n}\n\npublic class Hoteldetail\n{\n    public string reservationNumber { get; set; }\n    public DateTime? reservationDate { get; set; }\n    public DateTime? checkInDate { get; set; }\n    public DateTime? checkOutDate { get; set; }\n    public string memberRewardsNumber { get; set; }\n}\n\npublic class Crmdetail\n{\n    public string notes { get; set; }\n}\n\npublic class Emailaddress1\n{\n    public string emailAddress { get; set; }\n}\n\npublic class Phonenumber1\n{\n    public string phoneNumber { get; set; }\n}\n\npublic class Attachment\n{\n    public string id { get; set; }\n    public string fileName { get; set; }\n    public string friendlyFileName { get; set; }\n    public string mimeType { get; set; }\n    public DateTime? receivedDate { get; set; }\n    public string fileSource { get; set; }\n    public string data { get; set; }\n}\n\npublic class OrderLookupResponse : IEquatable<OrderLookupResponse>\n{\n    /// <summary>\n    /// Gets or Sets Receipt\n    /// </summary>\n\n    [Required]\n    [DataMember(Name=\"receipt\")]\n    public Receipt Receipt { get; set; }\n\n    /// <summary>\n    /// Gets or Sets MerchantInformation\n    /// </summary>\n\n    [Required]\n    [DataMember(Name=\"merchantInformation\")]\n    public MerchantInformation MerchantInformation { get; set; }\n\n    /// <summary>\n    /// Gets or Sets CustomerInformation\n    /// </summary>\n\n    [DataMember(Name=\"customerInformation\")]\n    public CustomerInformation CustomerInformation { get; set; }\n\n    /// <summary>\n    /// Gets or Sets DeliveryAddress\n    /// </summary>\n\n    [DataMember(Name=\"deliveryAddress\")]\n    public Address DeliveryAddress { get; set; }\n\n    /// <summary>\n    /// Recipient of goods purchases (if differs from Customer name)\n    /// </summary>\n    /// <value>Recipient of goods purchases (if differs from Customer name)</value>\n\n    [MaxLength(20)]\n    [DataMember(Name=\"recipientCustomerName\")]\n    public string RecipientCustomerName { get; set; }\n\n    /// <summary>\n    /// Gets or Sets Device\n    /// </summary>\n\n    [DataMember(Name=\"device\")]\n    public Device Device { get; set; }\n\n    /// <summary>\n    /// Gets or Sets CreditReimbursementList\n    /// </summary>\n\n    [DataMember(Name=\"creditReimbursementList\")]\n    public List<CreditReimbursement> CreditReimbursementList { get; set; }\n\n    /// <summary>\n    /// Gets or Sets FlightDetails\n    /// </summary>\n\n    [DataMember(Name=\"flightDetails\")]\n    public FlightDetails FlightDetails { get; set; }\n\n    /// <summary>\n    /// Gets or Sets HotelDetails\n    /// </summary>\n\n    [DataMember(Name=\"hotelDetails\")]\n    public HotelDetails HotelDetails { get; set; }\n\n    /// <summary>\n    /// Gets or Sets CarRentalDetails\n    /// </summary>\n\n    [DataMember(Name=\"carRentalDetails\")]\n    public CarRentalDetails CarRentalDetails { get; set; }\n\n    /// <summary>\n    /// Gets or Sets RideShareDetails\n    /// </summary>\n\n    [DataMember(Name=\"rideShareDetails\")]\n    public RideShareDetails RideShareDetails { get; set; }\n\n    /// <summary>\n    /// Reserved for digital receipt URL link. Not currently used and should not be returned.\n    /// </summary>\n    /// <value>Reserved for digital receipt URL link. Not currently used and should not be returned.</value>\n\n    [MaxLength(1000)]\n    [DataMember(Name=\"digitalReceiptLink\")]\n    public string DigitalReceiptLink { get; set; }\n\n    /// <summary>\n    /// Any additional communications between consumer and merchant\n    /// </summary>\n    /// <value>Any additional communications between consumer and merchant</value>\n\n    [MaxLength(1000)]\n    [DataMember(Name=\"communications\")]\n    public string Communications { get; set; }\n}\n\n

\n","_postman_id":"fa864627-acf7-4c98-a8e0-8bcfda2bda84","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":"Resolve Alert API","item":[{"name":"Resolve Alert","id":"0eb72237-7009-436f-b5f3-3fdc4569736d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"","value":""}],"body":{"mode":"raw","raw":"{\r\n \"Id\": 36609,\r\n \"EnterpriseName\": \"acme\",\r\n \"Note\": \"This is a note\",\r\n \"AlertSource\": \"Ethoca\",\r\n // Include properties VerifiAction and VerifiReasonCode if Verifi alert\r\n \"EthocaCaseStatusCode\": 3,\r\n \"ResolutionDate\": \"2024-06-03T12:34:56.789Z\", \r\n \"ResolutionAmount\": 17.56,\r\n \"ResolutionTransactionCode\": \"6789\",\r\n \"ResolutionAuthorizationCode\": \"12345\",\r\n \"CRMActions\": [\"Blacklisted\", \"Cancelled\"],\r\n \"Resolver\": \"Test\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://YourEnterpriseName.midmetrics.io/api/cases/ResolveAlert","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","cases","ResolveAlert"],"host":["YourEnterpriseName","midmetrics","io"],"query":[],"variable":[]}},"response":[{"id":"3740454e-884d-475b-bba9-c4fb9da3515f","name":"If alert was already resolved","originalRequest":{"method":"POST","header":[{"key":"","value":""}],"body":{"mode":"raw","raw":"{\r\n \"Id\": 36611,\r\n \"EnterpriseName\": \"acme\",\r\n \"Note\": \"This is a note\",\r\n \"AlertSource\": \"Ethoca\",\r\n // Include properties VerifiAction and VerifiReasonCode if Verifi alert\r\n \"EthocaCaseStatusCode\": 3,\r\n \"ResolutionDate\": \"2024-06-03T12:34:56.789Z\", \r\n \"ResolutionAmount\": 17.56,\r\n \"ResolutionTransactionCode\": \"6789\",\r\n \"ResolutionAuthorizationCode\": \"12345\",\r\n \"CRMActions\": [\"Blacklisted\", \"Cancelled\"],\r\n \"Resolver\": \"Test\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://YourEnterpriseName.midmetrics.io/api/cases/ResolveAlert"},"status":"Conflict","code":409,"_postman_previewlanguage":"html","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"text/html"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"Request-Context","value":"appId=cid-v1:d5d7734f-f522-4898-ad87-d7cf6e51537a"},{"key":"Access-Control-Expose-Headers","value":"Request-Context"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcUHJvZ3JhbW1pbmdcTUlETWV0cmljc1xtaWRtZXRyaWNzXG1pZG1ldHJpY3NcYXBpXGNhc2VzXFJlc29sdmVBbGVydA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Date","value":"Mon, 03 Jun 2024 20:21:10 GMT"},{"key":"Content-Length","value":"56"}],"cookie":[],"responseTime":null,"body":"The page was not displayed because there was a conflict."}],"_postman_id":"0eb72237-7009-436f-b5f3-3fdc4569736d"}],"id":"a47ff087-0221-463e-9784-e6951bebf3ef","description":"

The Resolve Alert API allows for resolution of an Alert received by the Events API.

Schema

Below is the HTTP POST payload to the Resolve Alert API. The Alert should be resolved by making an HTTP POST call to this API with this JSON in body. See Data Dictionary for field definition. All fields required.

public class AlertUpdate\n{\n    public int Id { get; set; }\n    public string EnterpriseName { get; set; }\n    public string AlertSource { get; set; }\n    public string Note { get; set; }\n    public string VerifiAction { get; set; }\n    public int VerifiReasonCode { get; set; }\n    public int EthocaCaseStatusCode { get; set; }\n    public DateTime ResolutionDate { get; set; }\n    public Decimal ResolutionAmount { get; set; }\n    public string ResolutionTransactionCode { get; set; }\n    public string ResolutionAuthorizationCode { get; set; }\n    public List<string> CRMActions { get; set; }\n    public string Resolver { get; set; }\n}\n\n

Data Dictionary. All fields Required.

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

JSON Field	Description
Id	MidMetricsId received from a webhook call to Events API.
EnterpriseName	Name of enterprise in midmetrics. The enterprise name is the subdomain in the URL before .midmetrics.io. Eg \"acme\" if the URL is https://acme.midmetrics.io/
AlertSource	Must be string \"Ethoca\" or \"Verifi\"
Note	Plaintext note of action taken. 500 length character limit.
VerifiAction	String of either \"DECLINED\" or \"RESOLVED\"
VerifiReasonCode	Integer of one of 4 values: 100 - Case Resolved, Credit & Cancellation processed 102 - Case Resolved, Authorization Cancelled 900 - Unmatched Case - General/Other 951 - Transaction Previously credited for Case Amount, no balance remaining
EthocaCaseStatusCode	Integer of one of 3 values: 1 - Stopped -Refunded 22 - Other - Not Settled 25 - Previously Cancelled - Refunded If you have a use caes in which more detailed Ethoca responses are needed please contact us
ResolutionDate	Date and time of resolution in UTC
ResolutionAmount	Amount of resolution
ResolutionTransactionCode	If a refund was issued, the transaction id in in the internal system of the refund. Empty string if no refund.
ResolutionAuthorizationCode	If a refund was issued, the authorization code of the refund. Empty string if no refund.
CRMActions	Array of string actions taken in CRM. Example [\"Refunded\", \"Blacklisted\", \"Cancelled\"]
Resolver	String of agent or system that took the resolution action.

Responses

\n","_postman_id":"a47ff087-0221-463e-9784-e6951bebf3ef","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://YourEnterpriseName.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":["YourEnterpriseName","midmetrics","io"],"query":[],"variable":[]}},"response":[{"id":"c437f724-db96-4b5a-91ad-e5a442746391","name":"Example","originalRequest":{"method":"GET","header":[],"url":"https://YourEnterpriseName.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://YourEnterpriseName.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.

Examploe paylod:

{
\"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\"
}

ImageContent should be a base64-encoded string of the file contents

Submit Representment

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

Request Format

Method: POST
\n
Endpoint: https://YourEnterpriseName.midmetrics.io/api/Chargeback/SubmitRepresentment
\n

Request Body

The request body must be sent as form-data and should include the following parameters:

\n\n\n\n\n\n\n\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	Description
`MidMetricsId`	text	The unique identifier for the Chargeback inside midmetrics. This value must be retrieved by the Events webhook
`ProcessorCaseId`	text	The 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.
`TrackingNumber`	text	The tracking number associated with the shipment.
`File`	file	A file containing the Representment Letter.

Response Structure

Upon successful submission, the response will return the following

{\n    \"ProcessorId\": {processorCaseId},\n    \"TrackingNumber\": {trackingNumber},\n    \"BytesSaved\": {bytesOfSubmittedFile},\n    \"Message\": \"Representment queued for submission\",\n}\n\n

ProcessorId**:** The processor id submitted with the request.
\n
TrackingNumber**:** The tracking number submitted with the request.
\n
BytesSaved**:** The number of bytes of the submitted file.
\n
Message: String \"Representment queued for submission\" if submission succesful.
\n

Example Request

POST /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

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":"7f0636da-4530-40b4-a36e-e51bfd5bc06e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9dc3948a-ddff-4e5e-ae0c-4e4a35d1f272","type":"text/javascript","exec":[""]}}],"variable":[{"key":"enterpriseName","value":"YourEnterpriseName"},{"key":"APIKey","value":"YourAPIKey"}]}

Authentication

Payload Schema

Auth Types

HMAC signature details (AuthType = 5)

JWT details (AuthType = 6)

Request Delivery

Responses

Examples

Basic auth (default)

Bearer token

API key in header

API key in query string

HMAC-SHA256 signed

OAuth2 JWT (client_credentials)

Schema

Alerts and Informs

Chargebacks

ChargebackUpdate

RDRs

Webhooks

Schema

Schema

Data Dictionary. All fields Required.

Responses

Submit Representment

Request Format

Request Body

Response Structure

Example Request

HMAC signature details (`AuthType = 5`)

JWT details (`AuthType = 6`)