Chargeback Search
1 min
POST
https://api.accertify.net/api/cbv1/search
Body Parameters
- searchobjectExample
{ "CaseInitStartDate": "2022-09-28", "CaseInitEndDate": "2022-10-04", "IsClaimed": false, "ResolutionIsBlank": true, "Action": "claim" }Description- HierarchyIdstringExampleDescription
- DatabaseIdstringExampleDescription
- CaseIdstringExampleDescription
- CaseInitStartDatestringExampleDescription
- CaseInitEndDatestringExampleDescription
- ReplyByDatestringExampleDescription
- CaseTxnStartDatestringExampleDescription
- CaseTxnEndDatestringExampleDescription
- IssuerProcessIdstringExampleDescription
- AcquirerProcessIdstringExampleDescription
- ARNstringExampleDescription
- PaymentFacilitatorIdstringExampleDescription
- CurrentStatestringExampleDescription
- TransactionRefNumstringExampleDescription
- FollowupIsBlankbooleanDescriptionAllowedtruefalse
- FollowupstringExampleDescription
- ResolutionIsBlankbooleanExampleDescriptionAllowedtruefalse
- ResolutionstringExampleDescription
- IsClaimedbooleanDescriptionAllowedtruefalse
- Actionstring<claim | unclaim | none>ExampleDescriptionAllowedclaimunclaimnone
- MaxRecordsnumber<integer>ExampleDescriptionFormatinteger
Responses
200
- ResultExample
{ "MoreRecords": false, "Result": [ { "ClaimSuccessful": true, "Resolution Date": null, "BIN": 234567, "import_time": "Fri Aug 26 14:28:53 CDT 2022", "DatabaseId": 5237260313459799000, "resolutions": null, "Order Number": "ORDER 1", "Transaction ID": null, "Resolution Reason": null } ] }Description
400
- ValidationFailedErrorDescription
- errorCodenumber<integer>ExampleDescriptionFormatinteger
- errorMessagestringExampleDescription
- errorsobjectExampleDescription
401
- NotAuthorizedErrorDescription
- errorCodenumber<integer>ExampleDescriptionFormatinteger
- errorMessagestringExampleDescription
404
- NotFoundErrorDescription
- errorCodenumber<integer>ExampleDescriptionFormatinteger
- errorMessagestringExampleDescription
500
- InternalServerErrorDescription
- errorCodenumber<integer>ExampleDescriptionFormatinteger
- errorMessagestringExampleDescription
curl
curl --request POST \
--url https://api.accertify.net/api/cbv1/search \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.accertify.net/api/cbv1/search", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.accertify.net/api/cbv1/search")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.accertify.net/api/cbv1/search"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Transaction is found and column values returned.
{}400
// Error response for requests are sent in following cases:
One or more invalid or missing inputs.
{
"errorMessage":"Validation Failed",
"errorCode":400,
"errors":[
"One or more required fields is missing"
]
}
End Date is before Start Date
{
"errorMessage":"Validation Failed",
"errorCode":400,
"errors":[
"End Date is before Start Date"
]
}
Start Date or End Date is too far in the past
{
"errorMessage":"Validation Failed",
"errorCode":400,
"errors":[
"Start Date or End Date is too far in the past"
]
}
Date range exceeded.
{
"errorMessage":"Validation Failed",
"errorCode":400,
"errors":[
"Date range exceeded"
]
}
Invalid fields
{
"errorMessage":"Validation Failed",
"errorCode":400,
"errors":[
"Invalid fields Name = CaseInitStartDate, Value = 2022-09-31"
]
{
"errorCode": 400,
"errorMessage": "Validation Failed",
"errors": {}
}401
// Error response for authorization failures.
{
"errorCode": 401,
"errorMessage": "Not authorized"
}404
// Error response for unknown API requests or no matching records.
Unknown API
{
"errorMessage": "Unknown API",
"errorCode": 404,
"errors": []
]
}
No failed validations but no matching records.
{
"errorMessage": "No matching record found",
"errorCode": 404,
"errors": []
]
}
{
"errorCode": 404,
"errorMessage": "Unknown API"
}500
// Error response when we are unable to process due to internal error.
{
"errorCode": 500,
"errorMessage": "Internal Server Error"
}