CARE Settlement
1 min
POST
https://icnow01.accertify.net//icNowImport/{settlementimporterID}
Path Parameters
- settlementimporterIDstringrequired
Body Parameters
- settlementtransactionobjectDescription
- eventSourcestring<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>requiredDescriptionAllowedagentPhoneagentStoreaffiliatekioskmobileAppotherweb
- careIDstringrequiredExampleDescription
- careTransactionDateTimestring<date-time>ExampleDescriptionFormatdate-time
- careRequestAmountnumber<float>requiredExampleDescriptionFormatfloat
- careSettlementAmountnumber<float>requiredExampleDescriptionFormatfloat
- careCurrencyCodestringrequiredExampleDescription
- careEventTypestring<claim | adjustment | refund | reship | return | exchange>requiredDescriptionAllowedclaimadjustmentrefundreshipreturnexchange
- careReasonstring<boxDamaged | didNotReceive | duplicateItem | itemDamaged | itemDefective | itemIncorrect | itemNotNeeded | itemNoLongerWanted>requiredExampleDescriptionAllowedboxDamageddidNotReceiveduplicateItemitemDamageditemDefectiveitemIncorrectitemNotNeededitemNoLongerWanted
- originalTransactionIDstringrequiredExampleDescription
- accountIDstringExampleDescription
- ipAddressstringExampleDescription
- emailAddressstringExampleDescription
- itemsobject[]Description
- isGiftCardstring<true | false>DescriptionAllowedtruefalse
- brandNamestringExampleDescription
- categorystringExampleDescription
- descriptionstringExampleDescription
- itemIDstringExampleDescription
- pricenumberExampleDescription
- quantitynumberExampleDescription
- addressIDstringExampleDescription
- productConditionstring<new | openPackage | other | refurbished | used>DescriptionAllowednewopenPackageotherrefurbishedused
- shippingCompanystring<dhl | fedex | ups | usps | other>DescriptionAlloweddhlfedexupsuspsother
- shippingMethodstring<digital | ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>DescriptionAlloweddigitalgroundinternationalothernextDaysameDaystorePickuptwoDaythreeDay
- shippingTrackingNumberstringExampleDescription
- isLargeItemDeliverystring<true | false>DescriptionAllowedtruefalse
- careItemReasonstring<boxDamaged | didNotReceive | duplicateItem | itemDamaged | itemDefective | itemIncorrect | itemNotNeeded | itemNoLongerWanted>DescriptionAllowedboxDamageddidNotReceiveduplicateItemitemDamageditemDefectiveitemIncorrectitemNotNeededitemNoLongerWanted
- careSettlementReasonstring<inspectedAndInvoiced | emptyBox>ExampleDescriptionAllowedinspectedAndInvoicedemptyBox
- careSettlementDecisionstring<accept | deny | review>ExampleDescriptionAllowedacceptdenyreview
- careSettlementPricenumberExampleDescription
- careSettlementUnitsstringExampleDescription
- originationScanPostCodestringExampleDescription
- returnDeliveryDateTimestringExampleDescription
- returnShippingMethodstring<ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>ExampleDescriptionAllowedgroundinternationalothernextDaysameDaystorePickuptwoDaythreeDay
- returnTrackingNumberstringExampleDescription
- originalDeliveryDateTimestring<date-time>ExampleDescriptionFormatdate-time
- isDeliveryImageProvidedstring<true | false>DescriptionAllowedtruefalse
- deliveryImagestringDescription
- brandstringExampleDescription
- addressesobject[]Description
- address1stringExampleDescription
- address2stringExampleDescription
- addressIDstringDescription
- addressTypestring<shipping | billing>ExampleDescriptionAllowedshippingbilling
- citystringExampleDescription
- countrystringExampleDescription
- emailAddressstringExampleDescription
- firstNamestringDescription
- lastNamestringDescription
- phonestringExampleDescription
- phoneCountryCodestringExampleDescription
- postCodestringExampleDescription
- regionstringExampleDescription
- paymentMethodsobject[]Description
- cardBinnumber<float>ExampleDescriptionFormatfloat
- cardLastFourstringExampleDescription
- cardNumberstringExampleDescription
- cardTokenstringDescription
- emailAddressstringExampleDescription
- expirationDaystringExampleDescription
- expirationMonthstringExampleDescription
- expirationYearstringExampleDescription
- giftCardBINstringExampleDescription
- giftCardLastFourstringExampleDescription
- giftCardNumberstringExampleDescription
- isPaymentStoredOnFilebooleanExampleDescription
- loyaltyProgramNamestringExampleDescription
- nameOnAccountstringExampleDescription
- nameOnCreditCardstringExampleDescription
- paymentMethodAmountnumber<float>ExampleDescriptionFormatfloat
- paymentMethodBalanceAmountnumber<float>DescriptionFormatfloat
- paymentMethodIDstringExampleDescription
- paymentTypestring<creditCard | digitalWallet | giftCard | voucher | loyaltyPoints | bankAccount>ExampleDescriptionAllowedcreditCarddigitalWalletgiftCardvoucherloyaltyPointsbankAccount
- pointsnumber<float>ExampleDescriptionFormatfloat
- walletStatusstringExampleDescription
- walletTypestringExampleDescription
Responses
200
- successResponseDescription
- transaction-resultsobjectExample
{ "transaction-id": "ba563b98-36fa-42f2-a8af-3fd4af34e347", "cross-reference": "f85b9ed2-fe5a-425a-9ff5-a9988e56110b", "remarks": "", "warnings": {} }Description- transaction-idstringDescription
- cross-referencestringDescription
- remarksstringDescription
- warningsobjectDescription
400
- errorResponseExample
{ "error": "The request could not be processed", "validation_response": { "errors": { "Transaction ID": "A unique transaction ID is required (max length = 40)" }, "status": false } }Description- validation_responseobject
- errorsstring[]
- statusstring<true when there are no errors | false when there are errors>DescriptionAllowedtrue when there are no errorsfalse when there are errors
- errorstring
500
- errorResponseExample
{ "error": "The request could not be processed", "validation_response": { "errors": { "Transaction ID": "A unique transaction ID is required (max length = 40)" }, "status": false } }Description- validation_responseobject
- errorsstring[]
- statusstring<true when there are no errors | false when there are errors>DescriptionAllowedtrue when there are no errorsfalse when there are errors
- errorstring
curl
curl --request POST \
--url https://icnow01.accertify.net//icNowImport/{settlementimporterID} \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"eventSource": "",
"careID": "32sfdu8f23234",
"careRequestAmount": 1082.91,
"careSettlementAmount": 1082.91,
"careCurrencyCode": "USD",
"careEventType": "",
"careReason": "itemNoLongerWanted",
"originalTransactionID": 32432234
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"eventSource": "",
"careID": "32sfdu8f23234",
"careRequestAmount": 1082.91,
"careSettlementAmount": 1082.91,
"careCurrencyCode": "USD",
"careEventType": "",
"careReason": "itemNoLongerWanted",
"originalTransactionID": 32432234
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://icnow01.accertify.net//icNowImport/{settlementimporterID}", 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://icnow01.accertify.net//icNowImport/{settlementimporterID}")
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"
request.body = JSON.dump({
"eventSource": "",
"careID": "32sfdu8f23234",
"careRequestAmount": 1082.91,
"careSettlementAmount": 1082.91,
"careCurrencyCode": "USD",
"careEventType": "",
"careReason": "itemNoLongerWanted",
"originalTransactionID": 32432234
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://icnow01.accertify.net//icNowImport/{settlementimporterID}"
payload = json.dumps({
"eventSource": "",
"careID": "32sfdu8f23234",
"careRequestAmount": 1082.91,
"careSettlementAmount": 1082.91,
"careCurrencyCode": "USD",
"careEventType": "",
"careReason": "itemNoLongerWanted",
"originalTransactionID": 32432234
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success response
{
"transaction-results": {
"transaction-id": "",
"cross-reference": "",
"remarks": "",
"warnings": {}
}
}400
// Error response
{
"validation_response": {
"errors": [
""
],
"status": "",
"error": ""
}
}500
// Error response
{
"validation_response": {
"errors": [
""
],
"status": "",
"error": ""
}
}