Create Dispute Data
Use our API to create test dispute data.
Follow this guide to create sandbox dispute data to test your integration. See Create Dispute Data in API Reference for field definitions. See the Dispute Management Guide in Additional Features for information on how to handle disputes. If you wish to use API to manage disputes, please contact Maast Support first.
Prerequisites
- See Create a Sandbox Account to sign up and log in to the Maast Manager portal.
- Follow the steps in Get Your API Credentials to save a sandbox ID and API key.
- See Authentication to format the credentials and generate your API token. (Alternatively, use the credentials as-is to test this endpoint with our 'Try It!' feature.)
Implement
Write a GET request. For the request endpoint, insert your merchant ID between dispute/
and /create
. The resulting endpoint is /platform/dispute/{merchantId}/create
, where the merchant ID value replaces {merchantId}
. See the sample code below:
curl --request GET \
--url 'https://api-test.maast.com/platform/dispute/210000000289/create' \
--header 'accept: application/json' \
--header 'authorization: Basic OjllZGVjMjFhMzFjMHh5ejc4OWUzMGEzNDE2YWJjMTIz'
For the dispute reason code, do the following:
- Find the appropriate reason code in Dispute Conventions.
- Append the reason code to the end of the request url, preceded by
?reasonCode=
.
Once configured, your request will resemble the sample code below:
curl --request GET \
--url 'https://api-test.maast.com/platform/dispute/210000000289/create?reasonCode=10.3' \
--header 'accept: application/json' \
--header 'authorization: Basic OjllZGVjMjFhMzFjMHh5ejc4OWUzMGEzNDE2YWJjMTIz'
Integrate
Once you have written and sent your GET request, you will receive a response like this from the Maast server:
{
"code": 0,
"message": "Success",
"data": [
{
"rec_id": 393435800000003,
"merchant_id": 210000000289,
"incoming_date": "2025-01-01",
"amt_tran": 79.9,
"amt_dispute": 79.9,
"reason_code": "10.3",
"reason_desc": "Other Fraud – Card Present Environment",
"data_type": "C",
"cbr_workflow": "A",
"status": "N",
"date_status_change": "2025-01-01",
"card_number": "411111xxxxxx1111",
"tran_date": "2024-12-11",
"reference_number": "24050838070212000000323",
"cb_ref_num": "100032",
"cb_ref_num_assoc": 0
}
]
}
Check the code
field in the request response: 0
confirms success. If the value is something other than 0
, check Platform API Response Codes in Reference.
The data
field shows an array of dispute data, including the rec_id
value used to interact with the dispute. The Get Disputes API reference provides response field definitions that also apply to a 'Create dispute data' success response.
Test and Go Live
See our Test and Go Live guide to test your API integration and to start transacting with an active production account.
Updated 9 months ago