DEVELOPER

Merchant Management API Specification

Version 1.11.3

production
sandbox

Merchant Management API

Get Chargebacks by State

get /merchant-risk-management/disputes/mid/{merchantId}/chargebacks

Get merchant chargebacks by their state. Chargebacks can either be open (actionable), pending (in review), or closed. The date range for the query must be within the last 18 months. If the toDate parameter is not provided, it defaults to the current date.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

state required
string
Enum:
open
pending
closed

Loading...

fromDate required
string
Example:
2024-01-01

Loading...

toDate
string
Example:
2024-12-31

Loading...

Example Response
200 Successful response
400 Bad request response
403 Forbidden error response
500 Internal server error response

Get Request For Clarity (RFC) Notes

get /merchant-risk-management/disputes/mid/{merchantId}/rfcs/{rfcGuid}/notes

Get notes related to a Request For Clarity (RFC). An RFC is a way for a bank to obtain more transaction data from the merchant before proceeding with a formal chargeback. The goal is to resolve the issue, prevent an unnecessary dispute, and avoid costly chargeback fees for the merchant.

Parameters
merchantId required
string
Minimum:
1
Example:
111222333444555

Loading...

rfcGuid required
string1 to 20 characters
Example:
02RENNGTDM09E4DWYG2

Loading...

Example Response
200 Successful response
400 Bad request - GUID provided was not found
403 Forbidden error response
408 Request timeout
422 Unprocessable entity error response
500 Internal server error response

Add Request For Clarity (RFC) Notes

post /merchant-risk-management/disputes/mid/{merchantId}/rfcs/{rfcGuid}/notes

Add notes to a Request for Clarity (RFC). An RFC is a way for a bank to obtain more transaction data from the merchant before proceeding with a formal chargeback. Adding notes can help provide clarity and potentially resolve the issue. The goal is to prevent an unnecessary dispute and avoid costly chargeback fees for the merchant.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

rfcGuid required
string1 to 20 characters
Example:
02RENNJD70QAZF1RR5Z

Loading...

