This page is intended for third parties which provide chargeback mitigation and management. We have outlined a way to implement your chargeback management with RevCent. This uses the RevCent Functions feature as well as the RevCent API.
If you prefer to instead integrate with RevCent by logging in on behalf of the user, please read the Chargeback page.
This guide assumes the following:
This guide will outline how to create and utilize a RevCent Function for sending all approved transaction details to your system.
Note: If you do not require that RevCent send all approved transactions to your system, you can skip the Receive Transactions section.
The user will import a function using an import JSON file. Download the function import file
1. Go to the functions page when logged into RevCent: https://revcent.com/user/functions
2. Click the Import Function button at top right.
3. In the import popup, click Select Import File.
4. Browse to the import file you provided the user.
5. In the import review popup, the user enters the endpoint in the endpoint_url field.
Utilize the RevCent V1 API to create a chargeback, retrieve evidence and modify a chargebacks' details. Below is a step by step guide on implementing chargeback management within RevCent. View the RevCent V1 API Docs section on chargebacks for detailed schema information and more.
If you are using the V2 API, please view the V2 API Docs section on chargebacks for detailed schema information and more.
The user should create a new Live API Account, specific to chargeback management, and provide the API key to you. Please do not have the user provide you their Admin/Root Live Key, have them create a new one.
Make sure the user has the following permissions enabled on the API account:
All requests to the RevCent V1 API should contain the “x-api-key” header, with the value being the API key specific to the RevCent user you are integrating.
curl --location --request POST 'https://api.revcent.com/v1' \
--header 'Content-Type: application/json' \
--header 'x-api-key: USER_REVCENT_LIVE_API_KEY' \
Easily create a chargeback in RevCent specific to a transaction. You can provide the gateway transaction ID or the RevCent transaction ID. API Docs Section
Example V1 API Request Body
{
"request": {
"type": "chargeback",
"method": "create",
"gateway_transaction_id": "60158956353",
"amount": 140.32,
"arn": "arn_1",
"chargeback_date": "2020-12-01",
"received_date": "2020-12-01",
"case_number": "1234",
"reason_code": "4",
"third_party_chargeback_id": "cb_1",
"third_party_order_id": "or_1",
"void_transaction": false,
"metadata": [
{
"name": "is_verifi", // Provide this name/value object if is Verifi.
"value": "true"
},
{
"name": "is_rdr", // Provide this name/value object if is RDR.
"value": "true"
},
{
"name": "is_ethoca", // Provide this name/value object if is Ethoca.
"value": "true"
}
]
}
}
Example V1 API Response Body
{
"amount": 21.39,
"api_call_id": "WmbX7n17zGTL65ZqPnp9",
"api_call_processed": true,
"api_call_unix": 1609122150,
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"chargeback_id": "j0a9dNwVKqu8Qz5Vl6ZZ", // Save for future chargeback updates, or use search method.
"code": 1,
"customer_id": "2rn1nnqKN6i6wmdKolJE",
"gateway": "Authorize.net",
"gateway_id": "LYE26MW8Rlh5VbJmlp2l",
"gateway_transaction_id": "60158956353",
"merchant_account_id": "5678",
"request_method": "create",
"request_type": "chargeback",
"result": "Chargeback created.",
"transaction_id": "gYZVZZbdmRTl7g2aJyNN",
"void_transaction": false
}
Retrieve a Document from the RevCent V1 API. The document will contain information specific to the transaction a chargeback is related to. Read more about the Documents feature in RevCent.
If you are using the V2 API, please view the V2 API Docs section on creating documents.
Example V1 API Request Body
{
"request": {
"type": "document",
"method": "retrieve",
"item_type": "transaction",
"id": "60158956353" // The gateway transaction ID related to the chargeback.
}
}
Example V1 API Response Body
{
"api_call_id": "nb9FakR8V1BK1G17rMkO",
"api_call_processed": true,
"api_call_region": "1",
"api_call_unix": 1694792104,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "document",
"results": [
{
"document_json": {
"api_call": {
"api_account": "4aG0HMJ1ZnMpy2r4MW5A",
"code": 1,
"id": "k6UGlB1mNLWEr9orPvR4",
"method": "create",
"request": {
"bill_to": {
"first_name": "George",
"last_name": "Washington",
"address_line_1": "1600 Pennsylvania Aveive",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "US",
"email": "georgew@whitehouse.com",
"phone": "1234567890"
},
"campaign": "B2Rd8raX8XEQk6S1z1P9",
"customer_id": "n8LOEjvgilkPd6bWVPXj",
"ip_address": "123.456.789.0",
"metadata": [],
"method": "create",
"payment_profile": "pY24LzukqKoJgVE6bM2J",
"product": [
{
"id": "P8y4YTnXAnLk1bJ6OgWw",
"quantity": 1
}
],
"ship_to": {
"first_name": "George",
"last_name": "Washington",
"address_line_1": "1600 Pennsylvania Aveive",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "US",
"email": "georgew@whitehouse.com",
"phone": "1234567890"
},
"shipping": [
{
"amount": 0,
"cost": 0,
"provider": "USPS",
"provider_method": "Ground",
"free_shipping": true
}
],
"type": "sale",
"unique_request_id": "777777"
},
"type": "sale"
},
"campaign": {
"id": "B2Rd8raX8XEQk6S1z1P9",
"name": "My Campaign"
},
"chargebacks": [],
"customer": {
"address_line_1": "1600 Pennsylvania Aveive",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "US",
"device_details": {
"region_timezone": "-04:00",
"os": "iOS",
"device_type": "phone",
"window_size": "0x0",
"screen_resolution": "414x896",
"browser": "APPLE_WEB_KIT",
"region_language": "en-US"
},
"email": "georgew@whitehouse.com",
"email_details": {
"email": "georgew@whitehouse.com",
"score": 1,
"deliverable": true,
"domain_details": { // SEON Specific
"domain": "whitehouse.com",
"tld": ".com",
"registered": true,
"registrar_name": "US Gov.",
"registered_to": "Whitehouse",
"disposable": false,
"free": true,
"custom": false,
"dmarc_enforced": true,
"spf_strict": true,
"valid_mx": true,
"accept_all": true,
"suspicious_tld": false,
"website_exists": true
},
"account_details": { // SEON Specific
"apple": {
"registered": true
},
"facebook": {
"registered": true,
"url": null,
"name": null,
"photo": null
},
"google": {
"registered": true,
"photo": null
},
"instagram": {
"registered": true
},
"linkedin": {
"registered": null,
"photo": null
},
"microsoft": {
"registered": true
},
"myspace": {
"registered": false
},
"pinterest": {
"registered": false
},
"skype": {
"registered": false
},
"spotify": {
"registered": false
},
"tumblr": {
"registered": false
},
"twitter": {
"registered": true
},
"yahoo": {
"registered": true
}
}
},
"enabled": false,
"first_name": "George",
"full_address": "1600 Pennsylvania Ave, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "n8LOEjvgilkPd6bWVPXj",
"internal_id": "",
"ip_details": {
"ip": "123.456.789.0",
"score": 3,
"country": "US",
"state_prov": "",
"city": "",
"timezone_offset": "-04:00",
"isp_name": "Acme ISP",
"latitude": 42.86563,
"longitude": -73.77095,
"type": "ISP",
"tor": false,
"vpn": false,
"web_proxy": false,
"public_proxy": false,
"spam_number": 3
},
"last_name": "Washington",
"lat": "42.123456",
"lon": "-73.123456",
"phone": "+11234567890",
"phone_details": { // SEON Specific
"number": 11234567890,
"valid": true,
"type": "MOBILE",
"country": "US",
"carrier": "VERIZON WIRELESS - DC",
"score": 0,
"account_details": {
"facebook": {
"registered": true
},
"google": {
"registered": false
},
"twitter": {
"registered": false
},
"instagram": {
"registered": true
},
"yahoo": {
"registered": null
},
"whatsapp": {
"registered": false,
"photo": null,
"last_seen": null
},
"telegram": {
"registered": false,
"photo": null,
"last_seen": null
},
"viber": {
"registered": null,
"photo": null,
"last_seen": null
}
}
},
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"fraud_detection_requests": [
{
"created_date": "2023-07-13T00:13:33+00:00",
"fraud_score": 4,
"id": "L1mrPvBnBo0hGlBNLWEn",
"is_error": false,
"is_fraud_detected": false,
"is_sentinel": false,
"is_third_party_integration": true,
"raw_response": "{}",
"score_threshold": 25,
"score_threshold_bound": "upper",
"third_party_fraud_detection_id": "123456",
"third_party_integration": {
"id": "b0aO8VWoAlvMQp9r6kdt",
"name": "SEON",
"third_party": {
"id": "0pJngyjNlyimGmYnM8Eb",
"name": "SEON"
}
}
},
{
"created_date": "2023-07-13T00:13:33+00:00",
"fraud_score": 0,
"id": "m7LJ7266pg8G9lfly8Y9",
"is_error": false,
"is_fraud_detected": false,
"is_sentinel": true,
"is_third_party_integration": false,
"raw_response": "",
"score_threshold": 0,
"score_threshold_bound": "upper",
"third_party_fraud_detection_id": "",
"third_party_integration": null
}
],
"iso_currency": "USD",
"metadata": [],
"payment_type": {
"id": "KnQ0KlNE6kf5mobyV0pN",
"name": "Credit Card"
},
"products": [
{
"id": "P8y4YTnXAnLk1bJ6OgWw",
"internal_id": "my_product_id",
"name": "My Product",
"price": 49.99,
"quantity": 1,
"sku": "my_product_sku",
"total_amount": 49.99
}
],
"sale": {
"amount": 49.99,
"created_date": "2023-07-13T00:13:32+00:00",
"id": "ypgXrBmYav8ULMAnaRWW",
"unique_request_id": "123456"
},
"shipping": [
{
"amount": 0,
"created_date": "2023-07-13T00:13:39+00:00",
"fulfillment_account": {
"id": "adJZ2629LbOEFpM27WdQ",
"name": "My Fulfillment",
"fulfillment_center": {
"id": "wLN45BQGRmh78OnKbVk0",
"name": "ShipStation"
}
},
"fulfillment_account_notified": true,
"fulfillment_account_notified_date": "2023-07-13T00:15:40+00:00",
"id": "hdr8525wljv8GALg9E0p",
"is_delivered": true,
"is_free": true,
"is_shipped": true,
"provider": "USPS",
"provider_delivered_date_unix": 1689596220,
"provider_method": "usps_other",
"provider_tracking": "9400100000000000000000",
"provider_tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9400100000000000000000",
"ship_date_unix": 1689206400,
"ship_to": {
"first_name": "George",
"last_name": "Washington",
"address_line_1": "1600 Pennsylvania Aveive",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "US",
"company": "",
"email": "georgew@whitehouse.com",
"phone": "1234567890"
},
"shipping_status": "Delivered"
}
],
"tracking_entries": [
{
"created_date": "2023-07-13T00:04:02+00:00",
"host": "www.mywebsite.com",
"hosted_page": null,
"id": "GaK0GZEAyJQ2mo9LzAsn",
"pathname": "/",
"tracking_domain": {
"name": "mywebsite.com",
"id": "rJZs4YbXMrvjKP6K0LJk",
"domain": "mywebsite.com"
}
}
],
"tracking_visitor": {
"created_date": "2023-07-13T00:04:02+00:00",
"fingerprint": "f0744494dbb96cca22baeee0262bed79",
"id": "m62V4R1rkw8KYJ5vPcKw",
"ip_address": "123.456.789.0",
"ip_details": {
"ip": "123.456.789.0",
"is_eu": false,
"city": "Washington",
"region": "DC",
"region_code": "DC",
"region_type": "state",
"country_name": "United States",
"country_code": "US",
"continent_name": "North America",
"continent_code": "NA",
"latitude": 12.0124124124124,
"longitude": -72.0124124124124,
"postal": null,
"calling_code": "1",
"asn": {
"asn": "AS123456",
"name": "Acme ISP",
"domain": "acme.com",
"route": "12.34.5.6/16",
"type": "business"
},
"company": {
"name": "Acme ISP",
"domain": "acme.com",
"network": "12.34.5.6/16",
"type": "business"
},
"languages": [
{
"name": "English",
"native": "English",
"code": "en"
}
],
"currency": {
"name": "US Dollar",
"code": "USD",
"symbol": "$",
"native": "$",
"plural": "US dollars"
},
"time_zone": {
"name": "America/New_York",
"abbr": "EDT",
"offset": "-0400",
"is_dst": true,
"current_time": "2023-07-13T00:04:02-04:00"
},
"threat": {
"is_tor": false,
"is_icloud_relay": false,
"is_proxy": false,
"is_datacenter": false,
"is_anonymous": false,
"is_known_attacker": false,
"is_known_abuser": false,
"is_threat": false,
"is_bogon": false,
"blocklists": []
}
},
"user_agent": "Mozilla/5.0"
},
"transactions": [
{
"amount": 49.99,
"approved": true,
"created_date": "2023-07-13T00:13:38+00:00",
"customer_card": {
"type": "Visa",
"id": "bOArW0JnjLkhY2z69K4A",
"first_6": "424242",
"last_4": "4242",
"expiry_date": "12/44",
"expiry_month": "12",
"expiry_year": "2044",
"bin_details": { // SEON Specific
"card_bin": "424242",
"bin_bank": "BANK N.A.",
"bin_card": "VISA",
"bin_type": "DEBIT",
"bin_level": "STANDARD",
"bin_country": "UNITED STATES",
"bin_country_code": "US",
"bin_website": "www.bank.com",
"bin_phone": "1-800-123-4567",
"bin_valid": true,
"card_issuer": "VISA"
}
},
"declined": false,
"error": false,
"gateway_auth_code": "",
"gateway_avs_result_code": "M",
"gateway_cavv_result_code": "",
"gateway_cvv_result_code": "M",
"gateway_id": "L0bZVn7Z8GPbHm068OzM",
"gateway_name": "My Gateway",
"gateway_result_phrase": "approved",
"gateway_transaction_id": "60158956353",
"held": false,
"id": "7NJrwLG0Q5mSb42vWPK5",
"merchant_account_id": "1234567",
"result": "Approved",
"result_code": 1
}
]
},
"expires_on": "2023-09-16T15:35:04+00:00",
"id": "mwPLLyf1rWW4a9Jn6Plo",
"zip_url": "https://userdocument.revcent.com/RANDOM_STRING.zip"
}
],
"total_count": 1,
"total_pages": 1
}
Update the chargeback using the V1 API indicating representment has begun (initiated). V1 API Docs Section
If you are using the V2 API, please view the V2 API Docs section on chargebacks.
Example V1 API Request Body
{
"request": {
"type": "chargeback",
"method": "edit",
"chargeback_id": "j0a9dNwVKqu8Qz5Vl6ZZ", // The RevCent chargeback ID.
"representment": {
"initiated": true, // Represent is initiated.
"initiated_date": "2023-05-19", // The date the representment was initiated.
}
}
}
Example API Response Body
{
"api_call_id": "mJLY1aqWOvCJBL4wAqV8",
"api_call_processed": true,
"api_call_unix": 1609122072,
"chargeback_id": "j0a9dNwVKqu8Qz5Vl6ZZ",
"code": 1,
"request_method": "edit",
"request_type": "chargeback",
"result": "Chargeback edited."
}
When representment has completed with an outcome, update the chargeback indicating the completed status, completed date and outcome (won or lost). API Docs Section
If you are using the V2 API, please view the V2 API Docs section on chargebacks.
Example V1 API Request Body
{
"request": {
"type": "chargeback",
"method": "edit",
"chargeback_id": "j0a9dNwVKqu8Qz5Vl6ZZ", // The RevCent chargeback ID.
"representment": {
"completed": true, // Represent is complete with an outcome.
"completed_date": "2023-05-25", // The date the representment was completed.
"outcome": "won" // Can be either "won" or "lost" and is required if "completed" is true.
}
}
}
Example V1 API Response Body
{
"api_call_id": "mJLY1aqWOvCJBL4wAqV8",
"api_call_processed": true,
"api_call_unix": 1609122072,
"chargeback_id": "j0a9dNwVKqu8Qz5Vl6ZZ",
"code": 1,
"request_method": "edit",
"request_type": "chargeback",
"result": "Chargeback edited."
}
If you need to find a transaction or update a chargeback and do not have the RevCent ID of either, you can use the RevCent V1 API to search for them using the gateway transaction ID. Below are examples of using the API to search for both a transaction and a chargeback using the gateway transaction ID. More info on the API search page.
All requests to the RevCent API should contain the “x-api-key” header, with the value being the API key specific to the RevCent user you are integrating. The user will need to provide their Live API Key to you. Make sure the user has the transaction:search and chargeback:search permissions enabled for the API account being used.
curl --location --request POST 'https://api.revcent.com/v1' \
--header 'Content-Type: application/json' \
--header 'x-api-key: USER_REVCENT_LIVE_API_KEY' \
This is an example of searching for a specific chargeback using the gateway transaction ID of the original transaction that was charged back. Use this method if you do not have the RevCent chargeback ID.
If you are using the V2 API, please view the V2 API Docs section on search.
Example V1 API Request Body
{
"request": {
"type": "chargeback",
"method": "search",
"search_term": "60158956353" // Searching using the gateway transaction ID.
}
}
Example V1 API Response Body
{
"api_call_id": "GOn6V1GKwjCVqERa4yRV",
"api_call_processed": true,
"api_call_unix": 1694534541,
"code": 1,
"request_method": "search",
"request_type": "chargeback",
"results": [
{
"item_type": "chargeback",
"id": "d9V7l8X24MtnG77WZGOb",
"created_date_unix": 1694272190,
"chargeback_date_unix": 1694232000,
"received_date_unix": 1694232000,
"transaction_date_unix": 1694200885,
"transaction_id": "l4O2gB6WKys8r7rVVEVo",
"amount": 27.27,
"reason_code": "",
"customer_id": "P6KdWOwrpVUJjPJpzn8j",
"first_name": "George",
"last_name": "Washington",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"email": "georgew@whitehouse.com",
"phone": "1234567890",
"arn": "",
"case_number": "",
"merchant_account_id": "845678",
"third_party_chargeback_id": "",
"third_party_order_id": "",
"gateway_transaction_id": "120003496326",
"card_id": "EMndvmYoENiNbKNp6Vdy",
"first_6": "492020",
"last_4": "9560",
"ip_address": "123.456.789.0",
"metadata": [],
"url": "https://revcent.com/user/chargeback-details/d9V7l8X24MtnG77WZGOb",
"highlights": [
{
"field": "gateway_transaction_id",
"values": [
"120003496326"
],
"score": 8.373147964477539
}
],
"score": 5.6036553382873535
}
]
}
This is an example of searching for a specific transaction using the gateway transaction ID. Use this method if you do not have the RevCent transaction ID.
If you are using the V2 API, please view the V2 API Docs section on search.
Example V1 API Request Body
{
"request": {
"type": "transaction",
"method": "search",
"search_term": "60158956353" // Searching using the gateway transaction ID.
}
}
Example V1 API Response Body
{
"api_call_id": "O0b8zbp6oyuArzOGmw6G",
"api_call_processed": true,
"api_call_unix": 1694534326,
"code": 1,
"request_method": "search",
"request_type": "transaction",
"results": [
{
"item_type": "transaction",
"id": "l4O2gB6WKys8r7rVVEVo",
"created_date_unix": 1694200885,
"amount": 27.27,
"customer_id": "P6KdWOwrpVUJjPJpzn8j",
"first_name": "George",
"last_name": "Washington",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"email": "georgew@whitehouse.com",
"phone": "1234567890",
"card_id": "EMndvmYoENiNbKNp6Vdy",
"first_6": "492020",
"last_4": "9560",
"gateway_transaction_id": "60158956353",
"request_type": "subscription",
"request_method": "renew",
"approved": true,
"metadata": [],
"url": "https://revcent.com/user/transaction-details/l4O2gB6WKys8r7rVVEVo",
"highlights": [
{
"field": "gateway_transaction_id",
"values": [
"120003496326"
],
"score": 8.373147964477539
}
],
"score": 7.935413837432861
}
]
}
You can also use other search terms to find a transaction or chargeback.
First and Last Name
{
"request": {
"type": "chargeback", // Searching chargebacks.
"method": "search",
"search_term": "George Washington" // Searching using the first and last name of the customer.
}
}
First 6 and Last 4
{
"request": {
"type": "transaction", // Searching transactions.
"method": "search",
"search_term": "492020 9560" // Searching using the first 6 and last 4 of the related credit card.
}
}
{
"request": {
"type": "transaction", // Searching transactions.
"method": "search",
"search_term": "georgew@whitehouse.com" // Searching using the customer email address.
}
}