Risk and Intelligence APIs
CARE API Overview
Full Path
4 min
Topic type: Reference
Purpose: To show examples of the full CARE Request and Settlement API paths.
Audience: API integrators and client developers implementing CARE transactions.
Applies to: Clients using the CARE API for claims, adjustments, refunds, returns, and exchanges via API.
Does not apply to: Retail/Fraud industry APIs or clients using non-API CARE integrations.
{
"eventSource": "agentPhone",
"careID": "32sfdu8f23234",
"originalTransactionID": "32432234",
"careRequestAmount": 1082.91,
"careSettlementAmount": 1082.91,
"careCurrencyCode": "USD",
"careEventType": "claim",
"careReason": "itemNoLongerWanted",
"careTransactionDateTime": "2022-07-12T15:46:34.0Z",
"accountID": "98893298432",
"ipAddress": "192.168.41.17",
"emailAddress": "[email protected]",
"items": [
{
"isGiftCard": "true",
"brandName": "Apple",
"category": "Computer",
"description": "Macbook Pro",
"itemID": "SKU123",
"price": 9.99,
"quantity": 3,
"addressID": "23kj423klj234j",
"productCondition": "new",
"shippingCompany": "dhl",
"shippingMethod": "digital",
"shippingTrackingNumber": "23l4fdswerea02",
"isLargeItemDelivery": "true",
"careItemReason": "boxDamaged",
"careSettlementReason": "inspectedAndInvoiced",
"careSettlementDecision": "deny",
"careSettlementPrice": 121.49,
"careSettlementUnits": "1",
"originationScanPostCode": "60143",
"returnDeliveryDateTime": "2022-01-01T17:07:24-07:00",
"returnShippingMethod": "ground",
"returnTrackingNumber": "23jkljksldsj23e4",
"originalDeliveryDateTime": "2022-03-12T00:07:24.0Z",
"isDeliveryImageProvided": "true",
"deliveryImage": ""
}
],
"brand": "Acme",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0",
"devicePayload": "afklasdjlasdjl3l23j23423klj",
"deviceTransactionID": "e1a1aade06e2557f34036eeb06173faf1fa05c64959383",
"ubaID": "3143e969395de649c48c1c9f3e363a3e7ae7",
"sessionID": "961b521892e68f6c4d1c8459dfb530466eed",
"latitude": null,
"longitude": null,
"addresses": [
{
"address1": "1863 Main Street",
"address2": "Apt 7",
"addressID": "",
"addressType": "shipping",
"city": "Anaheim",
"country": "US",
"emailAddress": "[email protected]",
"firstName": "",
"lastName": "",
"phone": "3125555555",
"phoneCountryCode": "001",
"postCode": "92802",
"region": "CA"
}
],
"paymentMethods": [
{
"cardBin": 345678,
"cardLastFour": "4564",
"cardNumber": "Kb7ofu6hYN4WxM4_INAZigXoWlAi79LuhcSpwx5UcVc",
"cardToken": "",
"emailAddress": "[email protected]",
"expirationDay": "12",
"expirationMonth": "11",
"expirationYear": "2026",
"giftCardBIN": "4111",
"giftCardLastFour": "1111",
"giftCardNumber": "a789sdf8asdfasd89f789asd78",
"isPaymentStoredOnFile": true,
"loyaltyProgramName": "Acme Platinum",
"nameOnAccount": "Jane Doe",
"nameOnCreditCard": "Jane Doe",
"paymentMethodAmount": 1,
"paymentMethodBalanceAmount": -100000000,
"paymentMethodID": "2ljr9vxsdfew",
"paymentType": "creditCard",
"points": 50000,
"walletStatus": "active",
"walletType": "Applepay"
}
]
}
{
"eventSource": "agentPhone",
"careID": "32sfdu8f23234",
"originalTransactionID": "32432234",
"careRequestAmount": 1082.91,
"careSettlementAmount": 1082.91,
"careCurrencyCode": "USD",
"careEventType": "claim",
"careReason": "itemNoLongerWanted",
"careTransactionDateTime": "2022-07-12T15:46:34.0Z",
"accountID": "98893298432",
"ipAddress": "192.168.41.17",
"emailAddress": "[email protected]",
"items": [
{
"isGiftCard": "true",
"brandName": "Apple",
"category": "Computer",
"description": "Macbook Pro",
"itemID": "SKU123",
"price": 9.99,
"quantity": 3,
"addressID": "23kj423klj234j",
"productCondition": "new",
"shippingCompany": "dhl",
"shippingMethod": "digital",
"shippingTrackingNumber": "23l4fdswerea02",
"isLargeItemDelivery": "true",
"careItemReason": "boxDamaged",
"careSettlementReason": "inspectedAndInvoiced",
"careSettlementDecision": "deny",
"careSettlementPrice": 121.49,
"careSettlementUnits": "1",
"originationScanPostCode": "60143",
"returnDeliveryDateTime": "2022-01-01T17:07:24-07:00",
"returnShippingMethod": "ground",
"returnTrackingNumber": "23jkljksldsj23e4",
"originalDeliveryDateTime": "2022-03-12T00:07:24.0Z",
"isDeliveryImageProvided": "true",
"deliveryImage": ""
}
],
"brand": "Acme",
"addresses": [
{
"address1": "1863 Main Street",
"address2": "Apt 7",
"addressID": "",
"addressType": "shipping",
"city": "Anaheim",
"country": "US",
"emailAddress": "[email protected]",
"firstName": "",
"lastName": "",
"phone": "3125555555",
"phoneCountryCode": "001",
"postCode": "92802",
"region": "CA"
}
],
"paymentMethods": [
{
"cardBin": 345678,
"cardLastFour": "4564",
"cardNumber": "Kb7ofu6hYN4WxM4_INAZigXoWlAi79LuhcSpwx5UcVc",
"cardToken": "",
"emailAddress": "[email protected]",
"expirationDay": "12",
"expirationMonth": "11",
"expirationYear": "2026",
"giftCardBIN": "4111",
"giftCardLastFour": "1111",
"giftCardNumber": "a789sdf8asdfasd89f789asd78",
"isPaymentStoredOnFile": true,
"loyaltyProgramName": "Acme Platinum",
"nameOnAccount": "Jane Doe",
"nameOnCreditCard": "Jane Doe",
"paymentMethodAmount": 1,
"paymentMethodBalanceAmount": -100000000,
"paymentMethodID": "2ljr9vxsdfew",
"paymentType": "creditCard",
"points": 50000,
"walletStatus": "active",
"walletType": "Applepay"
}
]
}
Field Reference
View field requirements, paths, and try it out!

CARE field references