Request Schema
note required
string^[a-zA-Z0-9!@#$%&* ,.?()+_'"/:;-]{1,1000}$
Maximum:
1000

Loading...

Example Request
{
  "note": "Customer provided receipt for disputed transaction"
}
Example Response
200 Successful response
400 Bad Request - GUID provided was not found.
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Get Open RFCs

get /merchant-risk-management/disputes/mid/{merchantId}/rfcs/open

Get RFCs that are in progress. During this time, the involved parties may add notes or documents to the RFC in an effort to resolve the issue before a formal chargeback is initiated. If the RFC is not resolved within the specified timeframe, it may escalate to a chargeback. Merchants should monitor open RFCs closely and provide any requested information promptly to avoid unnecessary chargebacks.

Parameters
merchantId required
string
Minimum:
1
Example:
111222333444555

Loading...

fromDate required
string
Example:
2024-01-01

Loading...

toDate
string
Example:
2024-12-31

Loading...

Example Response
200 Successful response
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Get Closed RFCs

get /merchant-risk-management/disputes/mid/{merchantId}/rfcs/closed

Get closed RFCs associated with a merchant. Closed RFCs are those that have been resolved, either by providing the requested information or by escalating to a formal chargeback if the issue could not be resolved.

Parameters
merchantId required
string
Minimum:
1
Example:
111222333444555

Loading...

fromDate required
string
Example:
2024-01-01

Loading...

toDate
string
Example:
2024-12-31

Loading...

Example Response
200 Successful response
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Get Chargeback Notes

get /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/notes

Get notes related to a chargeback. Chargeback notes provide additional context and information about the chargeback case, which can be useful for both merchants and banks in understanding the dispute and its resolution. These notes may include details about communications, evidence provided, or any other relevant information pertaining to the chargeback process.

Parameters
merchantId required
string
Minimum:
1
Example:
111222333444555

Loading...

chargebackGuid required
string1 to 20 characters
Example:
02RENNGTDM09E4DWYG2

Loading...

Example Response
200 Successful response
400 Bad Request - GUID provided was not found.
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Add Chargeback Notes

post /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/notes

Add notes to a merchant chargeback. Adding notes can help provide additional context or information related to the chargeback, which may assist in its resolution. Notes can include details such as communication with the customer, evidence provided, or any other relevant information. These notes become part of the chargeback record and can be referenced during the dispute resolution process.

Parameters
merchantId required
string
Minimum:
1
Example:
111222333444555

Loading...

chargebackGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

Request Schema
note required
string^[a-zA-Z0-9!@#$%&* ,.?()+_'"/:;-]{1,1000}$
Maximum:
1000

Loading...

Example Request
{
  "note": "Customer provided receipt for disputed transaction"
}
Example Response
200 Successful response
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Get Chargeback Document

get /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/documents/{documentId}

Get a document associated with a chargeback. The document could provide supporting information related to the chargeback case. The document data is returned as a Base64 encoded string. You will need to decode the string to retrieve the original document content.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

chargebackGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

documentId required
number
Example:
7000000164453

Loading...

Example Response
200 Successful response
400 Bad request - document not found
422 Unprocessable entity error response
500 Internal server error response

Get RFC Document

get /merchant-risk-management/disputes/mid/{merchantId}/rfcs/{rfcGuid}/documents/{documentId}

Get a document associated with an RFC. The document could provide supporting information related to the RFC case.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

rfcGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

documentId required
number
Example:
7000000164453

Loading...

Example Response
200 Successful response
400 Bad request - document not found
422 Unprocessable entity error response
500 Internal server error response

Get Chargeback Documents

get /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/documents

Get the list of documents for a merchant chargeback. These documents may include supporting information related to the chargeback case. If no documents are found, an empty list will be returned.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

chargebackGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

Example Response
200 Successful response
400 Bad request - GUID provided was not found
403 Forbidden error response
408 Request timeout error response
422 Unprocessable entity error response
500 Internal server error response

Attach Chargeback Document

post /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/documents

Attach a file to a merchant chargeback. This document could provide additional information related to the chargeback case. The document should be encoded in Base64 format. Ensure that the document size does not exceed the maximum allowed limit and that the file type is supported.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

chargebackGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

Request Schema
fileData required
string

Loading...

extension required
string^([a-zA-Z0-9\.\-]){1,6}$

Loading...

contentType required
string^([a-zA-Z0-9\/\-\.]){1,80}$

Loading...

description required
string^([a-zA-Z0-9\.\-\s,\']){1,50}$

Loading...

Example Request
{
  "fileData": "string",
  "extension": "string",
  "contentType": "string",
  "description": "string"
}
Example Response
200 Successful response
400 Bad Request - GUID not found.
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Get List of RFC Documents

get /merchant-risk-management/disputes/mid/{merchantId}/rfcs/{rfcGuid}/documents

Get the list of documents for a merchant RFC. These documents may include supporting information related to the RFC case.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

rfcGuid required
string1 to 20 characters
Example:
02RENNGTDM09E4DWYG2

Loading...

Example Response
200 Successful response
400 Bad request - GUID provided was not found
403 Forbidden error response
408 Request timeout
422 Unprocessable entity error response
500 Internal server error response

Attach RFC Document

post /merchant-risk-management/disputes/mid/{merchantId}/rfcs/{rfcGuid}/documents

Attach a file to a merchant RFC. This document could provide additional information related to the RFC case.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

rfcGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

Request Schema
fileData required
string

Loading...

extension required
string^([a-zA-Z0-9\.\-]){1,6}$

Loading...

contentType required
string^([a-zA-Z0-9\/\-\.]){1,80}$

Loading...

description required
string^([a-zA-Z0-9\.\-\s,\']){1,50}$

Loading...

Example Request
{
  "fileData": "string",
  "extension": "string",
  "contentType": "string",
  "description": "string"
}
Example Response
200 Successful response
400 Bad Request - GUID not found.
403 Forbidden error response
408 Request timeout
422 Unprocessable entity error response
500 Internal server error response

Respond to RFC

post /merchant-risk-management/disputes/mid/{merchantId}/rfcs/{rfcGuid}/respond

Submit a merchant RFC for review. This action indicates that the merchant has provided all necessary information and is ready for the RFC to be evaluated. Once submitted, the RFC will be reviewed by the appropriate team to determine the next steps. Note that once an RFC is submitted for review, it cannot be modified or withdrawn. Ensure that all required documentation and information are included before submitting.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

rfcGuid required
string1 to 20 characters
Example:
003EUWXAD7DEKP2F000

Loading...

Example Response
200 Successful response
400 Bad request - GUID not found
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Accept Chargeback

post /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/accept

Accept a merchant chargeback. This action indicates that the merchant agrees with the chargeback and will not contest it further. By accepting the chargeback, the merchant acknowledges the validity of the dispute and agrees to the associated financial implications. Once a chargeback is accepted, it cannot be reversed, and the funds will be adjusted accordingly. Ensure that the decision to accept the chargeback is made after careful consideration of all relevant information and documentation.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

chargebackGuid required
string1 to 20 characters
Example:
003EUWXAD7DEKP2F000

Loading...

Request Schema
disputeTypeCode required
string2 to 2 characters
Enum:
AR
CB
IQ
PA
Example:
CB

Loading...

Example Request
{
  "disputeTypeCode": "CB"
}
Example Response
200 Successful response
400 Bad request - GUID not found
403 Forbidden error response
408 Request timeout
422 Unprocessable entity error response
500 Internal server error response

Rebut Chargeback

post /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/rebut

Rebut a merchant chargeback. This action indicates that the merchant disputes the chargeback and wishes to contest it further. Provide the reason for the rebuttal in the request body. By rebutting the chargeback, the merchant initiates a review process where additional information and documentation may be required to support their position. Ensure that all relevant evidence is gathered and submitted to strengthen the rebuttal case. Once a chargeback is rebutted, it will be reviewed by the appropriate team to determine the outcome of the dispute.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

chargebackGuid required
string1 to 20 characters
Example:
003EUWXAD7DEKP2F000

Loading...

Request Schema
disputeTypeCode required
string2 to 2 characters
Enum:
AR
CB
IQ
PA
Example:
CB

Loading...

Example Request
{
  "disputeTypeCode": "CB"
}
Example Response
200 Successful response
400 Bad request - GUID not found
403 Forbidden error response
408 Request timeout
422 Unprocessable entity error response
500 Internal server error response

Get Chargeback Details

get /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/details

Get details for a merchant chargeback. This endpoint retrieves comprehensive information about a specific chargeback associated with a merchant. The details provided include transaction information, chargeback reason, amounts involved, and current status of the dispute. This information is crucial for merchants to understand the context of the chargeback and to take appropriate actions if necessary. Ensure that you have the correct merchant ID and chargeback GUID to access the relevant details.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

chargebackGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

Example Response
200 Successful response
400 Bad Request - GUID not found.
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Get RFC Details

get /merchant-risk-management/disputes/mid/{merchantId}/rfcs/{rfcGuid}/details

Get details for a merchant RFC. This endpoint retrieves comprehensive information about a specific Request for Chargeback (RFC) associated with a merchant. The details provided include transaction information, RFC reason, amounts involved, and current status of the dispute. This information is crucial for merchants to understand the context of the RFC and to take appropriate actions if necessary. Ensure that you have the correct merchant ID and RFC GUID to access the relevant details.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

rfcGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

Example Response
200 Successful response
400 Bad Request - GUID not found.
403 Forbidden error response
422 Unprocessable entity error response
500 Internal server error response

Add Chargeback Authorization

post /merchant-risk-management/disputes/mid/{merchantId}/chargebacks/{chargebackGuid}/disclaimer-authorization

Submits authorization data, such as a digital signature, for a merchant chargeback. This endpoint allows merchants to provide the necessary authorization information required to process a chargeback. The authorization data should be formatted as a valid JSON string and may include details such as the merchant's digital signature or other relevant authorization credentials. By submitting this information, merchants can ensure that their chargeback cases are properly documented and authorized for further processing. It is important to ensure that the authorization data is accurate and complete to avoid any delays in the chargeback resolution process.

Parameters
merchantId required
string
Minimum:
1
Example:
9001

Loading...

chargebackGuid required
string1 to 20 characters
Example:
02RENN6WLJW01NV5M5A

Loading...

Request Schema
authorizationData required
string

Loading...

Example Request
{
  "authorizationData": "{\"digital_signature\" : \"John Doe\"}"
}
Example Response
200 Successful response
400 Bad Request - GUID not found.
403 Forbidden error response
422 Unprocessable entity error response for validation failures
500 Internal server error response
©2025 North is a registered DBA of NorthAB, LLC. All rights reserved. North is a registered ISO of BMO Harris Bank N.A., Chicago, IL, Citizens Bank N.A., Providence, RI, The Bancorp Bank, Philadelphia, PA, FFB Bank, Fresno, CA, Wells Fargo Bank, N.A., Concord, CA, and PNC Bank, N.A.