Skip to content

Document 1000-char limit for report-transaction notes #1671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marselester merged 2 commits into from
Jul 23, 2026
Merged

Document 1000-char limit for report-transaction notes #1671

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba0e63d
Document 1000-char limit for report-transaction notes
faktas2 Jun 8, 2026
69f2212
Add a comma
faktas2 Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions content/minfraud/report-a-transaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,15 +325,15 @@ The minFraud API accepts input as JSON in the body of an HTTP POST. The JSON
document should consist of a single object. That object may contain the
following keys (key names are case-sensitive):

| Data field name | Type | Data field description |
| ------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ip_address** | string | _Conditionally required.[^1]_ The IP address of the customer placing the order. This should be passed as a string like “44.55.66.77” or “2001:db8::2:1”. |
| **tag** | string | **Required.** A string indicating the likelihood that a transaction may be fraudulent, or `clear` to retract a previous report. Possible values: `not_fraud`, `suspected_fraud`, `spam_or_abuse`, `chargeback`, or `clear`. |
| **chargeback_code** | string | _Optional._ A string which is provided by your payment processor indicating the [reason for the chargeback](https://en.wikipedia.org/wiki/Chargeback#Reason_codes). |
| **maxmind_id** | string (8) | _Conditionally required.[^1]_ A unique eight character string identifying a minFraud Standard or Premium request. These IDs are returned in the `maxmindID` field of a response for a successful minFraud request. |
| **minfraud_id** | string (36) | _Conditionally required.[^1]_ A UUID that identifies a minFraud Score, minFraud Insights, or minFraud Factors request. This ID is returned at `/id` in the response. |
| **notes** | string | _Optional._ Your notes on the fraud tag associated with the transaction. We manually review many reported transactions to improve our scoring for you so any additional details to help us understand context are helpful. |
| **transaction_id** | string | _Conditionally required.[^1]_ The transaction ID you originally passed to minFraud. |
| Data field name | Type | Data field description |
| ------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ip_address** | string | _Conditionally required.[^1]_ The IP address of the customer placing the order. This should be passed as a string like “44.55.66.77” or “2001:db8::2:1”. |
| **tag** | string | **Required.** A string indicating the likelihood that a transaction may be fraudulent, or `clear` to retract a previous report. Possible values: `not_fraud`, `suspected_fraud`, `spam_or_abuse`, `chargeback`, or `clear`. |
| **chargeback_code** | string | _Optional._ A string which is provided by your payment processor indicating the [reason for the chargeback](https://en.wikipedia.org/wiki/Chargeback#Reason_codes). |
| **maxmind_id** | string (8) | _Conditionally required.[^1]_ A unique eight character string identifying a minFraud Standard or Premium request. These IDs are returned in the `maxmindID` field of a response for a successful minFraud request. |
| **minfraud_id** | string (36) | _Conditionally required.[^1]_ A UUID that identifies a minFraud Score, minFraud Insights, or minFraud Factors request. This ID is returned at `/id` in the response. |
| **notes** | string | _Optional._ Your notes on the fraud tag associated with the transaction. We manually review many reported transactions to improve our scoring for you, so any additional details to help us understand context are helpful. Must be 1000 Unicode characters or fewer. |
| **transaction_id** | string | _Conditionally required.[^1]_ The transaction ID you originally passed to minFraud. |

[^1]:
You must provide at least one of `ip_address`, `maxmind_id`, `minfraud_id`,
Expand Down Expand Up @@ -366,6 +366,7 @@ to handle any valid HTTP 4xx or 5xx status code.
| MAXMIND_ID_INVALID | 400 Bad Request | You have supplied an invalid `maxmind_id`. This field is case sensitive. Check your `maxmind_id` to ensure that it is 8 characters in length and made up only of digits and upper case letters. This value must come from the successful response to a previous minFraud request. |
| MINFRAUD_ID_INVALID | 400 Bad Request | You have supplied an invalid `minfraud_id`. Check your `minfraud_id` to ensure that it is a valid UUID as returned in the minFraud Score, minFraud Insights, or minFraud Factors response. |
| PARAMETER_UNKNOWN | 400 Bad Request | You have supplied an unknown parameter. Check the keys in your JSON data to ensure that you have not misspelled any of the field names or passed a field name which is not listed in [the available input fields](#request-body). |
| NOTES_INVALID | 400 Bad Request | Your request includes a `notes` field that exceeds 1000 Unicode characters. |
| TAG_REQUIRED | 400 Bad Request | Your request does not include a `tag` field. |
| TAG_INVALID | 400 Bad Request | Your request includes an invalid `tag` field. |
| TRANSACTION_ID_REQUIRED | 400 Bad Request | Your request must include one of the following fields: `ip_address`, `maxmind_id`, `minfraud_id`, or `transaction_id`. |
Expand Down
Loading