RevCent API
The RevCent API is a REST based API. Current version is v1. All calls are performed via http POST, with a JSON body, and application/json as the content type. This allows a coding language agnostic method of calling the RevCent API without the need for an SDK. Simply call the API endpoint using your authorization credentials in the header.
All api calls must use the http POST method. Other http methods will be rejected. It is important to set the Content-Type in your POST header to "application/json".
Whitelist RevCent: All requests from RevCent will use the following IP address:
34.224.171.255
If you need help please do not hesitate to contact us.
API Endpoint
https://api.revcent.com/v1
Authentication
Each account has two API Keys, a live key and a test key. This allows you to test the API and view results using the test/live mode toggle in the user dashboard.
Depending on the key used, RevCent will use the appropriate merchant gateway endpoint for test/live transactions. For example, if you use a test RevCent key we will use the test endpoint for the merchant gateway. A live RevCent key will use the live merchant gateway endpoint.
The x-api-key should be in the header of the API request.
Example
"headers": {
"Content-Type": "application/json",
"x-api-key": "YOUR_REVCENT_API_KEY"
}
Request Body
Every request body is a JSON object, containing the request object. The request object contains both type and method properties. This determines the actions that the specific POST request is going to perform.
In the example, the type is 'sale' and the method is 'retrieve'. Depending on the type and method, certain properties are required. All schema examples in the docs specify required properties depending on request.
Example
{
"request": {
"type": "sale",
"method": "retrieve",
"id": "mJWJbKNQ4QI8XbwmyyW7"
}
}
Request Example
The example contains a request using CURL showing the POST method, content-type header, x-api-key header and JSON body.
Example
curl --location --request POST 'https://api.revcent.com/v1' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_REVCENT_API_KEY' \
--data-raw '{
"request": {
"type": "sale",
"method": "retrieve",
"id": "mJWJbKNQ4QI8XbwmyyW7"
}
}'
Campaign
A campaign is created within the RevCent web app and is a way to group, categorize and filter various items within your account.
Campaign Retrieve
Retrieve current information on a single campaign or multiple campaigns.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The unix timestamp of when the item was created.
The description of the item.
Whether the campaign is enabled.
The RevCent ID of the object item.
The name of the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "campaign",
"method": "retrieve",
"id": "JN0Zpj7RGJiwKqAnRoy6"
}
}Response JSON
{
"api_call_id": "Q45jJa6ZjgFYmK5Ek86l",
"api_call_processed": true,
"api_call_unix": 1570281688,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "campaign",
"results": [
{
"created_date_unix": 1550530876,
"description": "Twitter campaign sales and customers.",
"enabled": true,
"id": "JN0Zpj7RGJiwKqAnRoy6",
"name": "Twitter Campaign",
"updated_date_unix": 1551406538
}
],
"total_count": 1,
"total_pages": 1
}Chargeback
A chargeback within RevCent is created either using the API or via a third party integration for credit card transactions within RevCent.
Chargeback Create
Create a chargeback within RevCent via the chargeback create method. A chargeback is specific to an existing RevCent credit card transaction. Therefore, when creating a chargeback, the transaction_id or gateway_transaction_id for the related transaction must be provided.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent transaction ID for the chargeback related transaction. If not present, you must provide the gateway_transaction_id property.
The gateway transaction ID for the chargeback related transaction. Only provide if the transaction_id property is not present.
The chargeback amount.
The acquirer reference number.
The date the chargeback created by the issuing bank.
The date the chargeback was received.
The chargeback case number.
The chargeback reason code.
The RevCent third party integration ID.
The third party chargeback ID.
The third party order ID.
Response JSON Schema
The amount of the item.
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The RevCent ID of the chargeback.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
Gateway related to the item.
The RevCent ID of the gateway.
The transaction ID assigned by the merchant gateway.
The merchant account ID associated with the merchant gateway.
The API request method.
The API request type.
The a brief description of the result of the API call.
The RevCent ID of the credit card transaction.
Request JSON
{
"request": {
"type": "chargeback",
"method": "create",
"transaction_id": "EMO5Xo8qMEf15YXQywkR",
"gateway_transaction_id": "60157523306",
"amount": 140,
"arn": "arn_1",
"chargeback_date": "12/01/2020",
"received_date": "12/04/2020",
"case_number": "1234",
"reason_code": "4",
"third_party_chargeback_id": "cb_1",
"third_party_order_id": "or_1",
"metadata": [
{
"name": "chargeback",
"value": "12345"
}
]
}
}Response JSON
{
"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",
"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"
}Chargeback Edit
Edit an existing chargeback within RevCent via the chargeback edit method.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent chargeback ID.
The chargeback amount.
The acquirer reference number.
The date the chargeback created by the issuing bank.
The date the chargeback was received.
The chargeback case number.
The chargeback reason code.
The RevCent third party integration ID.
The third party chargeback ID.
The third party order ID.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the chargeback.
The result code for the request.
0 = RevCent Error
1 = Success
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "chargeback",
"method": "edit",
"chargeback_id": "0p9yLjoq91u9wVEqZ2M2",
"amount": 140,
"arn": "arn_1",
"chargeback_date": "10/01/2020",
"received_date": "10/04/2020",
"case_number": "1234",
"reason_code": "4",
"third_party_chargeback_id": "cb_1",
"third_party_order_id": "or_1"
}
}Response JSON
{
"api_call_id": "mJLY1aqWOvCJBL4wAqV8",
"api_call_processed": true,
"api_call_unix": 1609122072,
"chargeback_id": "Nk6llENAROsKvm8PLlOw",
"code": 1,
"request_method": "edit",
"request_type": "chargeback",
"result": "Chargeback edited."
}Chargeback Retrieve
Retrieve current information on a single chargeback or multiple chargebacks.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The amount of the transaction associated with the fraud detection.
The acquirer reference number, if applicable.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The case number, if applicable.
The date the chargeback occurred.
The unix timestamp of the date the chargeback occurred.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
An array containing fraud detection IDs related to the item.
Gateway related to the item.
The name of the item.
The RevCent ID of the object item.
The merchant account ID associated with the merchant gateway.
The transaction ID assigned by the merchant gateway.
The RevCent ID of the object item.
An array containing invoice IDs related to the item.
Whether the chargeback is associated with a RevCent third party integration.
ISO 4217 currency code.
Whether the item was created using a live or test RevCent API key.
The merchant account ID associated with the merchant gateway.
An array containing offline payment IDs related to the item.
The original API call that created the entity associated with the chargeback.
The RevCent ID of the original API call that created the entity associated with the chargeback.
The date of the API call.
The unix timestamp of the date of the API call.
The API call type.
The API call method.
The IP address that was used to make the API call.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
The chargeback reason code.
The date the chargeback was received by you or the third party.
The unix timestamp of the date the chargeback was received by you or the third party.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing tax IDs related to the item.
The third party chargeback ID.
If the chargeback was created by a third party integration, details will appear here.
The ID of your RevCent third party integration.
The name of your RevCent third party integration.
Details on the specific third party.
The RevCent ID for the third party.
The name of the third party.
The third party order ID.
The specific transaction the chargeback is related to.
The RevCent transaction ID.
The unix timestamp of the date the transaction was created.
The date the transaction was created.
The unix timestamp of the date the transaction was updated.
The date the transaction was updated.
The transaction amount.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
An array containing usage account invoice IDs related to the item.
An array containing usage account IDs related to the item.
An array containing usage item invoice IDs related to the item.
An array containing usage item IDs related to the item.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "chargeback",
"method": "retrieve",
"id": "O04ll4qkllTXqA5Xd79L"
}
}Response JSON
{
"api_call_id": "5rkZvym5BNIO6WQX9PJl",
"api_call_processed": true,
"api_call_unix": 1609120332,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "chargeback",
"results": [
{
"amount": 42.36,
"arn": "12345",
"campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
"campaign_name": "Twitter Campaign",
"case_number": "56789",
"chargeback_date": "2020-12-23T05:00:00+00:00",
"chargeback_date_unix": 1608699600,
"check_directs": [],
"created_date_unix": 1608738415,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [],
"fraud_detections": [],
"gateway": {
"name": "Authorize.net",
"id": "LYE26MW8Rlh5VbJmlp2l",
"merchant_account_id": "12345678"
},
"gateway_transaction_id": "60158776104",
"id": "O04ll4qkllTXqA5Xd79L",
"invoices": [],
"is_third_party_integration": false,
"iso_currency": "USD",
"live_mode": false,
"merchant_account_id": "12345678",
"metadata": [],
"offline_payments": [],
"origin_api_call": {
"id": "RJblXjvvEgsqjGQrBjoX",
"date": "2020-12-22T23:22:04+00:00",
"date_unix": 1608679324,
"type": "subscription",
"method": "renew",
"ip_address": "123.456.789.101"
},
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [],
"reason_code": "2",
"received_date": "2020-12-23T05:00:00+00:00",
"received_date_unix": 1608699600,
"sales": [
"y2wARbKL8PCPL46Xb7qA"
],
"salvage_transactions": [],
"shipping": [
"y2Wrl6kwZoUdBWJjABp0"
],
"status": "Created",
"subscription_renewals": [
"zGkXy5Qa0OH4qWAozq58"
],
"tax": [
"qZM1QVAqwRik6BJNq6vW"
],
"third_party_chargeback_id": "",
"third_party_integration": null,
"third_party_order_id": "",
"transaction": {
"id": "pgPbQlGpr8fWQ72NbQrB",
"created_date_unix": 1608679325,
"created_date": "2020-12-22T23:22:05+00:00",
"updated_date_unix": 1608859578,
"updated_date": "2020-12-25T01:26:18+00:00",
"amount": 42.36
},
"transactions": [
"pgPbQlGpr8fWQ72NbQrB"
],
"trials": [],
"updated_date_unix": 1608738415,
"usage_account_invoices": [],
"usage_accounts": [],
"usage_item_invoices": [],
"usage_items": []
}
],
"total_count": 1,
"total_pages": 1
}Coupon
A coupon is created within the RevCent web app and can be applied to initial sales, subsequent subscription renewals and future customer purchases based on settings. Create specific rules, expiration dates and discount types within the web app when creating a coupon.
Coupon Validate
Validate a coupon using the coupon code. A rejected coupon code will display an error explaining the reason for rejection, while an applicable coupon code will display the discount type and amount.
To get the actual discount amount for a new sale using a valid coupon, use the sale estimate API request.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The coupon code.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The coupon associated with the coupon code.
If coupon code submitted is invalid, this coupon property will equal null.
Check for null coupon property in response to validate coupon code.
The RevCent ID of the object item.
The coupon code.
Whether the coupon is enabled.
The coupon start date.
The coupon end date.
The coupon discount type, either percent or amount.
The coupon discount value relative to the discount type.
The total number of times the coupon was used in a successful sale.
The coupon profile associated with the coupon.
The RevCent ID of the object item.
Whether the coupon profile is enabled.
Whether there is a maximum use limit within the coupon profile associated with the coupon.
The API request method.
The API request type.
Whether the coupon code is valid. If invalid (coupon = null) the reason for the coupon code being invalid.
Request JSON
{
"request": {
"type": "coupon",
"method": "validate",
"coupon_code": "10percent"
}
}Response JSON
{
"api_call_id": "qZBoPgKB0lIOJG6LJZ4R",
"api_call_processed": true,
"api_call_unix": 1570459361,
"code": 1,
"coupon": {
"id": "VPmmrpbVl7cQ9JaXEanl",
"coupon_code": "10percent",
"enabled": true,
"start_date_unix": 1567559820,
"end_date_unix": 1580446800,
"discount_type": "percent",
"discount_value": 10,
"num_use": 66,
"coupon_profile": {
"id": "k6vvXQwwNycvJM7yMwzL",
"enabled": true,
"num_use_max": 0
}
},
"request_method": "validate",
"request_type": "coupon",
"result": "Valid"
}Customer
A customer is an individual that is created either by sale, signup, etc. Every customer is given a unique ID as well as the ability to add multiple credit cards.
Implement metadata when creating a sale or customer for enhanced analytics. Our TrackJS feature is extremely useful for tracking visitors and linking them to new customers. We highly recommend you implement metadata as well as TrackJS to know more about your customers.
Customer Create
Create a customer via the customer create method. Useful for signup or prospect purposes where a sale has yet to take place.
AdWords Integration
If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID. Read more about integrating AdWords with RevCent on our Knowledge Base .
Example
"metadata":[{"name": "adwords_click", "value": "ADWORDS_CLICK_ID_HERE"}]Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The customer object receives first priority as details if creating a new customer.
If the customer object is not present the bill_to and ship_to objects will be used in the respective order.
If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.
This does not apply if using a customer_id field in the request where applicable.
To use as the billing information. If not present the customer object will be used.
Your internal customer ID.
The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.
If you wish to add a payment method with the customer upon creation.
The credit card number. This value must be a valid credit card number as a string.
The credit card expiration month. Two digit integer, MM.
The credit card expiration year. Two digit integer, YY.
The credit card code as a string. Depending on the card type this can be different lengths.
If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The RevCent ID of the customer credit card used if a transaction occurred.
The result code for the request.
0 = RevCent Error
1 = Success
The email address of the related customer.
The first name of the related customer.
The RevCent ID of the customer.
The last name of the related customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer",
"method": "create",
"campaign": "Twitter Campaign",
"customer": {
"first_name": "udhi",
"last_name": "pguolnvc",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "ndjo@gmail.com",
"phone": "1234567890"
},
"bill_to": {
"first_name": "udhi",
"last_name": "pguolnvc",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "ndjo@gmail.com",
"phone": "1234567890"
},
"internal_customer_id": "cus_7791",
"payment": {
"credit_card": {
"card_number": "4242424242424242",
"exp_month": 12,
"exp_year": 20,
"card_code": "999"
}
},
"metadata": [
{
"name": "adwords_click",
"value": "Cjat0KwhCQjdTq..."
},
{
"name": "sign_up_page",
"value": "v1"
}
]
}
}Response JSON
{
"api_call_id": "Nk5voyYVvgTOJkEdGRyj",
"api_call_processed": true,
"api_call_unix": 1565814918,
"campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
"campaign_name": "Twitter Campaign",
"card_id": "YaVqjAZNqzCGvrrZgGqm",
"code": 1,
"customer_email": "ndjo@gmail.com",
"customer_first_name": "udhi",
"customer_id": "mJGAbQ0zAmU12rpngR1M",
"customer_last_name": "pguolnvc",
"request_method": "create",
"request_type": "customer",
"result": "Created new customer and added card."
}Customer Edit
Edit customer information.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The customer ID
The customer object receives first priority as details if creating a new customer.
If the customer object is not present the bill_to and ship_to objects will be used in the respective order.
If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.
This does not apply if using a customer_id field in the request where applicable.
Your internal customer ID.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer",
"method": "edit",
"customer_id": "mJGAbQ0zAmU12rpngR1M",
"customer": {
"first_name": "ywbw",
"last_name": "fbjdbefa",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "izlo@gmail.com",
"phone": "1234567890"
}
}
}Response JSON
{
"api_call_id": "P65Gn2z6WMs552lNYg6q",
"api_call_processed": true,
"api_call_unix": 1565814919,
"code": 1,
"customer_id": "mJGAbQ0zAmU12rpngR1M",
"request_method": "edit",
"request_type": "customer",
"result": "Customer information successfully edited."
}Customer Enable
Enabled a customer that was previously disabled.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The customer ID
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer",
"method": "enable",
"customer_id": "mJGAbQ0zAmU12rpngR1M"
}
}Response JSON
{
"api_call_id": "BvwOyAQgd8u226OMrOqY",
"api_call_processed": true,
"api_call_unix": 1565814920,
"code": 1,
"customer_id": "mJGAbQ0zAmU12rpngR1M",
"request_method": "enable",
"request_type": "customer",
"result": "Customer enabled."
}Customer Disable
Disable a customer, preventing future purchases.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The customer ID
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer",
"method": "disable",
"customer_id": "mJGAbQ0zAmU12rpngR1M"
}
}Response JSON
{
"api_call_id": "ZVEGoyPVA0fZJMPo8Kav",
"api_call_processed": true,
"api_call_unix": 1565814919,
"code": 1,
"customer_id": "mJGAbQ0zAmU12rpngR1M",
"request_method": "disable",
"request_type": "customer",
"result": "Customer disabled."
}Customer Add Card
Add a credit card to a customer, with the ability to set the card as default.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The customer ID
To use as the billing information. If not present the customer object will be used.
The payment object containing the credit card you wish to add.
The credit card number. This value must be a valid credit card number as a string.
The credit card expiration month. Two digit integer, MM.
The credit card expiration year. Two digit integer, YY.
The credit card code as a string. Depending on the card type this can be different lengths.
If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer",
"method": "add_card",
"customer_id": "mJGAbQ0zAmU12rpngR1M",
"bill_to": {
"first_name": "orhw",
"last_name": "selldjxk",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "utnl@gmail.com",
"phone": "1234567890"
},
"payment": {
"credit_card": {
"card_number": "4141414141414141",
"exp_month": 10,
"exp_year": 23,
"card_code": "123",
"set_as_default": true
}
}
}
}Response JSON
{
"api_call_id": "j0LNQJG1B7UggmXw950J",
"api_call_processed": true,
"api_call_unix": 1565814920,
"code": 1,
"customer_id": "mJGAbQ0zAmU12rpngR1M",
"request_method": "add_card",
"request_type": "customer",
"result": "Customer card added."
}Customer Retrieve
Retrieve current information on a single customer or multiple customers. You can use either the RevCent ID or email address for retrieving a single customer.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The request type.
The request method.
The RevCent ID of the customer. Required if multiple property equals false and email property not present.
The email address of the customer. Required if multiple property equals false and id property not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
Whether the customer was created without identifiable information.
An array containing api call IDs related to the item.
Whether the customer has been marked as blocked, preventing the customer from making purchases.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing chargeback IDs related to the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
An array of customer card objects, each being a customer card associated with the customer.
The unix timestamp of when the item was created.
The unix timestamp of when the item was updated.
The RevCent ID of the object item.
The credit card type, i.e. visa, mastercard, etc.
The last 4 digits of the customer credit card.
The credit card expiration date, formatted MM/YY.
The credit card expiration month, formatted MM.
The credit card expiration year, formatted YYYY.
Whether the credit card is the customers' default card.
An array of customer group objects, each being a customer group the customer is associated with.
The RevCent ID of the object item.
The name of the item.
An array of customer group objects, each being a customer group the customer is blocked from being associated with.
An array containing discounts related to the item.
Whether the customer is enabled and available to purchase and make payments.
An array containing fraud detection request IDs related to the item.
An array containing fraud detection IDs related to the item.
True if customer address was submitted and geocoding was successful, otherwise false.
Google place ID of customer if successfully geocoded
The RevCent ID of the object item.
The internal_id you provided when creating the item.
An array containing invoice IDs related to the item.
Geocode latitude of customer if successfully geocoded.
An array of RevCent license key ID's associated with the item.
Overall lifetime values for the customer.
The combined total of sale and subscription renewal value types.
The sum amount discounted for all sales and renewals.
The sum amount gross for all sales and renewals.
The sum amount net for all sales and renewals.
The sum amount refunded for all sales and renewals.
The sum amount remaining for all sales and renewals.
The sum amount to salvage for all sales and renewals.
The sum total volume for all sales and renewals.
The sale value type, specific to the customers' sales.
The sum amount discounted for all sales.
The sum amount gross for all sales.
The sum amount net for all sales.
The sum amount refunded for all sales.
The sum amount remaining for all sales.
The sum amount to salvage for all sales.
The sum total volume for all sales.
The total number of sales.
The average sale amount gross.
The subscription renewal value type, specific to the customers' subscription renewals.
The sum amount discounted for all subscription renewals.
The sum amount gross for all subscription renewals.
The sum amount net for all subscription renewals.
The sum amount refunded for all subscription renewals.
The sum amount remaining for all subscription renewals.
The sum amount to salvage for all subscription renewals.
The sum total volume for all subscription renewals.
The total number of subscription renewals regardless of status.
The average subscription renewal amount gross.
The total number of subscription renewals with a status of Overdue.
The fraud detection value type, specific to the customers' fraud detections.
The total amount of all fraud detections.
The total number of fraud detections.
The average fraud detection amount.
The chargeback value type, specific to the customers' chargebacks.
The total amount of all chargebacks.
The total number of chargebacks.
The average chargeback amount.
The pending refund value type, specific to the customers' pending refunds.
The total number of refunds issued to the customer.
The date of the last sale for the customer, if available.
The date of the last subscription renewal for the customer, if available.
Geocode longitude of customer if successfully geocoded.
An array containing offline payment IDs related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
An array containing quota account IDs related to the item.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "customer",
"method": "retrieve",
"id": "ajOAl24bBXc5nXwagAOg"
}
}Response JSON
{
"api_call_id": "X8681XdaPpfrmYgyaVAp",
"api_call_processed": true,
"api_call_unix": 1641919241,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "customer",
"results": [
{
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"anonymous": false,
"api_calls": [
"vEP9QdWngpUrNGW6llkv"
],
"blocked": false,
"campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
"campaign_name": "AdWords Campaign",
"chargebacks": [],
"check_directs": [],
"city": "Washington",
"company": "",
"country": "USA",
"created_date_unix": 1641564098,
"customer_card": [
{
"created_date_unix": 1641564098,
"updated_date_unix": 1641746186,
"id": "ALAGkvj0O7u5rdmVggQ7",
"type": "visa",
"last_4": "1111",
"expiry_date": "11/23",
"expiry_month": "11",
"expiry_year": "2023",
"is_default": true
}
],
"customer_group": [
{
"id": "2rRMqP5nojF6EgJqwQVL",
"name": "My Customer Group"
}
],
"customer_group_blocked": [],
"discounts": [],
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"fraud_detection_requests": [],
"fraud_detections": [],
"full_address": "1600 Pennsylvania Ave, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "O0O0LON20nTaNQ6gg6Lm",
"internal_id": "",
"invoices": [],
"last_name": "Doe",
"lat": "32.5614023",
"license_keys": [],
"lifetime_value": {
"all": {
"amount_discounted": 0,
"amount_gross": 363.55,
"amount_net": 355.55,
"amount_refunded": 0,
"amount_remaining": 23.75,
"amount_to_salvage": 23.75,
"amount_total": 387.3
},
"sale": {
"amount_discounted": 0,
"amount_gross": 363.55,
"amount_net": 355.55,
"amount_refunded": 0,
"amount_remaining": 23.75,
"amount_to_salvage": 23.75,
"amount_total": 387.3,
"num": 1,
"avg": 363.55
},
"subscription_renewal": {
"amount_discounted": 0,
"amount_gross": 0,
"amount_net": 0,
"amount_refunded": 0,
"amount_remaining": 0,
"amount_to_salvage": 0,
"amount_total": 0,
"num": 0,
"avg": 0,
"num_overdue": 0
},
"fraud_detection": {
"amount": 0,
"num": 0,
"avg": 0
},
"chargeback": {
"amount": 0,
"num": 0,
"avg": 0
},
"pending_refund": {
"num": 0
},
"last_sale_date": "2022-01-07T14:01:38.458Z",
"last_subscription_renewal_date": null
},
"lon": "-90.19291299999999",
"metadata": [
{
"name": "adwords_click",
"value": "Cjat0KwhCQjdTq..."
}
],
"notes": [
{
"created_date": "2022-01-10T14:35:21+00:00",
"created_date_unix": 1641825321,
"updated_date": "2022-01-10T14:35:21+00:00",
"updated_date_unix": 1641825321,
"id": "9r0NrKQ864FaOrmOYmQn",
"text": "Example customer note.",
"username": "JohnDoe",
"first_name": "John",
"last_name": "Doe",
"employee_id": "mWwZ8KyrOLNOOdbbdUbQ",
"customer_note_related_type": "customer",
"customer_note_related_id": "O0O0LON20nTaNQ6gg6Lm"
}
],
"offline_payments": [],
"paypal_transactions": [],
"pending_refunds": [],
"phone": "12345678901",
"product_sales": [
"LYG04QV82NHqzpQvLL8m"
],
"quota_accounts": [],
"sales": [
"6rYKpkEgmyfBaGONMMVm"
],
"salvage_transactions": [
"8rkZpLd09Rf2wzVO77W5"
],
"shipping": [
"l4jWlR78X5cAvvvbnlWJ"
],
"smtp_messages": [],
"state": "DC",
"state_long": "DC",
"status": "Enabled",
"subscription_renewals": [],
"subscriptions": [
"5rnXp2wYjRf9OzWdgg8M"
],
"tax": [
"rmYb7ro28XTvmmmVE2RA"
],
"transactions": [
"ZVJZkL6Kn4Cb555PnKP9"
],
"trials": [
"JNvWwanZLBi8RN1ynnQR"
],
"updated_date_unix": 1641825321,
"zip": "20500"
}
],
"total_count": 1,
"total_pages": 1
}Customer Card
A customer card is specific to a customer, and is either created automatically during an initial sale, or manually added to a customer via web app or API.
Customer Card Add
To add a customer card, use the customer > add_card API method instead. This ensures a new card is assigned to the correct customer.
If the customer does not already exist, use the customer > create API method and include the credit card details in the request.
Customer Card Enable
Enable a customer card that was previously disabled.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent customer card ID.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer_card",
"method": "enable",
"customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
}
}Response JSON
{
"api_call_id": "9r0rPLQOPATL4zXVVXrZ",
"api_call_processed": true,
"api_call_unix": 1641910649,
"code": 1,
"customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
"customer_id": "2rBrjB5arLtoVnPKKPMw",
"request_method": "enable",
"request_type": "customer_card",
"result": "Customer card set to enabled."
}Customer Card Disable
Disable a customer card, preventing its use.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent customer card ID.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer_card",
"method": "disable",
"customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
}
}Response JSON
{
"api_call_id": "LYGYa9Nv7kCzL4RPPRoa",
"api_call_processed": true,
"api_call_unix": 1641910714,
"code": 1,
"customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
"customer_id": "2rBrjB5arLtoVnPKKPMw",
"request_method": "disable",
"request_type": "customer_card",
"result": "Customer card set to disabled."
}Customer Card Delete
Delete a customer card, removing it from the system. This is irreversible.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent customer card ID.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer_card",
"method": "delete",
"customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
}
}Response JSON
{
"api_call_id": "ll2nVEywp2M8Mbr2vXnf",
"api_call_processed": true,
"api_call_unix": 1641910772,
"code": 1,
"customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
"customer_id": "2rBrjB5arLtoVnPKKPMw",
"request_method": "delete",
"request_type": "customer_card",
"result": "Customer card deleted."
}Customer Card Set Default
Set a customer card as the default card for the customer.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent customer card ID.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "customer_card",
"method": "set_default",
"customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
}
}Response JSON
{
"api_call_id": "EM8Mbr2vXnfywp2ll2nV",
"api_call_processed": true,
"api_call_unix": 1641910772,
"code": 1,
"customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
"customer_id": "2rBrjB5arLtoVnPKKPMw",
"request_method": "set_default",
"request_type": "customer_card",
"result": "Customer card set as default."
}Customer Card Retrieve
Retrieve current information on a single customer card or multiple customer cards. To view all cards for a specific customer, simply use the customer > retrieve method, using the customer ID, which will contain the customers' cards in the response.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
Whether the item is enabled or disabled.
The expiration date of the customer card formatted M/YYYY.
The expiration date of the customer card formatted MM/YYYY.
The expiration date of the customer card formatted MM.
The expiration year of the customer card formatted YYYY.
The first 6 digits of the customer card number.
The RevCent ID of the object item.
Whether the card is the customers' default card.
The last 4 digits of the customer card number.
Whether the item was created using a live or test RevCent API key.
The credit card type. I.e. visa, mastercard, etc.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "customer_card",
"method": "retrieve",
"id": "O0O0LON20nTaNQ6gg6Lm"
}
}Response JSON
{
"api_call_id": "Wm0m9Y2K5YuXrgdvmMAL",
"api_call_processed": true,
"api_call_unix": 1641910867,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "customer_card",
"results": [
{
"created_date_unix": 1641910298,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"enabled": false,
"expiry_date": "11/2023",
"expiry_month": "11",
"expiry_year": "2023",
"first_6": "424242",
"id": "O0O0LON20nTaNQ6gg6Lm",
"is_default": true,
"last_4": "4242",
"live_mode": false,
"type": "visa",
"updated_date_unix": 1641910714
}
],
"total_count": 1,
"total_pages": 1
}Discount
A discount is created when RevCent receives a static discount entry or a coupon code during a request.
Discount Retrieve
Retrieve current information on a single discount or multiple discounts.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
An array containing check direct IDs related to the item.
The details of any coupon related to the discount.
The RevCent ID of the object item.
The name of the item.
The description of the item.
The coupon code.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
The description of the item.
The total discount amount applied.
The percentage of total request amount before discount is applied.
The discount type corresponds to discount amount. Default is amount.
The RevCent ID of the object item.
The name of the item.
An array containing offline payment IDs related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
Will contain details if the root item is related to a third party shop.
The RevCent ID of the object item.
The name of the item.
The URL of the third party shop.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "discount",
"method": "retrieve",
"id": "5r1wN8EbAgsPvLlbMava"
}
}Response JSON
{
"api_call_id": "ZVE5YRjd7RsXZpVw4krG",
"api_call_processed": true,
"api_call_unix": 1566160507,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "discount",
"results": [
{
"check_directs": [],
"coupon": {
"id": "VPmmrpbVl7cQ9JaXEanl",
"name": "test2",
"description": "",
"coupon_code": "10percent"
},
"created_date_unix": 1565965034,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"description": "$5 Off Coupon from facebook link.",
"discount_amount": 5,
"discount_percent": 4.17,
"discount_type": "amount",
"id": "5r1wN8EbAgsPvLlbMava",
"name": "$5 Off Coupon",
"notes": [],
"offline_payments": [],
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [],
"sales": [
"Kn5aKb8lQZfXMl0NGjRZ"
],
"salvage_transactions": [],
"shipping": [],
"smtp_messages": [],
"subscription_renewals": [],
"subscriptions": [],
"tax": [],
"third_party_shop": {
"id": "Q48aAbVv21fJRvNKWrvP",
"name": "My Shop"
},
"transactions": [],
"trials": [],
"updated_date_unix": 1565965035
}
],
"total_count": 1,
"total_pages": 1
}Fraud
RevCent fraud detections and requests, using manual or third party integrations.
Fraud Detection
A fraud detection within RevCent is created either using the API, or via a third party integration, for credit card, PayPal, checks or offline payments.
Fraud Detection Create
Create a fraud detection within RevCent via the fraud detection create method.
Important: A fraud detection must have an originating RevCent API call, which RevCent will find when you provide a value for source_id. The value for the source_id property can be from one of the items listed below.
- API Call ID
- The RevCent ID for the originating API call.
- Transaction ID
- The RevCent ID for a credit card transaction.
- Gateway Transaction ID
- The payment gateways' ID for a credit card transaction.
- PayPal Transaction ID
- The RevCent ID or PayPal ID for a PayPal transaction.
- Check ID
- The RevCent ID for a check payment.
- Offline Payment ID
- The RevCent ID for an offline payment.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The source ID. Read the important information above.
The acquirer reference number.
The date of the fraud event.
The date the fraud was detected.
The case number.
The RevCent third party integration ID.
The third party fraud detection ID.
The third party order ID.
Response JSON Schema
The amount of the item.
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The RevCent ID of the fraud detection.
The RevCent ID of the original API call that created the entity associated with the fraud.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "fraud_detection",
"method": "create",
"source_id": "2rnYMVFGraRJBnPpgvQV",
"arn": "93994",
"event_date": "12/01/2020",
"fraud_detection_date": "12/11/2020",
"case_number": "4999",
"third_party_integration_id": "8r4lFWLbEr1PZglb7d8z",
"third_party_fraud_detection_id": "123456",
"third_party_order_id": "00001",
"metadata": [
{
"name": "fraud",
"value": "12345"
}
]
}
}Response JSON
{
"amount": 21.61,
"api_call_id": "y2WG1ApMMKhW6ZoBb72o",
"api_call_processed": true,
"api_call_unix": 1609086154,
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"code": 1,
"customer_id": "9rZ68zWWglFY8O26azRX",
"fraud_detection_id": "VPwOydX2ArHJy8gX2o98",
"origin_api_call_id": "O04EbzqqdltXb7EOGQpz",
"request_method": "create",
"request_type": "fraud_detection",
"result": "Fraud detection created."
}Fraud Detection Edit
Edit an existing fraud detection within RevCent via the fraud detection edit method.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent ID of the fraud detection.
The amount of the related transaction associated with the fraud detection.
The acquirer reference number, if applicable.
The date of the fraud event.
The date the fraud was detected.
The case number, if applicable.
Whether the fraud detection is incorrect. I.e. The related payment is not actually fraud.
The RevCent third party integration ID.
The third party fraud detection ID.
The third party order ID.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the fraud detection.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "fraud_detection",
"method": "edit",
"fraud_detection_id": "LYklEVoPJLfq65rR290A",
"amount": 140,
"arn": "93995",
"event_date": "12/29/2020",
"fraud_detection_date": "12/30/2020",
"case_number": "5000",
"false_positive": true,
"third_party_integration_id": "8r4lFWLbEr1PZglb7d8z",
"third_party_fraud_detection_id": "7890",
"third_party_order_id": "00002"
}
}Response JSON
{
"api_call_id": "qZM6vXNEVasgj0XVJO50",
"api_call_processed": true,
"api_call_unix": 1609118598,
"code": 1,
"fraud_detection_id": "LYklEVoPJLfq65rR290A",
"request_method": "edit",
"request_type": "fraud_detection",
"result": "Fraud detection edited."
}Fraud Detection Retrieve
Retrieve current information on a single fraud detection or multiple fraud detections.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The amount of the transaction associated with the fraud detection.
The acquirer reference number, if applicable.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The case number, if applicable.
An array containing chargeback IDs related to the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
The date of the fraud event.
The unix timestamp of the date of the fraud event.
Whether the fraud detection is incorrect. I.e. The related payment is not actually fraud.
The date the fraud was detected.
The unix timestamp of the date the fraud was detected.
An array containing fraud detection request IDs related to the item.
The RevCent ID of the object item.
An array containing invoice IDs related to the item.
Whether the fraud detection is associated with a RevCent third party integration.
ISO 4217 currency code.
Whether the item was created using a live or test RevCent API key.
An array containing offline payment IDs related to the item.
The original API call that created the entity associated with the fraud detection.
The RevCent ID of the original API call that created the entity associated with the fraud.
The date of the API call.
The unix timestamp of the date of the API call.
The API call type.
The API call method.
The IP address that was used to make the API call.
The payment type related to the item.
The system ID of the payment type related to the item.
The system name of the payment type related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
The RevCent hosted shopping cart that item originated from.
The RevCent ID of the sale.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
The third party fraud detection ID.
If the fraud detection was created by a third party integration, details will appear here.
The ID of your RevCent third party integration.
The name of your RevCent third party integration.
Details on the specific third party.
The RevCent ID for the third party.
The name of the third party.
The third party order ID.
The third party shop related to the item.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
An array containing usage account invoice IDs related to the item.
An array containing usage account IDs related to the item.
An array containing usage item invoice IDs related to the item.
An array containing usage item IDs related to the item.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "fraud_detection",
"method": "retrieve",
"id": "d9bmzA9lr8tYJAyLkBZO"
}
}Response JSON
{
"api_call_id": "BvGBOZ2k14cXbZ1AvE17",
"api_call_processed": true,
"api_call_unix": 1609092655,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "fraud_detection",
"results": [
{
"amount": 21.61,
"arn": "arn234",
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"case_number": "fraud123",
"chargebacks": [],
"check_directs": [],
"created_date_unix": 1609086154,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"details_response": "{}",
"discounts": [],
"event_date": "2020-12-01T00:00:00+00:00",
"event_date_unix": 1606780800,
"false_positive": false,
"fraud_detection_date": "2020-12-11T00:00:00+00:00",
"fraud_detection_date_unix": 1607644800,
"fraud_detection_requests": [],
"id": "VPwOydX2ArHJy8gX2o98",
"invoices": [],
"is_third_party_integration": true,
"iso_currency": "USD",
"license_keys": [],
"live_mode": false,
"metadata": [
{
"name": "fraud",
"value": "12345",
"entry_date": "2020-12-27"
}
],
"notes": [],
"offline_payments": [],
"origin_api_call": {
"id": "O04EbzqqdltXb7EOGQpz",
"date": "2020-12-27T16:20:24+00:00",
"date_unix": 1609086024,
"type": "sale",
"method": "create",
"ip_address": "123.456.789.101"
},
"payment_type": {
"id": "KnQ0KlNE6kf5mobyV0pN",
"name": "Credit Card"
},
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [
"zGkMgj2aKPhWBbNqdGjG"
],
"quota_accounts": [],
"revcent_shop": null,
"sale_id": "BvGqjz00dlT2jEk65OnW",
"sales": [
"BvGqjz00dlT2jEk65OnW"
],
"salvage_transactions": [],
"shipping": [
"d9bgVWPpEvFwBW29R8jP"
],
"smtp_messages": [],
"status": "Created",
"subscription_renewals": [],
"subscriptions": [],
"tax": [
"pgPZnmRpYkf710aQ8jRA"
],
"third_party_fraud_detection_id": "third_party_id123",
"third_party_integration": {
"id": "8r4Er1PZglFWLblb7d8z",
"name": "Midigator Prevention",
"third_party": {
"id": "zGkz8XvX9yT48q6LRqjW",
"name": "Midigator Prevention"
}
},
"third_party_order_id": "third_party_order_id4342",
"third_party_shop": null,
"transactions": [
"2rnPpgvYMVFGraRJBnQV"
],
"trials": [],
"updated_date_unix": 1609086154,
"usage_account_invoices": [],
"usage_accounts": [],
"usage_item_entries": [],
"usage_item_invoices": [],
"usage_items": []
}
],
"total_count": 1,
"total_pages": 1
}Fraud Detection Request
A fraud detection request within RevCent is created when RevCent contacts a third party integration and requests information on a payment before the payment is processed.
Fraud Detection Request Retrieve
Retrieve current information on a single fraud detection request or multiple fraud detection requests.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing chargeback IDs related to the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
An array containing fraud detection IDs related to the item.
The RevCent ID of the object item.
The third party integration mode, i.e. live or test.
An array containing invoice IDs related to the item.
Whether the request resulted in an error.
Whether the fraud detection request resulted in a fraud detection.
When the fraud detection request allowed the source payment to be processed.
Whether the request was sent to a third party integration.
ISO 4217 currency code.
An array of RevCent license key ID's associated with the item.
Whether the item was created using a live or test RevCent API key.
An array containing offline payment IDs related to the item.
The payment type related to the item.
The system ID of the payment type related to the item.
The system name of the payment type related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
An array containing quota account IDs related to the item.
The raw response returned from the third party when originally contacted.
The RevCent hosted shopping cart that item originated from.
The RevCent ID of the sale.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
The third party ID for the request.
Third party integration.
The ID of your RevCent third party integration.
The name of your RevCent third party integration.
Details on the specific third party.
The RevCent ID for the third party.
The name of the third party.
The third party shop related to the item.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
An array containing usage account invoice IDs related to the item.
An array containing usage account IDs related to the item.
An array containing usage item entry IDs related to the item.
An array containing usage item invoice IDs related to the item.
An array containing usage item IDs related to the item.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "fraud_detection_request",
"method": "retrieve",
"id": "RJ8a2blwBlFbbwPppNZA"
}
}Response JSON
{
"api_call_id": "j08r887w1ahVE88gl0z5",
"api_call_processed": true,
"api_call_unix": 1611257424,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "fraud_detection_request",
"results": [
{
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"chargebacks": [],
"check_directs": [],
"created_date_unix": 1611181895,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [],
"fraud_detections": [],
"id": "RJ8a2blwBlFbbwPppNZA",
"integration_mode": "Test",
"invoices": [],
"is_error": false,
"is_fraud_detected": false,
"is_payment_allowed": true,
"is_third_party_integration": true,
"iso_currency": "USD",
"license_keys": [],
"live_mode": false,
"metadata": [
{
"name": "kount_session_id",
"value": "c8ed4debf8f242be972c1071731052e8",
"entry_date": "2021-01-20"
}
],
"notes": [],
"offline_payments": [],
"payment_type": {
"id": "KnQ0KlNE6kf5mobyV0pN",
"name": "Credit Card"
},
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [
"Wmv2Bb1nOdu55kl22JKV"
],
"quota_accounts": [],
"raw_response": "",
"revcent_shop": null,
"sale_id": "Nk4OV6Wdm5INNEPXXVr7",
"sales": [
"Nk4OV6Wdm5INNEPXXVr7"
],
"salvage_transactions": [],
"shipping": [
"0pKAO9JoNYFrrNall7Xp"
],
"smtp_messages": [],
"status": "Success",
"subscription_renewals": [],
"subscriptions": [],
"tax": [
"k6a8rV2nw9FLLO9GGXvy"
],
"third_party_fraud_detection_id": "DWKW0YW258ZM",
"third_party_integration": {
"id": "ajYRoLokyXf62qy06JpZ",
"name": "Kount Risk Inquiry",
"third_party": {
"id": "mJEZdyVavzUL0gGoLR1Z",
"name": "Kount"
}
},
"third_party_shop": null,
"transactions": [
"zGWVMkz0m0h22EMLL61r"
],
"trials": [],
"updated_date_unix": 1611181898,
"usage_account_invoices": [],
"usage_accounts": [],
"usage_item_entries": [],
"usage_item_invoices": [],
"usage_items": []
}
],
"total_count": 1,
"total_pages": 1
}Invoice
An Invoice is a pending sale with an option to pay online. The only difference between an invoice and a vanilla pending sale is the Hosted Page integration, allowing the customer to pay the amount due online at via a customizable web page.
Invoice Create
Create an invoice via the invoice create method. All fields that are available in a regular Sale Create API call, with the exception of the payment object, are also available i.e. discounts, shipping, etc.
AdWords Integration
If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID. Read more about integrating AdWords with RevCent on our Knowledge Base .
Example
"metadata":[{"name": "adwords_click", "value": "ADWORDS_CLICK_ID_HERE"}]Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The invoice type. Always set to "sale_create".
The invoice profile ID to associate with the invoice being created. This determines the hosted page markup and URL.
The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.
ISO 4217 currency code. If not provided default is 'USD'.
The product array contains individual product objects.
Pricing is automatically calculated based upon the quantity, price or both if present.
The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.
The price, if different from the product default price, you wish to charge.
The quantity. Default is 1.
Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.
Create a trial for the specific product being sold ending after the number of days provided.
The customer object receives first priority as details if creating a new customer.
If the customer object is not present the bill_to and ship_to objects will be used in the respective order.
If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.
This does not apply if using a customer_id field in the request where applicable.
Response JSON Schema
The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The result code for the request.
0 = RevCent Error
1 = Success
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
The RevCent ID of the customer.
The Hosted Page URL for online payment.
The newly created invoice ID.
The RevCent ID of the object item.
The name of the item.
ISO 4217 currency code.
The metadata array containing name:value objects.
The name property for the metadata object.
The value property for the metadata object.
The API request method.
The API request type.
The a brief description of the result of the API call.
The sale ID for the invoice.
The current status of the related item.
Request JSON
{
"request": {
"type": "invoice",
"method": "create",
"invoice_type": "sale_create",
"invoice_profile": "gYo0YVd24Qf7QvdBYM2O",
"iso_currency": "USD",
"product": [
{
"id": "av_2017",
"price": 19.99,
"quantity": 2
}
],
"campaign": "Adwords Campaign",
"customer": {
"first_name": "vqjh",
"last_name": "slszhjru",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "ctnb@gmail.com",
"phone": "1234567890"
},
"metadata": [
{
"name": "invoice_create",
"value": "test"
}
]
}
}Response JSON
{
"amount_total": 176.79,
"api_call": {
"id": "ZVRV87lEoLuKWJY5gg8z"
},
"api_call_id": "ZVRV87lEoLuKWJY5gg8z",
"api_call_processed": true,
"api_call_unix": 1602980700,
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"code": 1,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"customer_id": "8rQrl21wjYcvJkzLaad8",
"hosted_url": "https://securehost.revcent.com/MyCompanyName/invoice?invoice_id=ajqjGdVO9Bi1Ly2nkkW7",
"invoice_id": "ajqjGdVO9Bi1Ly2nkkW7",
"invoice_profile": {
"id": "gYo0YVd24Qf7QvdBYM2O",
"name": "tqawqtq"
},
"iso_currency": "USD",
"metadata": [
{
"entry_date": "2020-10-18",
"name": "invoice_create",
"value": "test"
}
],
"request_method": "create",
"request_type": "invoice",
"result": "Invoice created.",
"sale_id": "mJqJ6mnGbrUwmG0q22V9",
"status": "Unpaid"
}Invoice Retrieve
Retrieve current information on a single invoice or multiple invoices.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The total calculated amount when an item is created.
The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
The RevCent ID of the object item.
The RevCent ID of the object item.
The name of the item.
ISO 4217 currency code.
An array of RevCent license key ID's associated with the item.
An array containing offline payment IDs related to the item.
The payment type related to the item.
The system ID of the payment type related to the item.
The system name of the payment type related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
An array containing quota account IDs related to the item.
The RevCent hosted shopping cart that item originated from.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
An array containing usage account invoice IDs related to the item.
An array containing usage account IDs related to the item.
An array containing usage item invoice IDs related to the item.
An array containing usage item IDs related to the item.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "invoice",
"method": "retrieve",
"id": "bOqOV2gJ6nca1aKq1Ezb"
}
}Response JSON
{
"api_call_id": "d959LvNN6ytzWzGvW5J6",
"api_call_processed": true,
"api_call_unix": 1602978780,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "invoice",
"results": [
{
"amount_original_total": 176.79,
"amount_total": 176.79,
"campaign_id": "X849YQm7BEf0ZQd7Ol1K",
"campaign_name": "Facebook Campaign",
"check_directs": [],
"created_date_unix": 1602978433,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"date_paid": null,
"discounts": [],
"download_url": "",
"hosted_url": "https://securehost.revcent.com/MyCompanyName/invoice?invoice_id=bOqOV2gJ6nca1aKq1Ezb",
"id": "bOqOV2gJ6nca1aKq1Ezb",
"invoice_profile": {
"id": "gYo0YVd24Qf7QvdBYM2O",
"name": "tqawqtq"
},
"is_sale": true,
"is_subscription_renewal": false,
"iso_currency": "USD",
"license_keys": [],
"metadata": [
{
"entry_date": "2020-10-17",
"name": "invoice_create",
"value": "test"
}
],
"notes": [],
"offline_payments": [],
"paid": false,
"payment_type": null,
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [],
"quota_accounts": [],
"revcent_shop": null,
"sales": [
"4ryrgOZkvAtKNK9wNv8l"
],
"salvage_transactions": [],
"shipping": [],
"smtp_messages": [],
"status": "Unpaid",
"subscription_renewals": [],
"subscriptions": [],
"tax": [],
"transactions": [],
"trials": [],
"updated_date_unix": 1602978433,
"usage_account_invoices": [],
"usage_accounts": [],
"usage_item_invoices": [],
"usage_items": [],
"void": false
}
],
"total_count": 1,
"total_pages": 1
}License Key
A license key is created via web app import, remote request or auto generated by RevCent. A license key is issued when a product is purchased that has an attached license key profile. We highly recommend you read more about license key management at our Knowledge Base
License Key Retrieve
Retrieve current information on a single license key or multiple license keys.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent ID of the license key OR the license key value. Required if multiple property equals false or is not present.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
Whether the license key is currently enabled.
The date the license key was expired. Only for keys with a license key profile with expired settings.
The date as a unix timestamp the license key was expired. Only for keys with a license key profile with expired settings.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
An array containing invoice IDs related to the item.
Whether the license key is expired after being issued.
Whether the license key has been issued as a result of a successful purchase.
The date the license key was issued as a result of a successful purchase.
The date as a unix timestamp the license key was issued as a result of a successful purchase.
The license key profile related to the license key.
The RevCent ID of the object item.
The name of the item.
The source of the license key. Remote, imported or RevCent generated.
An array containing offline payment IDs related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
The RevCent ID of the object item.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
The third party shop related to the item.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
An array containing usage account invoice IDs related to the item.
An array containing usage account IDs related to the item.
An array containing usage item invoice IDs related to the item.
An array containing usage item IDs related to the item.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "license_key",
"method": "retrieve",
"id": "0pZwRNgwKwIXvMKKBbpZ"
}
}Response JSON
{
"api_call_id": "KngPNGlrqvikawbWlGXr",
"api_call_processed": true,
"api_call_unix": 1592237703,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "license_key",
"results": [
{
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"check_directs": [],
"created_date_unix": 1591892064,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [
"LYg5NmwXlYhJoyll4wgZ"
],
"enabled": true,
"expired_date": null,
"expired_date_unix": null,
"id": "0pZwRNgwKwIXvMKKBbpZ",
"internal_id": "",
"invoices": [],
"is_expired": false,
"is_issued": true,
"issued_date": "2020-06-11T16:14:30+00:00",
"issued_date_unix": 1591892070,
"license_key_profile": {
"id": "0pZwpLpPw4UrdOkQpqyv",
"name": "Imported Keys Only"
},
"license_key_source": "imported",
"notes": [],
"offline_payments": [],
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [
"P6g5kEaEzjt6VyllpEGL"
],
"sale": {
"id": "qZEBboR8W0hOPpVV02rZ"
},
"sales": [
"qZEBboR8W0hOPpVV02rZ"
],
"salvage_transactions": [],
"shipping": [],
"smtp_messages": [],
"status": "Enabled",
"subscription_renewals": [],
"subscriptions": [],
"tax": [
"ZV7EmNBNP5TA7122OyKX"
],
"third_party_shop": null,
"transactions": [
"EMgw2p6q5MfEnm55pPag"
],
"trials": [],
"updated_date_unix": 1591892070,
"usage_account_invoices": [],
"usage_accounts": [],
"usage_item_invoices": [],
"usage_items": []
}
],
"total_count": 1,
"total_pages": 1
}Note
You can create a note for an entity within RevCent that will simultaneously attach the note to the customer related to the entity. This allows you to view all notes for a customer and related entities.
Note Create
Create a note for a specific entity such as a customer, sale, shipping, etc. Indicate the entity using the item_type and item_id properties, the item_type being either sale, customer, shipping, etc., and item_id being the RevCent ID for the item. For example, if you want to leave a note for a sale, set item_type = "sale" and item_id="REVCENT_SALE_ID".
Accepted Item Types
- customer
- A customer within RevCent.
- sale
- A sale within RevCent.
- product_sale
- A product sale within RevCent.
- shipping
- A shipping within RevCent.
- subscription
- A subscription within RevCent.
- subscription_renewal
- A subscription renewal within RevCent.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The item type the note is to be created for. Example: sale, customer, shipping, etc.
The RevCent ID for the item the note is to be created for. If item_type = sale, then the RevCent sale ID.
The note text.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID for the item the note was created for.
The item type the note was created for.
The RevCent ID for the note created.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "note",
"method": "create",
"item_type": "sale",
"item_id": "pgm1q7yjKjF7qyAM7EXK",
"text": "Making a note for a sale with RevCent ID pgm1q7yjKjF7qyAM7EXK."
}
}Response JSON
{
"api_call_id": "WmEZRkNmKRhmWBrkNP9B",
"api_call_processed": true,
"api_call_unix": 1638047347,
"code": 1,
"item_id": "pgm1q7yjKjF7qyAM7EXK",
"item_type": "sale",
"note_id": "4rAmyMargyuMaXrkQLyK",
"request_method": "create",
"request_type": "note",
"result": "Note created."
}Payments
RevCent supports multiple payment types including check, credit card, offline and PayPal. Depending on the payment type, different methods are supported.
Additional payment types will be added in the future including Amazon Pay, Apply Pay and Google Pay.
Check Direct
A check direct is considered a physical check, not ACH or electronic check. The physicality is what separates a check direct from electronic forms of check payments, along with the accounts receivable and mailing aspects. ACH and electronic check methods will be supported in the near future as a separate entity.
Check Direct Refund
To refund a check direct you instead refund the entity that the refund is associated with, i.e. sale, product_sale, tax, shipping, etc.
Check Direct Retrieve
Retrieve current information on a single check direct or multiple check directs.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The amount of the item.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The check number.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
The RevCent ID of the object item.
An array containing offline payment IDs related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
Whether the check has been received.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
Will contain details if the root item is related to a third party shop.
The RevCent ID of the object item.
The name of the item.
The URL of the third party shop.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "check_direct",
"method": "retrieve",
"id": "GO51EXbbAPS6pP1Ov9kK"
}
}Response JSON
{
"api_call_id": "9rdXJQ5z4bcLYqLkV656",
"api_call_processed": true,
"api_call_unix": 1566160507,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "check_direct",
"results": [
{
"amount": 201.58,
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"check_number": "",
"created_date_unix": 1565832518,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [],
"id": "GO51EXbbAPS6pP1Ov9kK",
"notes": [],
"offline_payments": [],
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [
"5r1MyL99VouMNRl9Pnkd",
"d9ZolGRRwnu6lZb2Jo64",
"WmPn2q99GzSKXWmbJjVd"
],
"received": true,
"sales": [
"1rQAp8MM46uzN4Rw0Kgk"
],
"salvage_transactions": [],
"shipping": [
"X8anGkNN5XfZK5mK06VX"
],
"smtp_messages": [],
"status": "Received",
"subscription_renewals": [],
"subscriptions": [
"nbM1P5aa2VfNvVJvWjb1",
"WmPn2q99GzSKRnQjZmkz"
],
"tax": [
"k6vn8JZZAmUv8G5z6klR"
],
"third_party_shop": {
"id": "Q48aAbVv21fJRvNKWrvP",
"name": "My Shop",
"shop_url": "myshop.com"
},
"transactions": [],
"trials": [],
"updated_date_unix": 1565832519
}
],
"total_count": 1,
"total_pages": 1
}Credit Card
Credit card payments are supported via merchant gateway integrations. Integrate a merchant gateway within the RevCent web app. Once integrated you can conduct most payment actions, and RevCent updates transaction status to reflect payment settlement.
Transaction
A credit card transaction can be two types, either a payment is captured, or a refund where a previous payment is refunded. RevCent only supports the auth-capture method when processing a payment, auth-only is not supported.
Transaction Create Refund
Refund a credit card transaction directly. This is not the recommended method if you wish to run detailed metrics reports. Use either Product Sale Refund, Shipping Refund, or Subscription Renewal Refund instead.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The RevCent ID of the credit card transaction.
The amount to refund. If not provided the entire transaction amount will be refunded.
Response JSON Schema
The amount of the item.
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The campaign ID of the transaction being refunded.
The customer ID of the transaction being refunded.
The sale ID of the transaction being refunded.
The ID of the transaction being refunded.
Array containing IDs of each pending refund created as a result of the request.
Array containing IDs of each product sale refunded as a result of the request.
The API request method.
The API request type.
The a brief description of the result of the API call.
Array containing IDs of each shipping refunded as a result of the request.
Array containing IDs of each tax refunded as a result of the request.
Request JSON
{
"request": {
"type": "transaction",
"method": "create_refund",
"transaction_id": "ALRjyqRE27fjMonyKLny",
"amount": 1.25
}
}Response JSON
{
"amount": 1.25,
"api_call_id": "0pwokmGgzRc0yg8dXp7q",
"api_call_processed": true,
"api_call_unix": 1565814903,
"code": 1,
"origin_campaign_id": "X849YQm7BEf0ZQd7Ol1K",
"origin_customer_id": "4r158EzJmmcVM69dNLkg",
"origin_sale_id": "k6vnbJom00Ug89mpRj78",
"origin_transaction_id": "ALRjyqRE27fjMonyKLny",
"pending_refund": [
"MW5LoAVymnHww96XllEr",
"vEwWrAjn8RcM9yQdyjOy",
"9rdEMaP59RuYg41zRJwW",
"Nk5voyEw8YiOmaRvjgyG"
],
"product_sale_refunded": [
"LY5yop5nk7hbPzpBn8aY",
"9rdEMadyZ7uYgnbKWwX5"
],
"request_method": "create_refund",
"request_type": "transaction",
"result": "Pending refund created for transaction.",
"shipping_refunded": [
"gYamRbaGZphKn8zJVow1"
],
"tax_refunded": [
"ALRjyqRE27fjjpmRzBRd"
]
}Transaction Retrieve
Retrieve current information on a single transaction or multiple transactions.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The amount of the item.
The amount captured.
The current amount of calculated fees charged by the payment processor.
The current gross amount. Equals (amount_captured + amount_settled).
The current net amount. Equals (amount_captured + amount_settled) - amount_fees.
The total calculated amount when an item is created.
Total amount of any refunds.
The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.
The current amount settled.
The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).
Total amount of any items that have been voided.
Whether the transaction was approved.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
Whether the transaction was captured.
An array containing check direct IDs related to the item.
The result code for the request.
0 = RevCent Error
1 = Success
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
The customer credit card associated with the transaction.
The unix timestamp of when the item was created.
The unix timestamp of when the item was updated.
The RevCent ID of the object item.
The credit card type
The last four digits of the credit card.
Whether the transaction was declined.
The unix timestamp of when RevCent requested details on the transaction status.
The latest response from the merchant gateway when RevCent requested details on the transaction status.
An array containing discounts related to the item.
Whether the transaction had an error.
The RevCent ID of the gateway.
The name of the gateway.
Whether the transaction has an associated salvage transaction.
Whether the transaction was held.
The RevCent ID of the object item.
Whether the transaction is part of a payment profile request.
Whether the transaction is a refund transaction.
Whether the transaction is a salvage transaction.
Whether the transaction is a subscription transaction.
Whether the transaction is a subscription renewal transaction.
Whether the item was created using a live or test RevCent API key.
An array containing offline payment IDs related to the item.
Payment profile related to the item.
The RevCent ID of the object item.
The name of the item.
An array of objects, each object being a unique item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
The result of the transaction request.
Whether the transaction is an initial sale transaction.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
Whether the transaction has been settled.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
Details on the subscription profile associated with the subscription.
The RevCent ID of the object item.
The name of the item.
The description of the item.
If the number of renewals allowed is specific or indefinite.
If occurrences = specific, then the number of occurrence allowed.
Whether the subscription profile is specific to a single subscription. I.e. customized.
If the subscription profile is specific to a single subscription, the subscription ID.
The frequency setting. Either unit, calendar or fiscal.
The unit based frequency settings for the subscription profile.
The frequency unit value.
The frequency unit, i.e. days, weeks, months or years.
The calendar based frequency settings for the subscription profile.
The calendar unit, i.e. The 2nd X of every month.
The calendar value, i.e. The X day of every month.
The calendar parent, i.e. The 2nd day of every X
The fiscal based frequency settings for the subscription profile.
The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.
The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.
The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
Will contain details if the root item is related to a third party shop.
The RevCent ID of the object item.
The name of the item.
The URL of the third party shop.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
Whether the transaction is void.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "transaction",
"method": "retrieve",
"id": "ALRjyqRE27fjMonyKLny"
}
}Response JSON
{
"api_call_id": "o1jGw57PVgFLLMJ8VJW7",
"api_call_processed": true,
"api_call_unix": 1565814903,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "transaction",
"results": [
{
"amount": 111.86,
"amount_captured": 111.86,
"amount_fees": 3.02,
"amount_gross": 111.86,
"amount_net": 108.84,
"amount_original_total": 111.86,
"amount_refunded": 0,
"amount_remaining": 0,
"amount_settled": 0,
"amount_total": 111.86,
"amount_void": 0,
"approved": true,
"campaign_id": "X849YQm7BEf0ZQd7Ol1K",
"campaign_name": "Facebook Campaign",
"captured": true,
"check_directs": [],
"code": 1,
"created_date_unix": 1565814901,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"customer_card": {
"type": "visa",
"id": "1rQA58w6XXcMNRApYLPn",
"last_4": "4242",
"created_date_unix": 1565814899,
"updated_date_unix": 1565814901,
"expiry_date": "11/2023",
"expiry_month": "11",
"expiry_year": "2023"
},
"declined": false,
"details_last_updated_unix": null,
"details_response": "",
"discounts": [],
"error": false,
"gateway_id": "NkAMJOzpB5iEAOrdloV0",
"gateway_name": "Braintree",
"has_salvage": true,
"held": false,
"id": "ALRjyqRE27fjMonyKLny",
"is_payment_profile": false,
"is_refund": false,
"is_salvage": false,
"is_subscription": false,
"is_subscription_renewal": false,
"live_mode": false,
"metadata": [
{
"name": "adwords_click",
"value": "Cjat0KwhCQjdTq..."
}
],
"notes": [],
"offline_payments": [],
"payment_profile": {
"id": "ajyXm76OpjSL4p5oO2By",
"name": "AuthBrainStripe",
"results": null
},
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [
"9rdEMadyZ7uYgnbKWwX5",
"LY5yop5nk7hbPzpBn8aY"
],
"result": "Approved",
"sale_initial": true,
"sales": [
"k6vnbJom00Ug89mpRj78"
],
"salvage_transactions": [
"VPm9Mqmgw7UJJLldojJY"
],
"settled": false,
"shipping": [
"gYamRbaGZphKn8zJVow1"
],
"smtp_messages": [],
"status": "Fully Captured",
"subscription_profile": null,
"subscription_renewals": [],
"subscriptions": [
"o1jGw5jY2RILLl4dBMwa"
],
"tax": [
"ALRjyqRE27fjjpmRzBRd"
],
"third_party_shop": null,
"trials": [],
"updated_date_unix": 1565814901,
"void": false
}
],
"total_count": 1,
"total_pages": 1
}Offline Payment
An offline payment is essentially a cash or any other means of exchange which needs to be recorded. Offline payments are also useful during replacements, rebates, etc.
Offline Payment Refund
To refund an offline payment you instead refund the entity that the refund is associated with, i.e. sale, product_sale, tax, shipping, etc.
Offline Payment Retrieve
Retrieve current information on a single offline payment or multiple offline payments.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The amount of the item.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
The RevCent ID of the object item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
Will contain details if the root item is related to a third party shop.
The RevCent ID of the object item.
The name of the item.
The URL of the third party shop.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "offline_payment",
"method": "retrieve",
"id": "zGldyKJGORfkP1O1vJ4B"
}
}Response JSON
{
"api_call_id": "gYagkq56lAsJn0K98Y4M",
"api_call_processed": true,
"api_call_unix": 1566160508,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "offline_payment",
"results": [
{
"amount": 255.92,
"campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
"campaign_name": "Twitter Campaign",
"check_directs": [],
"created_date_unix": 1565830657,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [
"6r1EpBQrbRCz91q8E6qb"
],
"id": "zGldyKJGORfkP1O1vJ4B",
"notes": [],
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [
"BvwOk6VvpEs17GrozWaa",
"gYamd2VYr9h4M5zOE7zN",
"o1jGQnO1m4iQWpYjNaB6"
],
"sales": [
"4r15pjKr4RCraznBnvZ1"
],
"salvage_transactions": [],
"shipping": [
"qZBAQK9Zabf4KgXRPmvA"
],
"smtp_messages": [],
"status": "Complete",
"subscription_renewals": [],
"subscriptions": [
"Kn51QPBnE9iGE5mmBRqA"
],
"tax": [
"bOBywapOAGtjzk9PjWyd"
],
"third_party_shop": {
"id": "Q48aAbVv21fJRvNKWrvP",
"name": "My Shop",
"shop_url": "myshop.com"
},
"transactions": [],
"trials": [],
"updated_date_unix": 1565830657
}
],
"total_count": 1,
"total_pages": 1
}PayPal
Integrate your PayPal account(s) with RevCent using the web app and PayPal API credentials. Integrating PayPal with RevCent has several benefits, including dispute detection. PayPal payments made via third party shops and hosted pages are automatically integrated within RevCent.
PayPal Dispute
Once you have integrated your PayPal account with RevCent, we will continuously monitor your PayPal account for any disputes.
RevCent will create a dispute item when a new dispute is found, and attempt to link the specific dispute to a known PayPal transaction within RevCent. Dispute action must be taken within PayPal. We do plan, in the future, to add the ability to take action within RevCent.
PayPal Dispute Retrieve
Retrieve current information on a single PayPal dispute or multiple PayPal disputes.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The unix timestamp of when the item was created.
The RevCent ID of the object item.
The PayPal account you integrated with RevCent.
The RevCent ID of the object item.
The name of the item.
The email address within PayPal for this specific account.
The exact API response RevCent received regarding the PayPal dispute.
The amount disputed, from paypal_details_response.
The date the dispute was created within PayPal, from paypal_details_response
The unix timestamp of when the dispute was created within PayPal, from paypal_details_response
The PayPal dispute ID, from paypal_details_response
Dispute outcome, from paypal_details_response
The date the dispute was last updated within PayPal, from paypal_details_response.
The unix timestamp of when the dispute was last updated within PayPal, from paypal_details_response.
PayPal messages, from paypal_details_response.
The dispute reason, from paypal_details_response.
The status within PayPal, from paypal_details_response.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "paypal_dispute",
"method": "retrieve",
"id": "wLzYlmJdqGiM0RlvvLKp"
}
}Response JSON
{
"api_call_id": "ZVE5YRjd7RsXdJmN02pp",
"api_call_processed": true,
"api_call_unix": 1566160506,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "paypal_dispute",
"results": [
{
"created_date_unix": 1565956199,
"id": "wLzYlmJdqGiM0RlvvLKp",
"paypal_account": {
"id": "mJVWkmzVz0i42j0GEVK4",
"name": "My PayPal Account",
"paypal_account_email": "myemail@gmail.com"
},
"paypal_details_response": "",
"paypal_dispute_amount": 89.98,
"paypal_dispute_created_date": "2019-08-16T09:27:24+00:00",
"paypal_dispute_created_date_unix": 1565947644,
"paypal_dispute_id": "PP-D-XXXXXXXXX",
"paypal_dispute_outcome": "",
"paypal_dispute_updated_date": "2019-08-16T10:31:35+00:00",
"paypal_dispute_updated_date_unix": 1565951495,
"paypal_messages": [
{
"posted_by": "BUYER",
"time_posted": "2019-08-16T09:27:30.000Z",
"content": "Did not receive product."
}
],
"paypal_reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED",
"paypal_status": "OPEN",
"updated_date_unix": 1566129063
}
],
"total_count": 1,
"total_pages": 1
}PayPal Transaction
A PayPal transaction is created within RevCent when a PayPal sale takes place via shopping cart plugin or a RevCent hosted page. RevCent confirms all transactions with PayPal and receives transaction details via the PayPal API.
RevCent also monitors your PayPal account for disputes, and will link disputes to existing transactions when detected.
PayPal Transaction Refund
To refund a PayPal transaction you instead refund the entity that the refund is associated with, the same as you would a credit card transaction. Refunding a sale, shipping, or tax will automatically refund any PayPal transactions using the PayPal API.
PayPal Transaction Retrieve
Retrieve current information on a single PayPal transaction or multiple PayPal transactions.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The amount captured.
The current amount of calculated fees charged by the payment processor.
The current gross amount. Equals (amount_captured + amount_settled).
The current net amount. Equals (amount_captured + amount_settled) - amount_fees.
The total calculated amount when an item is created.
Total amount of any refunds.
PayPal transactions do not receive an amount_remaining, as they are considered complete when created.
PayPal transactions do not receive an amount_settled, as they are considered complete when created.
The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
The RevCent ID of the object item.
An array containing offline payment IDs related to the item.
The PayPal account you integrated with RevCent.
The RevCent ID of the object item.
The name of the item.
The email address within PayPal for this specific account.
The customer ID within PayPal.
The transaction amount within PayPal.
The transaction date within PayPal.
The transaction unix timestamp within PayPal.
The PayPal transaction ID.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
Will contain details if the root item is related to a third party shop.
The RevCent ID of the object item.
The name of the item.
The URL of the third party shop.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "paypal_transaction",
"method": "retrieve",
"id": "k6omOdKbrRTZnpP6d7Ng"
}
}Response JSON
{
"api_call_id": "4r1ZLyqwrvcq9qLbA0qo",
"api_call_processed": true,
"api_call_unix": 1566160506,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "paypal_transaction",
"results": [
{
"amount_captured": 0.01,
"amount_fees": 0,
"amount_gross": 0.01,
"amount_net": 0.01,
"amount_original_total": 0.01,
"amount_refunded": 0,
"amount_remaining": 0,
"amount_settled": 0,
"amount_total": 0.01,
"campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
"campaign_name": "Twitter Campaign",
"check_directs": [],
"created_date_unix": 1562082423,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [],
"id": "k6omOdKbrRTZnpP6d7Ng",
"metadata": [
{
"name": "adwords_click",
"value": "Cjat0KwhCQjdTq..."
}
],
"notes": [],
"offline_payments": [],
"paypal_account": {
"id": "mJVWkmzVz0i42j0GEVK4",
"name": "My PayPal Account",
"paypal_account_email": "myemail@gmail.com"
},
"paypal_customer_id": null,
"paypal_transaction_amount": 0.01,
"paypal_transaction_date": "2019-07-02T15:46:58+00:00",
"paypal_transaction_date_unix": 1562082418,
"paypal_transaction_id": "XXXXXXXXXXXX",
"pending_refunds": [
"vEn8K4MKavIRAyw0NVbR"
],
"product_sales": [
"7rgo91jKVmtYk8NBnnNm"
],
"sales": [
"MWymZv5d6bSpQLl1ARMm"
],
"salvage_transactions": [],
"shipping": [
"qZ4vKalGg5tv298VvO8V"
],
"smtp_messages": [],
"subscription_renewals": [],
"subscriptions": [],
"tax": [],
"third_party_shop": {
"id": "Q48aAbVv21fJRvNKWrvP",
"name": "My Shop"
},
"transactions": [],
"trials": [],
"updated_date_unix": 1562082510
}
],
"total_count": 1,
"total_pages": 1
}Pending Refund
All credit card transactions, paypal transactions, checks and offline payments create a pending refund when refunded. RevCent automatically processes a pending refund once a credit card transaction has settled with the merchant gateway.
Pending Refund Process
Manually process a pending refund. This is not recommended, as RevCent will process pending refunds automatically. The response JSON is useful for notification events sent to endpoints.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
Response JSON Schema
The amount of the item.
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
The raw response of the gateway request as a result of the refund if original payment was via Credit Card.
The ID of the transaction being refunded if original payment was via Credit Card.
The raw response of the PayPal request as a result of the refund if original payment was via PayPal.
The ID of the PayPal transaction the refunded if original payment was via PayPal.
The ID of the pending refund being processed.
The API request method.
The API request type.
The a brief description of the result of the API call.
The ID of the transaction created as a result of the refund if original payment was via Credit Card.
Request JSON
{
"request": {
"type": "pending_refund",
"method": "process",
"id": "8rRNgQd0NGUv6Ggn7og0"
}
}Response JSON
{
"amount": 9.35,
"api_call_id": "wLRrX7jbJrI8R89jg8Bq",
"api_call_unix": 1631302671,
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"code": 1,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"customer_id": "4r158EzJmmcVM69dNLkg",
"gateway_raw_response": "",
"origin_transaction_id": "2rRG9OBOjmf7pO8LV6Mq",
"pending_refund_id": "8rRNgQd0NGUv6Ggn7og0",
"request_method": "process",
"request_type": "pending_refund",
"result": "Pending refund processed successfully. Origin transaction refunded.",
"transaction_id": "BvEPbYWrNBH9R9W1B95W"
}Pending Refund Retrieve
Retrieve current information on a single pending refund or multiple pending refunds.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The amount of the item.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
The RevCent ID of the gateway.
The name of the gateway.
The RevCent ID of the object item.
If the item was created using a check_direct payment method.
If the item was created using an offline payment method.
Whether the item was created using a live or test RevCent API key.
An array containing offline payment IDs related to the item.
The payment type related to the item.
The system ID of the payment type related to the item.
The system name of the payment type related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
Whether the pending refund has been processed.
An array containing product sale IDs related to the item.
The credit card transaction ID being refunded.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
The credit card refund transaction ID.
An array containing tax IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "pending_refund",
"method": "retrieve",
"id": "MW5LoAVymnHww96XllEr"
}
}Response JSON
{
"api_call_id": "bOBy95a444sy46EMwBj1",
"api_call_processed": true,
"api_call_unix": 1565814904,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "pending_refund",
"results": [
{
"amount": 0.89,
"campaign_id": "X849YQm7BEf0ZQd7Ol1K",
"campaign_name": "Facebook Campaign",
"check_directs": [],
"created_date_unix": 1565814903,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [],
"gateway_id": "NkAMJOzpB5iEAOrdloV0",
"gateway_name": "Braintree",
"id": "MW5LoAVymnHww96XllEr",
"is_check_direct": false,
"is_offline_payment": false,
"live_mode": false,
"notes": [],
"offline_payments": [],
"payment_type": {
"id": "KnQ0KlNE6kf5mobyV0pN",
"name": "Credit Card"
},
"paypal_transactions": [],
"processed": false,
"product_sales": [
"LY5yop5nk7hbPzpBn8aY"
],
"refund_transaction_id": "ALRjyqRE27fjMonyKLny",
"sales": [
"k6vnbJom00Ug89mpRj78"
],
"salvage_transactions": [
"VPm9Mqmgw7UJJLldojJY"
],
"shipping": [],
"smtp_messages": [],
"status": "Processing",
"subscription_renewals": [],
"subscriptions": [],
"success_transaction_id": null,
"tax": [],
"trials": [],
"updated_date_unix": 1565814903
}
],
"total_count": 1,
"total_pages": 1
}Product
Create, edit, enable, disable and delete products using the RevCent API. Keep product details and other information up to date.
Product Create
Create a product via the product create method.
Important: RevCent will always create a new product. RevCent will not match sku, internal_id or other identifier to check for existing products in order to prevent duplicates. If you wish to modify a product that already exists in RevCent, use the Product > Edit method below.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product object, containing the actual product and its attributes.
Product name.
Product description.
Product brand. For upcoming search engine integration.
If the product is enabled, i.e. available for purchase.
If the product is a child product of a parent product.
If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product
If you wish to contain the product within one or more RevCent product groups. Provide the RevCent ID(s) of each product group.
If the product is currently on sale. For upcoming search engine integration.
Product price. Default price to be charged upon purchase.
The product trial price. Price to charge when the trial ends, if different from initial sale price.
If the subscription renewal price if different from initial sale price
If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.
Current available stock. For upcoming search engine integration.
If the product is currently in stock. For upcoming search engine integration.
Product cost. For upcoming profit calculations.
Product MSRP. For upcoming search engine integration.
The rating value of the product. For upcoming search engine integration.
The total number of reviews. For upcoming search engine integration.
Product condition. For upcoming search engine integration.
An internal ID for the product. Can be used as an identifier for sale creation
Product SKU. Can be used as an identifier for sale creation.
Product UPC. For upcoming search engine integration.
Product EAN. For upcoming search engine integration.
Product ISBN. For upcoming search engine integration.
Product ASIN. For upcoming search engine integration.
Product MPN. For upcoming search engine integration.
The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.
Trial duration in days. This will create a trial for the product and not charge the customer until the trial ends.
If this is a shippable product, specify when to ship the product. Accepted values:
- trial_expiration
- Product will only ship upon trial expiration.
- trial_creation
- Product will only ship when the trial is created.
- both_trial_expiration_creation
- Product will ship when trial is created and trial expiration.
If this is a subscription product, provide the ID of the subscription profile to use for recurring billing.
If the product is specific to a third party shop provide the ID of the third party shop.
If the product is a shippable product. A shipping entry will be created when the product is sold.
Shipping attributes specific to the product.
Product weight in lbs. For upcoming search engine and shipping cost integration.
Product length in inches. For upcoming search engine and shipping cost integration.
Product width in inches. For upcoming search engine and shipping cost integration.
Product height in inches. For upcoming search engine and shipping cost integration.
The fulfillment account for this product, if applicable.
Deprecated.
Additional custom IDs for the specific product as name value pairs. Useful when the same product is sold via multiple channels with a different ID for each channel.
A description of the ID, not used as the additional ID or identifier when creating a sale.
The actual additional ID, used to identify a specific product.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the product.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "product",
"method": "create",
"product": {
"name": "New Product",
"description": "New product description.",
"enabled": true,
"sku": "new_product_sku",
"internal_id": "new_product_internal_id",
"price": 12.99,
"price_trial": 12.99,
"price_subscription": 19.99,
"trial_shipping_setting": "both_trial_expiration_creation",
"trial_days": 5,
"is_shippable": true,
"shipping_attributes": {
"rate": "",
"weight": "",
"length": "",
"width": "",
"height": "",
"fulfillment_account": "j0o25b2YJRFdJb8EEXE1"
},
"additional_id": [
{
"name": "another_id",
"value": "id_123"
}
],
"subscription_profile": "d9NXVR62vGfYMw6VEZOl",
"product_group": [
"EMYlAaXA1yfkWWora9rG"
],
"third_party_shop": "2rgA7J9AN8CMEpaQGPqN",
"max_quantity_allowed": 0
}
}
}Response JSON
{
"api_call_id": "EMwJyj8bdEfX9YwmR2EW",
"api_call_processed": true,
"api_call_unix": 1565814920,
"code": 1,
"product_id": "qZBAz5nL0RfBgpgg2r49",
"product_name": "New Product",
"request_method": "create",
"request_type": "product",
"result": "Created new product."
}Product Edit
Edit an existing product in RevCent by providing the RevCent ID of the product via the product_id property. The product object is the same as in the Product > Create request.
Note: Only properties included in the edit request will be modified for the product within RevCent. For instance, if you only wanted to modify the price, simply include only the price property in the edit request product object.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product ID
The product object, containing the actual product and its attributes.
Product name.
Product description.
Product brand. For upcoming search engine integration.
If the product is enabled, i.e. available for purchase.
If the product is a child product of a parent product.
If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product
If you wish to contain the product within one or more RevCent product groups. Provide the RevCent ID(s) of each product group.
If the product is currently on sale. For upcoming search engine integration.
Product price. Default price to be charged upon purchase.
The product trial price. Price to charge when the trial ends, if different from initial sale price.
If the subscription renewal price if different from initial sale price
If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.
Current available stock. For upcoming search engine integration.
If the product is currently in stock. For upcoming search engine integration.
Product cost. For upcoming profit calculations.
Product MSRP. For upcoming search engine integration.
The rating value of the product. For upcoming search engine integration.
The total number of reviews. For upcoming search engine integration.
Product condition. For upcoming search engine integration.
An internal ID for the product. Can be used as an identifier for sale creation
Product SKU. Can be used as an identifier for sale creation.
Product UPC. For upcoming search engine integration.
Product EAN. For upcoming search engine integration.
Product ISBN. For upcoming search engine integration.
Product ASIN. For upcoming search engine integration.
Product MPN. For upcoming search engine integration.
The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.
Trial duration in days. This will create a trial for the product and not charge the customer until the trial ends.
If this is a shippable product, specify when to ship the product. Accepted values:
- trial_expiration
- Product will only ship upon trial expiration.
- trial_creation
- Product will only ship when the trial is created.
- both_trial_expiration_creation
- Product will ship when trial is created and trial expiration.
If this is a subscription product, provide the ID of the subscription profile to use for recurring billing.
If the product is specific to a third party shop provide the ID of the third party shop.
If the product is a shippable product. A shipping entry will be created when the product is sold.
Shipping attributes specific to the product.
Product weight in lbs. For upcoming search engine and shipping cost integration.
Product length in inches. For upcoming search engine and shipping cost integration.
Product width in inches. For upcoming search engine and shipping cost integration.
Product height in inches. For upcoming search engine and shipping cost integration.
The fulfillment account for this product, if applicable.
Deprecated.
Additional custom IDs for the specific product as name value pairs. Useful when the same product is sold via multiple channels with a different ID for each channel.
A description of the ID, not used as the additional ID or identifier when creating a sale.
The actual additional ID, used to identify a specific product.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the product.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "product",
"method": "edit",
"product_id": "qZBAz5nL0RfBgpgg2r49",
"product": {
"max_quantity_allowed": 2,
"subscription_profile": "d9NXVR62vGfYMw6VEZOl",
"shipping_attributes": {
"fulfillment_account": "j0o25b2YJRFdJb8EEXE1"
},
"name": "New Product Name",
"price": 12.99,
"price_trial": 12.99,
"price_subscription": 19.99,
"trial_shipping_setting": "both_trial_expiration_creation",
"trial_days": 3,
"enabled": true,
"is_shippable": true
}
}
}Response JSON
{
"api_call_id": "VPm9MqdqLzUJJ1GNdyqR",
"api_call_processed": true,
"api_call_unix": 1565814921,
"code": 1,
"product_id": "qZBAz5nL0RfBgpgg2r49",
"request_method": "edit",
"request_type": "product",
"result": "Product successfully modified."
}Product Enable
Enable a product which has been previously disabled.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product ID
Request JSON
{
"request": {
"type": "product",
"method": "enable",
"product_id": "qZBAz5nL0RfBgpgg2r49"
}
}Response JSON
{
"api_call_id": "ZVEGoylyMacZZ1XkLX1M",
"api_call_processed": true,
"api_call_unix": 1565814921,
"code": 1,
"product_id": "qZBAz5nL0RfBgpgg2r49",
"request_method": "enable",
"request_type": "product",
"result": "Product successfully enabled."
}Product Disable
Disable a product, not allowing it to be included in a sale.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product ID
Request JSON
{
"request": {
"type": "product",
"method": "disable",
"product_id": "qZBAz5nL0RfBgpgg2r49"
}
}Response JSON
{
"api_call_id": "YaVqjAdAG8tGGYALrzMg",
"api_call_processed": true,
"api_call_unix": 1565814921,
"code": 1,
"product_id": "qZBAz5nL0RfBgpgg2r49",
"request_method": "disable",
"request_type": "product",
"result": "Product successfully disabled."
}Product Delete
Delete a product from RevCent. We highly recommend you do not use this method if the product has existing sales, subscriptions, etc. associate with it.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product ID
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the product.
The API request method.
The API request type.
The a brief description of the result of the API call.
Request JSON
{
"request": {
"type": "product",
"method": "delete",
"product_id": "qZBAz5nL0RfBgpgg2r49"
}
}Response JSON
{
"api_call_id": "bOBy95E8awiypP4046jm",
"api_call_processed": true,
"api_call_unix": 1565814922,
"code": 1,
"product_id": "qZBAz5nL0RfBgpgg2r49",
"request_method": "delete",
"request_type": "product",
"result": "Product successfully deleted."
}Product Retrieve
Retrieve current information on a single product or multiple products.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
Additional custom IDs for the specific product as name value pairs. Useful when the same product is sold via multiple channels with a different ID for each channel.
A description of the ID, not used as the additional ID or identifier when creating a sale.
The actual additional ID, used to identify a specific product.
Product ASIN. For upcoming search engine integration.
Product brand. For upcoming search engine integration.
Product condition. For upcoming search engine integration.
Product cost. Will be used for future profit calculations.
The unix timestamp of when the item was created.
Product description.
Deprecated.
Product EAN. For upcoming search engine integration.
If the product is enabled, i.e. available for purchase.
The RevCent product ID.
Product images. For upcoming search engine integration.
Product images url. For upcoming search engine integration.
If the product is currently in stock. For upcoming search engine integration.
An internal ID for the product. Can be used as an identifier for sale creation
If the product is a child product of a parent product.
Deprecated.
If the product is currently on sale. For upcoming search engine integration.
If the product is a shippable product. A shipping entry will be created when the product is sold.
Product ISBN. For upcoming search engine integration.
The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.
Product MPN. For upcoming search engine integration.
Product MSRP. For upcoming search engine integration.
Product name.
If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product
Product price. Default price to be charged upon purchase.
If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.
If the subscription renewal price if different from initial sale price
The product trial price. Price to charge when the trial ends, if different from initial sale price.
If the product is contained within a product group, each product group will be displayed as an object.
Product group ID.
Product group name.
The rating value of the product. For upcoming search engine integration.
The total number of reviews. For upcoming search engine integration.
Shipping attributes specific to the product.
Product weight in lbs. For upcoming search engine and shipping cost integration.
Product length in inches. For upcoming search engine and shipping cost integration.
Product width in inches. For upcoming search engine and shipping cost integration.
Product height in inches. For upcoming search engine and shipping cost integration.
Deprecated.
The fulfillment account for this product, if applicable.
The fulfillment account ID.
The fulfillment account name.
Deprecated.
Product SKU. Can be used as an identifier for sale creation.
Current available stock. For upcoming search engine integration.
Details on the subscription profile associated with the subscription.
The RevCent ID of the object item.
The name of the item.
The description of the item.
If the number of renewals allowed is specific or indefinite.
If occurrences = specific, then the number of occurrence allowed.
Whether the subscription profile is specific to a single subscription. I.e. customized.
If the subscription profile is specific to a single subscription, the subscription ID.
The frequency setting. Either unit, calendar or fiscal.
The unit based frequency settings for the subscription profile.
The frequency unit value.
The frequency unit, i.e. days, weeks, months or years.
The calendar based frequency settings for the subscription profile.
The calendar unit, i.e. The 2nd X of every month.
The calendar value, i.e. The X day of every month.
The calendar parent, i.e. The 2nd day of every X
The fiscal based frequency settings for the subscription profile.
The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.
The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.
The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.
Will contain details if the root item is related to a third party shop.
The RevCent ID of the object item.
The name of the item.
The URL of the third party shop.
Trial duration in days.
If this is a shippable product, specify when to ship the product. Accepted values:
- trial_expiration
- Product will only ship upon trial expiration.
- trial_creation
- Product will only ship when the trial is created.
- both_trial_expiration_creation
- Product will ship when trial is created and trial expiration.
Product UPC. For upcoming search engine integration.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "product",
"method": "retrieve",
"id": "qZBAz5nL0RfBgpgg2r49"
}
}Response JSON
{
"api_call_id": "bOBy95m1E7TypJ7X2lvL",
"api_call_processed": true,
"api_call_unix": 1565814920,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "product",
"results": [
{
"additional_id": [
{
"name": "another_id",
"value": "id_123"
}
],
"asin": "",
"brand": "",
"condition": "",
"cost": null,
"created_date_unix": 1565814920,
"description": "New product description.",
"discount_rate": null,
"ean": "",
"enabled": true,
"id": "qZBAz5nL0RfBgpgg2r49",
"images": [],
"images_url": "productimg.revcent.com",
"in_stock": true,
"internal_id": "An7W08XVj_internal_id",
"is_child_product": false,
"is_discount": false,
"is_price_sale": false,
"is_shippable": true,
"isbn": "",
"max_quantity_allowed": 0,
"metadata": [],
"mpn": "",
"msrp": null,
"name": "New Product",
"parent_product": null,
"price": 12.99,
"price_sale": null,
"price_subscription": 19.99,
"price_trial": 12.99,
"product_group": [
{
"id": "EMYlAaXA1yfkWWora9rG",
"name": "My Product Group"
}
],
"rating_value": null,
"review_count": null,
"shipping_attributes": {
"height": null,
"width": null,
"length": null,
"weight": null,
"rate": null,
"fulfillment_account": {
"id": "j0o25b2YJRFdJb8EEXE1",
"name": "ShipWorks"
},
"shipping_profile": null
},
"sku": "new_product_sku",
"stock": 0,
"subscription_profile": {
"id": "LYE26aKJpPi5VbJmlp2A",
"name": "Monthly",
"description": "",
"occurrences": "specific",
"occurrences_value": 3,
"subscription_specific": false,
"subscription_id": null,
"frequency_unit": {
"unit_value": 1,
"unit": "months"
},
"frequency_calendar": {},
"frequency_fiscal": {},
"frequency": "unit"
},
"third_party_shop": null,
"trial_days": 5,
"trial_shipping_setting": "both_trial_expiration_creation",
"upc": "",
"updated_date_unix": 1565814920
}
],
"total_count": 1,
"total_pages": 1
}Product Sale
A product sale is a sale on a per product basis. This allows us to provide advanced metrics on a product specific level.
Product Sale Refund
If you wish to void a product sale simply leave out the amount property in the request. If you wish to partially refund a product sale then include the amount property with the value amount to refund. If including the entire product sale amount then it will be void automatically. It is important to note that if a product sale is voided it is irreversible.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product sale ID
The amount to refund. If not provided or blank the entire product sale amount will be refunded.
Whether to cancel any subscription or trial associated with the product sale. Default is true.
Response JSON Schema
The amount of the item.
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
Array containing IDs of each pending refund created as a result of the request.
The RevCent ID of the product sale.
The API request method.
The API request type.
The a brief description of the result of the API call.
The RevCent ID of the sale.
An array of subscription IDs that were cancelled.
An array of trial IDs that were cancelled.
Request JSON
{
"request": {
"type": "product_sale",
"method": "refund",
"product_sale_id": "zGld6plAkacWRzRwblaJ",
"amount": 2.25
}
}Response JSON
{
"amount": 2.25,
"api_call_id": "Kn51oqRdpbcyyEPpzQj5",
"api_call_processed": true,
"api_call_unix": 1565814910,
"campaign_id": "X849YQm7BEf0ZQd7Ol1K",
"campaign_name": "Facebook Campaign",
"code": 1,
"customer_id": "4r158EzJmmcVM69dNLkg",
"pending_refund": [
"BvwOyAod0NC221Z7A5mV"
],
"product_sale_id": "zGld6plAkacWRzRwblaJ",
"request_method": "refund",
"request_type": "product_sale",
"result": "Product sale refunded in the amount of $2.25.",
"sale_id": "k6vnbJom00Ug89mpRj78",
"subscription_cancelled": [],
"trial_cancelled": []
}Product Sale Retrieve
Retrieve current information on a single product sale or multiple product sales.
Please view Pagination and Filters for details on retrieving multiple items.
The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The amount captured.
The total amount discounted.
The current amount of calculated fees charged by the payment processor.
The current gross amount. Equals (amount_captured + amount_settled).
The current net amount. Equals (amount_captured + amount_settled) - amount_fees.
The total calculated amount when an item is created.
Total amount of any refunds.
The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.
The current amount settled.
The current amount of related salvage transactions not yet salvaged.
The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).
Total amount of any items that have been voided.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
ISO 4217 currency code.
Whether the item was created using a live or test RevCent API key.
An array containing offline payment IDs related to the item.
The payment type related to the item.
The system ID of the payment type related to the item.
The system name of the payment type related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
The product object containing information on the related product.
The RevCent ID of the object item.
The product name.
The internal_id you provided when creating the item.
The product sku.
The product price for the specific item.
The product quantity for the specific item.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
Will contain details if the root item is related to a third party shop.
The RevCent ID of the object item.
The name of the item.
The URL of the third party shop.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "product_sale",
"method": "retrieve",
"id": "zGld6plAkacWRzRwblaJ"
}
}Response JSON
{
"api_call_id": "X8anMkRdEmcbbGM9Gmwr",
"api_call_processed": true,
"api_call_unix": 1565814910,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "product_sale",
"results": [
{
"amount_captured": 149.99,
"amount_discounted": 0,
"amount_fees": 4.35,
"amount_gross": 149.99,
"amount_net": 145.64,
"amount_original_total": 149.99,
"amount_refunded": 0,
"amount_remaining": 0,
"amount_settled": 0,
"amount_to_salvage": 0,
"amount_total": 149.99,
"amount_void": 0,
"campaign_id": "X849YQm7BEf0ZQd7Ol1K",
"campaign_name": "Facebook Campaign",
"check_directs": [],
"created_date_unix": 1565814901,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [],
"id": "zGld6plAkacWRzRwblaJ",
"internal_id": "robo_vac",
"iso_currency": "USD",
"live_mode": false,
"metadata": [
{
"name": "adwords_click",
"value": "Cjat0KwhCQjdTq..."
}
],
"notes": [],
"offline_payments": [],
"payment_type": {
"id": "KnQ0KlNE6kf5mobyV0pN",
"name": "Credit Card"
},
"paypal_transactions": [],
"pending_refunds": [],
"product": {
"id": "0pBLXVZW08SNw0XOKZ7X",
"internal_id": "robo_vac",
"sku": "robo_vac_sku",
"name": "Robo Vac",
"quantity": 1,
"price": 149.99,
"list_price": 149.99
},
"sales": [
"k6vnbJom00Ug89mpRj78"
],
"salvage_transactions": [],
"shipping": [],
"smtp_messages": [],
"status": "Fully Captured",
"subscription_renewals": [],
"subscriptions": [
"WmPnWqPKbpFRmy6Ma2BG"
],
"tax": [
"P65Gn2J15pc5KRdLp22w"
],
"third_party_shop": null,
"transactions": [
"wLz5MAWPzoUW5VNlydoa"
],
"trials": [
"LY5yop5nk7hb6o2Pvl5j"
],
"updated_date_unix": 1565814909
}
],
"total_count": 1,
"total_pages": 1
}Quota
RevCent supports quota based products, where a customer purchases a certain amount of "units" and has a running balance via a quota account. Create a sale containing one or more quota based products and utilize the RevCent API to manage all aspects of quota based revenue. Subsequent purchases by an existing customer will automatically credit the running balance of the customers' existing quota account. Send requests to retrieve a customers' balance, credit or debit the balance as well as retrieve ledger entries for a quota account. Read more detailed information and use cases on quota billing at our Knowledge Base
Quota Account: A quota account is created when one or more quota products is initially sold to a customer without an existing quota account. The quota account is specific to a customer and contains a running balance of quota units, each quota unit being the quota product sold with specific unit amounts. If a quota account already exists for a customer, then their quota account will receive appropriate unit credits upon subsequent purchases.
Quota Account Ledger Entry: A quota account ledger entry is created by RevCent when any action that affects the balance of a customers' quota account, via web or API, occurs. An entry will be created for either the purchase of a unit product, a quota account debit or a quota account credit. You are able to set metadata during an API request (sale create, account debit, account credit) which will attach to the ledger entry, allowing you to record and gather metrics for credits and debits.
Quota Unit Group: A quota unit group is the organization of quota units. A quota account for a customer is created based on the quota unit group that was initially purchased. This allows you to implement multiple brands without cross balance conflicts and better metrics tracking, i.e. The customer may have two quota accounts, but units are separated by unit group (brand).
Quota Unit: A quota unit is the actual unit the customer is purchasing, i.e. "Phone Minute" or "App Currency". When you create a quota based product you associate a quota unit and set a unit amount. When a quota based product is purchased, the unit amount specified in the product is credited to a customers' quota account. Multiple products can contain the same unit, allowing you to sell varying unit amounts at custom prices, i.e. 100 Minutes or 1000 Minutes. You can set a unit amount of 1 and allow units to be purchased based on product quantity as well.
Quota Account
A quota account is created when one or more quota products is initially sold to a customer that does not have an existing quota account. Each quota account is specific to a customer and contains a running balance of one or more quota units that share the same quota unit group. If a quota account already exists for a customer, then their quota account will receive appropriate unit credits upon subsequent purchases.
Quota Account Credit
Credit a quota account unit balance by a specified unit amount. I.e. a manual credit outside of a purchase.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the quota account.
The RevCent ID of the quota unit being modified within the quota accounts' running balance.
The unit amount being credited to the quota account for the quota unit specified.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the quota account ledger entry associated with the request.
The RevCent ID of the quota account.
An array of quota unit balances within the quota account. Displays current balance for each unit.
The RevCent ID of the unit.
The name of the unit.
The current balance of the specific unit within the quota account.
The RevCent ID of the quota unit.
The API request method.
The API request type.
The a brief description of the result of the API call.
The unit amount credited to the quota account.
Request JSON
{
"request": {
"type": "quota_account",
"method": "credit",
"quota_account_id": "0pP7L8X7Xoi0AG7k8Y5L",
"quota_unit_id": "d9JqY40GoYc7WvVA2dgz",
"unit_amount": 5,
"metadata": [
{
"name": "metadata name",
"value": "metadata value"
}
]
}
}Response JSON
{
"api_call_id": "mJ2BopNGGyh64m256lEr",
"api_call_processed": true,
"api_call_unix": 1599619450,
"code": 1,
"ledger_entry_id": "8rWmO7qwwXh2mJar2XGV",
"quota_account_id": "0pP7L8X7Xoi0AG7k8Y5L",
"quota_account_units": [
{
"id": "8rWyaqo44bSavN79WwOO",
"name": "Gold Token",
"balance": 273
},
{
"id": "6rnmX4jmGjcvW6AGKrwJ",
"name": "Silver Token",
"balance": 61
},
{
"id": "d9JqY40GoYc7WvVA2dgz",
"name": "Platinum Token",
"balance": 10
}
],
"quota_unit_id": "d9JqY40GoYc7WvVA2dgz",
"request_method": "credit",
"request_type": "quota_account",
"result": "Quota account unit Platinum Token credited a total of 5 units.",
"unit_amount": 5
}Quota Account Debit
Debit a quota account unit balance by a specified unit amount.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the quota account.
The RevCent ID of the quota unit being modified within the quota accounts' running balance.
The unit amount being debited from the quota account for the quota unit specified.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the quota account ledger entry associated with the request.
The RevCent ID of the quota account.
An array of quota unit balances within the quota account. Displays current balance for each unit.
The RevCent ID of the unit.
The name of the unit.
The current balance of the specific unit within the quota account.
The RevCent ID of the quota unit.
The API request method.
The API request type.
The a brief description of the result of the API call.
The unit amount debited from the quota account.
Request JSON
{
"request": {
"type": "quota_account",
"method": "debit",
"quota_account_id": "0pP7L8X7Xoi0AG7k8Y5L",
"quota_unit_id": "8rWyaqo44bSavN79WwOO",
"unit_amount": 5,
"metadata": [
{
"name": "metadata name",
"value": "metadata value"
}
]
}
}Response JSON
{
"api_call_id": "0pPXVYM1Qnhl2NjolqAA",
"api_call_processed": true,
"api_call_unix": 1599619405,
"code": 1,
"ledger_entry_id": "6rn5MJ4yvPSBJ6mjByZ1",
"quota_account_id": "0pP7L8X7Xoi0AG7k8Y5L",
"quota_account_units": [
{
"id": "8rWyaqo44bSavN79WwOO",
"name": "Gold Token",
"balance": 273
},
{
"id": "6rnmX4jmGjcvW6AGKrwJ",
"name": "Silver Token",
"balance": 61
},
{
"id": "d9JqY40GoYc7WvVA2dgz",
"name": "Platinum Token",
"balance": 5
}
],
"quota_unit_id": "8rWyaqo44bSavN79WwOO",
"request_method": "debit",
"request_type": "quota_account",
"result": "Quota account unit Gold Token debited a total of 5 units.",
"unit_amount": 5
}Quota Account Enable
Enable or disable a quota account. Disabled quota accounts prevent any related invoice to not be charged.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The ID of the quota account.
Whether the usage account is to be set to enabled. If false, it is disabled.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The API request method.
The API request type.
The a brief description of the result of the API call.
The RevCent ID of the quota account.
Request JSON
{
"request": {
"type": "quota_account",
"method": "enable",
"enabled": true,
"quota_account_id": "JN0Zpj7RGJiwKqAnRoy6"
}
}Response JSON
{
"api_call_id": "bOQYAM2P81i7YBo98wlL",
"api_call_processed": true,
"api_call_unix": 1586607193,
"code": 1,
"request_method": "enable",
"request_type": "quota_account",
"result": "Quota account set to enabled.",
"quota_account_id": "EMLZvL2A6WS1oLazv4rm"
}Quota Account Retrieve
Retrieve current information on a single quota account or multiple quota accounts.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
An array containing discounts related to the item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
An array containing invoice IDs related to the item.
ISO 4217 currency code.
An array of RevCent license key ID's associated with the item.
An array containing offline payment IDs related to the item.
An array containing RevCent PayPal transaction IDs related to the item.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
An array of quota unit balances within the quota account. Displays current balance for each unit.
The RevCent ID of the unit.
The name of the unit.
The current balance of the specific unit within the quota account.
The quota unit group associated with the item.
The RevCent ID of the object item.
The name of the item.
The RevCent hosted shopping cart that item originated from.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
An array containing shipping IDs related to the item.
An array containing SMTP message IDs related to the item.
The current status of the related item.
An array containing subscription renewal IDs related to the item.
An array containing subscription IDs related to the item.
An array containing tax IDs related to the item.
The third party shop related to the item.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "quota_account",
"method": "retrieve",
"id": "EMLZvL2A6WS1oLazv4rm"
}
}Response JSON
{
"api_call_id": "wLWPw9G2zASpO5PBGKYZ",
"api_call_processed": true,
"api_call_unix": 1599661039,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "quota_account",
"results": [
{
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"check_directs": [],
"created_date_unix": 1599445342,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"discounts": [],
"enabled": true,
"id": "zGZqMWZ6EmFXRKvPzyZl",
"invoices": [],
"iso_currency": "USD",
"license_keys": [],
"metadata": [
{
"name": "re purchase account",
"value": "test value",
"entry_date": "2020-09-07"
}
],
"notes": [],
"offline_payments": [],
"paypal_transactions": [],
"pending_refunds": [],
"product_sales": [
"Q4JAvmJjlPT9JGNodQEz"
],
"quota_account_units": [
{
"id": "8rWyaqo44bSavN79WwOO",
"name": "Gold Token",
"balance": 100
},
{
"id": "d9JqY40GoYc7WvVA2dgz",
"name": "Platinum Token",
"balance": 10
}
],
"quota_unit_group": {
"id": "6rnQQzm2mkSmrAorQ6ym",
"name": "Currency Tokens"
},
"revcent_shop": null,
"sales": [
"MWKba6pVQztGVKm9PAad"
],
"salvage_transactions": [],
"shipping": [],
"smtp_messages": [],
"status": "Enabled",
"subscription_renewals": [],
"subscriptions": [],
"tax": [
"qZO6mGOa1JFXlrRbqPKw"
],
"third_party_shop": null,
"transactions": [
"ALKOQGKzlrS0vXV4El6E"
],
"trials": [],
"updated_date_unix": 1599487612
}
],
"total_count": 1,
"total_pages": 1
}Quota Account Ledger Entry
A quota account ledger entry is automatically created by RevCent when any action that affects the balance of a customers' quota account, via web or API, occurs. An entry will be created for either the purchase of a unit product, a quota account debit or a quota account credit. You are able to set metadata during an API request (sale create, account debit, account credit) which will attach to the ledger entry, allowing you to record and gather metrics for credits and debits.
Quota Account Ledger Entry Retrieve
Retrieve current information on a single quota account ledger entry or multiple ledger entries.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The unix timestamp of when the item was created.
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
The RevCent ID of the object item.
The ledger entry method, either credit or debit.
The quota account associated with the item.
The RevCent ID of the object item.
The quota unit associated with the item.
The RevCent ID of the object item.
The name of the item.
The quota unit group associated with the item.
The RevCent ID of the object item.
The name of the item.
The unit amount relative to the request.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "quota_account_ledger_entry",
"method": "retrieve",
"id": "EMLZvL2A6WS1oLazv4rm"
}
}Response JSON
{
"api_call_id": "j0EMk710oaFRY59MlEqp",
"api_call_processed": true,
"api_call_unix": 1599661292,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "quota_account_ledger_entry",
"results": [
{
"created_date_unix": 1599503098,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"id": "X81WNRaG2ytO6r20Q9K4",
"metadata": [
{
"name": "quota account",
"value": "test value",
"entry_date": "2020-09-07"
}
],
"method": "credit",
"quota_account": {
"id": "GOKmbYmVmyc5m5G9aE46"
},
"quota_unit": {
"id": "6rnmX4jmGjcvW6AGKrwJ",
"name": "Silver Token"
},
"quota_unit_group": {
"id": "6rnQQzm2mkSmrAorQ6ym",
"name": "Currency Tokens"
},
"unit_amount": 1,
"updated_date_unix": 1599503098
}
],
"total_count": 1,
"total_pages": 1
}Quota Unit Group
A quota unit group is the organization of quota units. A quota account for a customer is created based on the quota unit group that was initially purchased. This allows you to implement multiple brands without cross balance conflicts and better metrics tracking, i.e. The customer may have two quota accounts, but units are separated by unit group (brand).
Quota Unit Group Retrieve
Retrieve current information on a single quota unit group or multiple unit groups.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The unix timestamp of when the item was created.
The description of the item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The name of the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "quota_unit_group",
"method": "retrieve",
"id": "EMLZvL2A6WS1oLazv4rm"
}
}Response JSON
{
"api_call_id": "zGZgzKy0bofkAl5VQAX7",
"api_call_processed": true,
"api_call_unix": 1599661400,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "quota_unit_group",
"results": [
{
"created_date_unix": 1599221690,
"description": "",
"enabled": true,
"id": "6rnQQzm2mkSmrAorQ6ym",
"name": "Currency Tokens",
"updated_date_unix": 1599612622
}
],
"total_count": 1,
"total_pages": 1
}Quota Unit
A quota unit is the actual unit the customer is purchasing, i.e. "Phone Minute" or "App Currency". When you create a quota based product you associate a quota unit and set a unit amount. When a quota based product is purchased, the unit amount specified in the product is credited to a customers' quota account. Multiple products can contain the same unit, allowing you to sell varying unit amounts at custom prices, i.e. 100 Minutes or 1000 Minutes. You can set a unit amount of 1 and allow units to be purchased based on product quantity as well.
Quota Unit Retrieve
Retrieve current information on a single quota unit or multiple units.
Please view Pagination and Filters for details on retrieving multiple items.
Request JSON Schema
The main request object.
The type of request being made.
The method for the request type.
The RevCent ID of the item. Required if multiple property equals false or is not present.
Whether it is a multiple type request.
Response JSON Schema
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The result code for the request.
0 = RevCent Error
1 = Success
The number of result items contained in the current page.
The current page of result, same as requested page, default is page 1.
The API request method.
The API request type.
An array of objects, each object being a unique item.
The unix timestamp of when the item was created.
The description of the item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The name of the item.
The quota unit group associated with the item.
The RevCent ID of the object item.
The name of the item.
The unix timestamp of when the item was updated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
{
"request": {
"type": "quota_unit",
"method": "retrieve",
"id": "EMLZvL2A6WS1oLazv4rm"
}
}Response JSON
{
"api_call_id": "WmJwZQEl1pFrXOVa1XnQ",
"api_call_processed": true,
"api_call_unix": 1599661481,
"code": 1,
"current_count": 1,
"current_page": 1,
"request_method": "retrieve",
"request_type": "quota_unit",
"results": [
{
"created_date_unix": 1599355824,
"description": "",
"enabled": true,
"id": "6rnmX4jmGjcvW6AGKrwJ",
"name": "Silver Token",
"quota_unit_group": {
"id": "6rnQQzm2mkSmrAorQ6ym",
"name": "Currency Tokens"
},
"updated_date_unix": 1599355842
}
],
"total_count": 1,
"total_pages": 1
}Sale
A sale is one or more products sold. Shipping and tax can be manually provided or automatically created depending on your request and account settings. Several payment types are supported including credit card, PayPal, check and offline payment.
You also have the ability to create a pending sale without initially specifying a payment type, which saves the sale information to be finalized later. Refer to the Pending Sale section.
Sale Create
Create a new sale using the sale create API call. This is an important API call and we recommend viewing all property descriptions for both the request and response objects. Request object properties have some nuances depending on the product(s) being sold, tracking, customer, etc. Response object properties are useful for displaying information to a customer sale immediately after a payment is made.
Note: Depending on the payment type being used for the sale, refer to the sections below for specific requirements and examples for Credit Card, PayPal, Check and Offline payment methods.
AdWords Integration
If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID. Read more about integrating AdWords with RevCent on our Knowledge Base .
Example
"metadata":[{"name": "adwords_click", "value": "ADWORDS_CLICK_ID_HERE"}]Kount Integration
If you have setup Kount as a third party integration in RevCent, and wish to have Kount check the payment for fraud, include the "kount_session_id" object in your request metadata array. RevCent will detect the specific metadata object with name="kount_session_id" and perform the proper communication with Kount before sending the payment to the desired processor. Empty session IDs will result in an error from Kount. Read more about integrating Kount with RevCent on our Knowledge Base .
Example
"metadata":[{"name": "kount_session_id", "value": "KOUNT_SESSION_ID_HERE"}]Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The payment object. Multiple payment methods are accepted when creating a sale. However, each payment method has specific required fields.
Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.
If payment is by credit card.
The credit card code as a string. Depending on the card type this can be different lengths.
The credit card number. This value must be a valid credit card number as a string.
The credit card expiration month. Two digit integer, MM.
The credit card expiration year. Two digit integer, YY.
If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.
If payment is by PayPal, and already processed by PayPal with a return transaction ID.
The PayPal transaction ID, provided by PayPal for the corresponding transaction.
PayPal payments are processed by PayPal and not RevCent, therefore RevCent needs the transaction ID to create a PayPal sale.
Default: false. RevCent verifies all PayPal transactions using the PayPal API before officially confirming the sale.
If payment is a physical check, not ACH or electronic.
If you wish to specify the mailing address for a customer to mail the physical check to. Useful when utilizing SMTP messages containing customer instructions.
If you wish to specify the pay to address for a customer to make the check out to. Useful when utilizing SMTP messages containing customer instructions.
If payment is in cash, etc., or it is necessary to create a sale without an actual payment type.
The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.
ISO 4217 currency code. If not provided default is 'USD'.
To use as the billing information. If not present the customer object will be used.
The customer object receives first priority as details if creating a new customer.
If the customer object is not present the bill_to and ship_to objects will be used in the respective order.
If neither customer, bill_to or ship_to objects are provided the new customer will be created as 'Anonymous'.
This does not apply if using a customer_id field in the request where applicable.
If you are creating a sale for an existing customer. This value can be the RevCent customer ID or your internal customer ID.
If you wish to create a unique sale request. This allows you to successfully retry a failed API call without risk of charging a customer twice for the same sale. If a sale has been paid it will not allow future payments to be processed.
If you wish to associate the sale with a third party shop provide the RevCent ID for the third party shop.
Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.
Use a payment profile for processing the item payment. This value can either be the RevCent payment profile ID or the custom payment profile name you created.
Your internal customer ID.
Your internal sale ID.
The product array contains individual product objects.
Pricing is automatically calculated based upon the quantity, price or both if present.
The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.
The price, if different from the product default price, you wish to charge.
The quantity. Default is 1.
Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.
Create a trial for the specific product being sold ending after the number of days provided.
To use as the shipping information. Any shipping entries created will use the ship_to object field.
If not present the customer object will be used.
The shipping array. Can contain multiple shipping objects.
Note: View our Provider Method Table for mapping provider and provider_method values for shipping object entries.
The shipping amount to charge.
Your shipping cost. This is for your internal purposes.
Shipping description.
Whether you wish to internally identify this as a free shipping item. This value will NOT be used to calculate any amounts. This if for your internal purposes. Default: false
Shipping name.
The shipping provider.
The shipping provider method.
The shipping provider tracking.
The tax array. Can contain multiple tax objects.
Tax amount to charge.
Tax description.
Tax name.
Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts
The coupon array. Can contain multiple coupon objects, each containing a coupon code.
The coupon code.
The discount array. Can contain multiple discount objects.
The actual discount value according to the discount type. Currently the discount value is a fixed amount, i.e. 5 will deduct the sale price by 5.
The discount type. Default: amount.
The discount name.
The discount description.
Response JSON Schema
The amount of the item.
The amount captured.
The total amount discounted.
The current amount of calculated fees charged by the payment processor.
The current gross amount. Equals (amount_captured + amount_settled).
The current net amount. Equals (amount_captured + amount_settled) - amount_fees.
The total calculated amount when an item is created.
The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.
The current amount of related salvage transactions not yet salvaged.
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The RevCent ID of the customer credit card used if a transaction occurred.
The result code for the request.
0 = RevCent Error
1 = Success
2 = Merchant Declined
3 = Merchant Error
4 = Merchant Hold
5 = Fraud Detected
The customer object.
The customers' first address line.
The customers' second address line.
Whether the customer has been blocked from purchases.
The customers' city.
The customers' company.
The customers' country.
The customers' email.
Whether the customer is currently enabled.
The customers' first name.
The customers' full address.
Whether the customers' address was successfully geocoded using the Google geocoding service.
The Google place ID for the customers' address using the Google geocoding service.
The RevCent ID for the customer.
Your internal ID for the customer.
The customers' last name.
The approximate latitude for the customers' address using the Google geocoding service.
The approximate longitude for the customers' address using the Google geocoding service.
The customers' phone number.
The customers' state.
The customers' state in long format.
The customers' status.
The customers' zip or postal code.
The RevCent ID of the customer.
An array of discounts created as a result of the request.
The name of the discount created.
The description of the discount created.
The total discount amount.
The percentage of the total.
The ID of the discount created.
If fraud detection is active, the response from a detection request will be present. A fraud detection request is made prior to the payment attempt with the processor.
The request code. 1 = No fraud or no detection integrated. 5 = Fraud detected. 0 = Error.
The explained result of any fraud detection request related to the item.
Whether fraud was detected before processing the items' related payment.
Any fraud detections created.
If fraud detection is integrated and a third party is contacted prior to payment, the details of a fraud detection request.
The RevCent ID of the object item.
Details on the specific third party.
The RevCent ID for the third party.
The name of the third party.
The ID of your RevCent third party integration.
The name of your RevCent third party integration.
The raw response returned from the third party when originally contacted.
The third party ID for the request.
The response time in milliseconds it took to receive a response from the third party integration.
Gateway related to the item.
The RevCent ID of the gateway.
The full response from the merchant gateway as a JSON string.
Your internal customer ID.
Your internal sale ID.
ISO 4217 currency code.
If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.
The ID of the payment profile used.
The original amount submitted in the request using the products, their prices and quantities.
The final amount that was successfully charged after the payment profile was applied, if applicable.
The step in the payment profile that ended in success, if applicable.
The gateway that successfully processed the transaction, if applicable.
The total number of declined transactions that occurred when the payment profile was processed.
An array of IDs for declined transactions during the payment profile processing.
The step_array contains individual objects related to the number of steps taken in the process when implementing the payment profile.
We highly recommend you read more about the Payment Profile feature at RevCent to gain a better understanding of what steps are as well as step methods.
The action taken during the step.
The resulting step amount to be charged after any modifiers to payment amount.
If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.
The order of gateways used when processing the cascade.
The gateways which were enabled within the cascade for processing.
The results for each gateway validated within the cascade, after being passed or failed due to in place rules.
The ID of the gateway validated.
The order of the gateway within the cascade.
Revenue rules validation result for the gateway.
If revenue rules were enabled for the gateway.
If the gateway passed all revenue rules.
If revenue rules were present and enabled, the results of the revenue validation will be displayed here.
Time rules validation result for the gateway.
If time rules were enabled for the gateway.
If the gateway passed all time rules.
If time rules were present and enabled, the results of the time validation will be displayed here.
If the gateway passed all gateway validation requirements.
The ID of the gateway which was selected first for validation.
The name of gateway used to process the step transaction.
The ID of gateway used to process the step transaction.
The response returned by the gateway used to process the step transaction.
The modifier applied to the payment amount, if any.
The specific step number.
The result of the step transaction
The step setting.
The step source, either gateway or cascade.
The ID of the step transaction.
An array of product sales created. Each object is an individual product sale containing details.
The total calculated amount when an item is created.
The amount captured.
The current gross amount. Equals (amount_captured + amount_settled).
The current net amount. Equals (amount_captured + amount_settled) - amount_fees.
The current amount of calculated fees charged by the payment processor.
The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.
The current amount of related salvage transactions not yet salvaged.
The total amount discounted.
The RevCent ID of the object item.
The price of the product, either from product settings or if specific price provided in the request.
The quantity submitted in the request, or 1 if quantity was not provided.
The product object containing information on the related product.
The RevCent ID of the object item.
The product name.
The internal_id you provided when creating the item.
The product sku.
Details if a subscription was created as a result of the product sale. Null if not applicable.
The RevCent ID of the object item.
Details if a trial was created as a result of the product sale. Null if not applicable.
The RevCent ID of the object item.
If any products purchased were quota based, then a quota account will be created or modified if already exists for the customer.
The quota account ID.
The quota unit group associated with the quota account.
The quota unit group ID.
The quota unit group name.
An array of quota unit balances within the quota account. Displays current balance for each unit.
The quota unit ID.
The quota unit name.
The quota unit balance within the quota account after the api call was processed.
The API request method.
The API request type.
The a brief description of the result of the API call.
The RevCent ID of the sale.
The salvage transaction details object, if created as a result of the request. Null if not applicable.
The RevCent ID of the object item.
The salvage transaction amount.
If the salvage transaction is enabled.
If the salvage transaction will create a new sale.
If a salvage transaction was created as a result of the request.
The ship to object.
An array of shipping items created. Each object is an individual shipping item containing details.
The total calculated amount when an item is created.
The amount captured.
The current gross amount. Equals (amount_captured + amount_settled).
The current net amount. Equals (amount_captured + amount_settled) - amount_fees.
The current amount of calculated fees charged by the payment processor.
The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.
The current amount of related salvage transactions not yet salvaged.
The total amount discounted.
The RevCent ID of the object item.
The shipping provider.
The shipping provider method.
The shipping provider tracking if provided.
Deprecated.
An array of subscriptions created. Each object is an individual subscription containing details.
The RevCent ID of the object item.
The unix timestamp of when the subscription starts, either sale creation or when related trial is set to end.
The unix timestamp of when the subscription next renews. Calcaulted on sale creation or null and ultimately calculated when trial ends.
Details of the related product sale.
The product object containing information on the related product.
The RevCent ID of the object item.
The product name.
The internal_id you provided when creating the item.
The product sku.
Details if a trial was created related to the subscription. Null if not applicable.
The RevCent ID of the object item.
An array of tax items created. Each object is an individual tax item containing details.
The total calculated amount when an item is created.
The amount captured.
The current gross amount. Equals (amount_captured + amount_settled).
The current net amount. Equals (amount_captured + amount_settled) - amount_fees.
The current amount of calculated fees charged by the payment processor.
The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.
The current amount of related salvage transactions not yet salvaged.
The RevCent ID of the object item.
The name of the item.
The description of the item.
Tax rate calculated based on tax amount and total related item amount.
Will contain details if the root item is related to a third party shop.
The RevCent ID of the object item.
The name of the item.
The URL of the third party shop.
The ID of the credit card transaction charged to create the sale, if applicable.
An array of trials created. Each object is an individual trial containing details.
The RevCent ID of the object item.
The trial duration in number of days.
The unix timestamp of when the trial is set to expire.
Details of the related product sale.
The RevCent ID of the object item.
The product object containing information on the related product.
The RevCent ID of the object item.
The product name.
The internal_id you provided when creating the item.
The product sku.
Details of any related subscription.
The RevCent ID of the object item.
If any product(s) were a usage/metered billing product, then usage account(s) will be created for each related products' usage profile billing period. Same period billing will group items into one usage account
The usage account ID.
If any product(s) were a usage/metered billing product, then usage item(s) will be created for each related product.
The usage item ID.
The product sale associated with the usage item.
The RevCent ID of the object item.
The product associated with the usage item.
The RevCent ID of the object item.
The name of the item.
The internal_id you provided when creating the item.
The product sku.
The trial associated with the usage item, if applicable.
The RevCent ID of the object item.
The usage account associated with the usage item.
The RevCent ID of the object item.
Request JSON
{
"request": {
"type": "sale",
"method": "create",
"payment": {
"credit_card": {
"card_number": "4242424242424242",
"exp_month": 4,
"exp_year": 22,
"card_code": "000"
},
"payment_type": "credit_card"
},
"campaign": "Adwords Campaign",
"iso_currency": "USD",
"payment_profile": "AuthBrainStripe",
"customer": {
"first_name": "vqjh",
"last_name": "slszhjru",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "ctnb@gmail.com",
"phone": "1234567890"
},
"bill_to": {
"first_name": "vqjh",
"last_name": "slszhjru",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "ctnb@gmail.com",
"phone": "1234567890"
},
"ship_to": {
"first_name": "vqjh",
"last_name": "slszhjru",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "ctnb@gmail.com",
"phone": "1234567890"
},
"product": [
{
"id": "robo_vac",
"quantity": 1
},
{
"id": "av_2017",
"price": 19.99
},
{
"id": "usb_hdd"
}
],
"tax": [
{
"amount": 9.31,
"rate": 7.3,
"name": "State Sales",
"description": "seven percent"
}
],
"shipping": [
{
"amount": 5,
"name": "USPS Priority",
"description": "",
"provider": "usps",
"provider_method": "priority",
"provider_tracking": "3546 5214 5698 5214 5488 91",
"weight": 4.3
}
],
"coupon": [
{
"coupon_code": "10percent"
}
],
"discount": [
{
"discount_value": 5,
"discount_type": "amount",
"name": "$5 Off manually applied",
"description": "Manually applied discount."
}
],
"internal_sale_id": "sale_7678",
"internal_customer_id": "cus_3197",
"metadata": [
{
"name": "adwords_click",
"value": "Cjat0KwhCQjdTq..."
},
{
"name": "sign_up_page",
"value": "v1"
},
{
"name": "kount_session_id",
"value": "c8ed4debf8f242be972c1071731052e8"
}
]
}
}Response JSON
{
"amount": 111.86,
"amount_captured": 111.86,
"amount_discounted": 0,
"amount_fees": 3.02,
"amount_gross": 111.86,
"amount_net": 108.84,
"amount_original_total": 274.28,
"amount_remaining": 162.42,
"amount_to_salvage": 12.43,
"api_call_id": "O051ZWQ4XjijnV5LkVGl",
"api_call_processed": true,
"api_call_unix": 1565833755,
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"card_id": "WmPn2g8bakcKnWWEmRlJ",
"code": 1,
"customer": {
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"blocked": false,
"city": "Washington",
"company": "",
"country": "USA",
"email": "johndoe@gmail.com",
"enabled": true,
"first_name": "John",
"full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
"geocode_success": true,
"google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
"id": "4r158EzJmmcVM69dNLkg",
"internal_id": "cus_0001",
"last_name": "Doe",
"lat": "38.8976633",
"lon": "-77.0365739",
"metadata": [],
"phone": "1234567890",
"state": "DC",
"state_long": "DC",
"zip": "20500"
},
"customer_id": "ajOAl24bBXc5nXwagAOg",
"discount_created": [],
"fraud_detection_response": {
"code": 1,
"message": "No fraud detected. Continuing payment.",
"fraud_detected": false,
"fraud_detection_created": null,
"fraud_detection_request": {
"id": "rmMrXO5G8EFk8zO0rGlX",
"third_party": {
"id": "mJEZdyVavzUL0gGoLR1Z",
"name": "Kount"
},
"third_party_integration": {
"id": "ajYRoLokyXf62qy06JpZ",
"name": "Kount Risk Inquiry"
},
"third_party_raw_response": "",
"third_party_order_id": "",
"third_party_fraud_detection_id": "DWN40J2NPKRW",
"third_party_response_ms": 834
}
},
"gateway": "Braintree",
"gateway_id": "NkAMJOzpB5iEAOrdloV0",
"gateway_raw_response": "",
"internal_customer_id": "cus_3197",
"internal_sale_id": "sale_7678",
"iso_currency": "USD",
"payment_profile_results": {
"payment_profile_id": "ajyXm76OpjSL4p5oO2By",
"original_amount": 124.29,
"final_amount": 111.86,
"successful_step_num": 2,
"successful_gateway": "Braintree",
"num_declined_transactions": 1,
"declined_transaction_array": [
"RJ5MaZMap1cZdP9w7ayE"
],
"step_array": [
{
"step_action": "initial",
"step_amount": 124.29,
"step_cascade_result": {
"cascade_order": "sort_order",
"enabled_gateways": [
"2rE2pQGMd7SYjGp42yEL",
"LYE26MW8Rlh5VbJmlp2l",
"GOJankNpkpsPzw6No1OP",
"NkAMJOzpB5iEAOrdloV0"
],
"gateway_results": [
{
"gateway_id": "2rE2pQGMd7SYjGp42yEL",
"order": 1,
"revenue_rules": {
"enabled": false,
"passed": true,
"details": []
},
"success": true,
"time_rules": {
"enabled": false,
"passed": true,
"details": []
}
}
],
"start_gateway": "2rE2pQGMd7SYjGp42yEL"
},
"step_gateway": "Worldpay",
"step_gateway_id": "2rE2pQGMd7SYjGp42yEL",
"step_gateway_response": "",
"step_modifier": "",
"step_num": 1,
"step_result": "Declined",
"step_setting": "initial",
"step_source": "cascade",
"step_transaction": "RJ5MaZMap1cZdP9w7ayE"
},
{
"step_action": "next",
"step_amount": 111.86,
"step_cascade_result": null,
"step_gateway": "Braintree",
"step_gateway_id": "NkAMJOzpB5iEAOrdloV0",
"step_modifier": "10",
"step_num": 2,
"step_result": "Approved",
"step_setting": "modifypct",
"step_source": "gateway",
"step_transaction": "vEwWZv5B5zIXM9bq1yQd"
}
]
},
"product_sale_created": [
{
"amount_original_total": 89.99,
"amount_captured": 79.82,
"amount_gross": 79.82,
"amount_net": 77.66,
"amount_fees": 2.16,
"amount_remaining": 10.17,
"amount_to_salvage": 10.17,
"amount_discounted": 0,
"id": "8rwvAzd6dQU6kXkB2VQq",
"price": 89.99,
"quantity": 1,
"product": {
"id": "k6EXjKzd7PHOpgvdYjXG",
"name": "USB HDD",
"internal_id": "usb_hdd",
"sku": "usb_hdd_sku"
},
"subscription": null,
"trial": null
},
{
"amount_original_total": 149.99,
"amount_captured": 0,
"amount_gross": 0,
"amount_net": 0,
"amount_fees": 0,
"amount_remaining": 149.99,
"amount_to_salvage": 0,
"amount_discounted": 0,
"id": "7rwyAzL5LXUa8QrGMoMR",
"price": 149.99,
"quantity": 1,
"product": {
"id": "0pBLXVZW08SNw0XOKZ7X",
"name": "Robo Vac",
"internal_id": "robo_vac",
"sku": "robo_vac_sku"
},
"subscription": {
"id": "4r15qAlZlyUoMprMNVpE"
},
"trial": {
"id": "k6vn81lElqsvKEB4K2JA"
}
},
{
"amount_original_total": 19.99,
"amount_captured": 17.73,
"amount_gross": 17.73,
"amount_net": 17.25,
"amount_fees": 0.48,
"amount_remaining": 2.26,
"amount_to_salvage": 2.26,
"amount_discounted": 0,
"id": "Nk5vOzGAGRfrmg8LZXVM",
"price": 19.99,
"quantity": 1,
"product": {
"id": "6r8O5MLbw2t6n4v1lGqK",
"name": "AV 2017",
"internal_id": "av_2017",
"sku": "av_2017_sku"
},
"subscription": {
"id": "VPm9vVEoERc6Wy6Jg7Jg"
},
"trial": null
}
],
"quota_accounts": [
{
"id": "4rybZlBnGyCk85zlMmGj",
"quota_unit_group": {
"id": "6rnQQzm2mkSmrAorQ6ym",
"name": "Currency Tokens"
},
"quota_account_units": [
{
"id": "6rnmX4jmGjcvW6AGKrwJ",
"name": "Silver Token",
"balance": 50
}
]
}
],
"request_method": "create",
"request_type": "sale",
"result": "Approved",
"sale_id": "rm9EG1BjrXcqm64KKq6z",
"salvage_transaction": {
"id": "9rdE4zvXvQUjVp22ddgm",
"amount": 12.43,
"enabled": true,
"sale_creator": false
},
"salvage_transaction_created": true,
"ship_to": {
"first_name": "vqjh",
"last_name": "slszhjru",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"company": "",
"country": "USA",
"email": "ctnb@gmail.com",
"phone": "1234567890"
},
"shipping_created": [
{
"amount_original_total": 5,
"amount_captured": 5,
"amount_gross": 5,
"amount_net": 4.87,
"amount_fees": 0.14,
"amount_remaining": 0,
"amount_to_salvage": 0,
"amount_discounted": 0,
"id": "Q45o8zGpGRu098B88npR",
"provider": "usps",
"provider_method": "priority_mail_express_flat_rate_envelope",
"provider_tracking": "3546 5214 5698 5214 5488 91",
"weight": 0
}
],
"subscription_created": [
{
"id": "VPm9vVEoERc6Wy6Jg7Jg",
"start_date_unix": 1565833755,
"next_renewal_date_unix": 1568512155,
"product_sale": {
"id": "Nk5vOzGAGRfrmg8LZXVM"
},
"product": {
"id": "6r8O5MLbw2t6n4v1lGqK",
"name": "AV 2017",
"internal_id": "av_2017",
"sku": "av_2017_sku"
},
"trial": null
},
{
"id": "4r15qAlZlyUoMprMNVpE",
"start_date_unix": 1565920155,
"next_renewal_date_unix": null,
"product_sale": {
"id": "7rwyAzL5LXUa8QrGMoMR"
},
"product": {
"id": "0pBLXVZW08SNw0XOKZ7X",
"name": "Robo Vac",
"internal_id": "robo_vac",
"sku": "robo_vac_sku"
},
"trial": {
"id": "k6vn81lElqsvKEB4K2JA"
}
}
],
"tax_created": [
{
"amount_original_total": 9.31,
"amount_captured": 9.31,
"amount_gross": 9.31,
"amount_net": 9.06,
"amount_fees": 0.25,
"amount_remaining": 0,
"amount_to_salvage": 0,
"id": "2rdJNg4E4yUplpKWYnpo",
"name": "User Provided Tax",
"description": "Tax rate calculated using provided tax amount.",
"rate": 0.08
}
],
"third_party_shop": null,
"transaction_id": "vEwWZv5B5zIXM9bq1yQd",
"trial_created": [
{
"id": "k6vn81lElqsvKEB4K2JA",
"num_days": 1,
"end_date_unix": 1565920155,
"product_sale": {
"id": "7rwyAzL5LXUa8QrGMoMR"
},
"product": {
"id": "0pBLXVZW08SNw0XOKZ7X",
"name": "Robo Vac",
"internal_id": "robo_vac",
"sku": "robo_vac_sku"
},
"subscription": {
"id": "4r15qAlZlyUoMprMNVpE"
}
}
],
"usage_account_created": [
{
"id": "X8RqyywEwMU8XwLoK69A"
}
],
"usage_item_created": [
{
"id": "qZqRPPQowXfGbp8Xl0z9",
"product_sale": {
"id": "Nk5vOzGAGRfrmg8LZXVM"
},
"product": {
"id": "6r8O5MLbw2t6n4v1lGqK",
"name": "Usage Product 1",
"internal_id": "usage_product_1",
"sku": "usage_product_1"
},
"trial": null,
"usage_account": {
"id": "X8RqyywEwMU8XwLoK69A"
}
}
]
}Sale Create Credit Card
Example sale create object for credit card sales. Refer to the Sale Create request section above for additional properties, including required properties.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The payment object. In this example the payment type is credit card.
Value should be "credit_card".
If payment is by credit card.
The credit card code as a string. Depending on the card type this can be different lengths.
The credit card number. This value must be a valid credit card number as a string.
The credit card expiration month. Two digit integer, MM.
The credit card expiration year. Two digit integer, YY.
Request JSON
{
"request": {
"type": "sale",
"method": "create",
"payment": {
"credit_card": {
"card_number": "4242424242424242",
"exp_month": 4,
"exp_year": 22,
"card_code": "000"
},
"payment_type": "credit_card"
}
}
}Sale Create PayPal
Example sale create object for PayPal sales. Refer to the Sale Create request section above for additional properties, including required properties.
Important: The "is_pending" property should always be set to true when creating a PayPal sale via API.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
Value should always be set to true when creating a PayPal sale via API.
The payment object. In this example the payment type is PayPal, therefore the paypal object is present and payment type is set to "paypal".
Value should be "paypal" signifying that the payment is PayPal.
The paypal object containing the PayPal transaction ID.
The PayPal transaction ID for the sale purchase.
Request JSON
{
"request": {
"type": "sale",
"method": "create",
"is_pending": true,
"payment": {
"paypal": {
"paypal_transaction_id": "01A23456B789101112"
},
"payment_type": "paypal"
}
}
}Sale Create Check Direct
Example sale create object for physical check sales. Refer to the Sale Create request section above for additional properties, including required properties.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
Value should only be set to true if you are awaiting the check to arrive. Otherwise omit or set to false if already received physical check payment.
The payment object. In this example the payment type is physical check, therefore the payment type is set to "check_direct".
Value should be "check_direct" signifying that the payment is via physical check.
Request JSON
{
"request": {
"type": "sale",
"method": "create",
"payment": {
"payment_type": "check_direct"
}
}
}Sale Create Offline Payment
Example sale create object for offline payment sales. Refer to the Sale Create request section above for additional properties, including required properties.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The payment object. In this example the payment type is offline payment, therefore the payment type is set to "offline_payment".
Value should be "offline_payment" signifying that the payment is an offline payment, i.e. cash or other.
Request JSON
{
"request": {
"type": "sale",
"method": "create",
"payment": {
"payment_type": "offline_payment"
}
}
}Pending Sale
If you are utilizing upsells in your checkout process, the pending sale feature in RevCent can be extremely useful. A pending sale allows you to have RevCent store a sale, including any customer as well as payment information, without processing the payment. You can update the pending sale as many times as you wish and process the payment when ready using the saved payment information.
You also have the ability to have RevCent automatically process an abandoned sale using a pending sale profile. Read more about pending sales and pending sale profiles on our Knowledge Base . Note: A pending sale profile is not required when creating a pending sale, and is a feature solely meant for automatically processing abandoned carts.
Pending Sale Create
The request body is the same as a Sale Create call, except you include "is_pending: true" in the request. You can also omit properties normally required in a Sale Create call. You can add and/or update a pending sale before or when processing the final payment.
Note: The example request JSON is a simplified example and does not include all properties available. Please refer to the Sale Create section for full request JSON example and all properties that can be included in a pending sale create request, ignoring the returned properties as an pending sale create request returns a different response.
Note: You can include the credit card information when first creating the pending sale. RevCent will save the credit card information and attach it to the pending sales' customer. When you are ready to process the pending sale you do not need to include the credit card information as it is has been saved and will be used for the payment.
Note: You can include your own unique_request_id when creating a pending sale in order to reference the same pending sale in future updates or when processing the final payment. If you do not provide a unique_request_id in the create request, you can use the unique_request_id or RevCent sale_id in the pending sale create response for future updates or when processing the final payment.
Required: You must include "is_pending: true" property in the request.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.
ISO 4217 currency code. If not provided default is 'USD'.
You must include the is_pending property and set to true in order to create a pending sale.
If you wish to attach a unique ID to the pending sale so you can reference the pending sale in future updates or when processing the final payment. Once a sale has been created with a unique request ID you cannot use the same ID to create another separate sale.
An example unique_request_id would be a specific order ID in your shopping cart, that you will want to use in order to update or complete payment in the future.
The payment object is not required when creating a pending sale. However, if you do include the payment object, the payment information will be saved and attached to the pending sales' customer for future payment.
Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.
If payment is by credit card.
The credit card code as a string. Depending on the card type this can be different lengths.
The credit card number. This value must be a valid credit card number as a string.
The credit card expiration month. Two digit integer, MM.
The credit card expiration year. Two digit integer, YY.
If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.
If payment is by PayPal, and already processed by PayPal with a return transaction ID.
The PayPal transaction ID, provided by PayPal for the corresponding transaction.
PayPal payments are processed by PayPal and not RevCent, therefore RevCent needs the transaction ID to create a PayPal sale.
Default: false. RevCent verifies all PayPal transactions using the PayPal API before officially confirming the sale.
If payment is a physical check, not ACH or electronic.
If you wish to specify the mailing address for a customer to mail the physical check to. Useful when utilizing SMTP messages containing customer instructions.
If you wish to specify the pay to address for a customer to make the check out to. Useful when utilizing SMTP messages containing customer instructions.
If payment is in cash, etc., or it is necessary to create a sale without an actual payment type.
The customer object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details later.
If you are creating a pending sale for an existing customer. This value can be the RevCent customer ID or your internal customer ID.
The bill_to object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details when processing a payment.
If you wish to associate the sale with a third party shop provide the RevCent ID for the third party shop.
Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.
Use a payment profile for processing the item payment. This value can either be the RevCent payment profile ID or the custom payment profile name you created.
Your internal customer ID.
Your internal sale ID.
The product array contains individual product objects.
Pricing is automatically calculated based upon the quantity, price or both if present.
The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.
The price, if different from the product default price, you wish to charge.
The quantity. Default is 1.
Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.
Create a trial for the specific product being sold ending after the number of days provided.
To use as the shipping information. Any shipping entries created will use the ship_to object field.
If not present the customer object will be used.
The shipping array. Can contain multiple shipping objects.
Note: View our Provider Method Table for mapping provider and provider_method values for shipping object entries.
The shipping amount to charge.
Your shipping cost. This is for your internal purposes.
Shipping description.
Whether you wish to internally identify this as a free shipping item. This value will NOT be used to calculate any amounts. This if for your internal purposes. Default: false
Shipping name.
The shipping provider.
The shipping provider method.
The shipping provider tracking.
The tax array. Can contain multiple tax objects.
Tax amount to charge.
Tax description.
Tax name.
Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts
The coupon array. Can contain multiple coupon objects, each containing a coupon code.
The coupon code.
The discount array. Can contain multiple discount objects.
The actual discount value according to the discount type. Currently the discount value is a fixed amount, i.e. 5 will deduct the sale price by 5.
The discount type. Default: amount.
The discount name.
The discount description.
Response JSON Schema
The amount of the item.
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
The RevCent ID for the pending sale. You can use this to reference the pending sale in future updates or to process the final payment.
The unique request ID for the pending sale, either created by RevCent or supplied by you in the request. You can use this to reference the pending sale in future updates or to process the final payment.
Request JSON
{
"request": {
"type": "sale",
"method": "create",
"campaign": "Adwords Campaign",
"iso_currency": "USD",
"is_pending": true,
"unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5",
"customer": {
"first_name": "vqjh",
"last_name": "slszhjru",
"address_line_1": "1600 Pennsylvania Ave",
"address_line_2": "",
"city": "Washington",
"state": "DC",
"zip": "20500",
"country": "USA",
"company": "",
"email": "ctnb@gmail.com",
"phone": "1234567890"
},
"payment": {
"credit_card": {
"card_number": "4242424242424242",
"exp_month": 4,
"exp_year": 22,
"card_code": "000"
},
"payment_type": "credit_card"
},
"product": [
{
"id": "robo_vac",
"quantity": 1
}
]
}
}Response JSON
{
"amount": 34.99,
"api_call_id": "k6aGmwLkABi0822wnp67",
"api_call_processed": true,
"api_call_unix": 1613326956,
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"code": 1,
"customer_id": "6rKPj6nlXACJRKKd5nXa",
"payment_type": "Credit Card",
"request_method": "create",
"request_type": "sale",
"result": "Pending sale created.",
"sale_id": "0pKnzNPq54U2yvvzJwVY",
"unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
}Pending Sale Update
The request body will always be the same as a pending sale create call, except you include the unique_request_id, as well as "is_pending: true", to signify you are updating a previously created pending sale.
Note: The example request JSON is a simplified example and does not include all properties available. Please refer to the Sale Create section for full request JSON example and all properties that can be included in a pending sale update request, ignoring returned properties as an pending sale update request returns a different response.
Required: You must include "is_pending: true" property in the request.
Required: You must include the unique_request_id of the pending sales' initial response. If you omit the unique_request_id field, then RevCent will create a new pending sale, as there is no way to know which sale you are updating.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.
ISO 4217 currency code. If not provided default is 'USD'.
You must include the is_pending property and set to true in order to update a pending sale.
You must include the unique_request_id, or the RevCent sale_id, of the existing pending sale.
The product array contains individual product objects.
Pricing is automatically calculated based upon the quantity, price or both if present.
The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.
The price, if different from the product default price, you wish to charge.
The quantity. Default is 1.
Create a trial for the specific product being sold ending on a specific date. Also useful for starting a subscription on a specific date. Format must be MM/DD/YYYY.
Create a trial for the specific product being sold ending after the number of days provided.
When updating a pending sale you have options available that allow you to specify what actions occur given specific conditions.
The options for each request entity, in which to update the pending sale for existing entities.
What to do with product(s) submitted in the update in regards to product(s) already existing in the pending sale. I.e. Replace, skip, or merge line items already in a pending sale with line items submitted. Note: RevCent matches each product based on the "id" value submitted in the original request and update request.
Accepted values:
- replace
- Will remove all existing product(s) in the pending sale and replace with product(s) submitted in the request. I.e. Only product(s) submitted will be in the sale after update. Default
- skip
- Will leave existing product(s) in the sale and not add any new product(s) submitted. I.e. ignoring product(s) submitted. Useful when updating other parts of a pending sale such as payment information, discounts, etc.
- merge_replace
- Will add any new product(s) to the pending sale, keep existing product(s) in the sale and replace existing same ID product(s) with product(s) submitted. I.e. When you want to update a pending sale with new product(s) not already in the sale, keep all existing product(s) but replace same ID existing product(s) with submitted product(s).
- merge_skip
- Will add any new product(s) to the pending sale, and not remove or modify any product(s) which already exist in the sale. I.e. Add new product(s) to an existing sale without touching existing product(s).
- merge_combine
- Will add any new product(s) to the pending sale, keep existing product(s) in the sale, and combine the quantities of existing product(s) with submitted same ID product(s). I.e. Add any new product(s) to the pending sale, keep existing product(s) in the sale and incrementing submitted quantity with same ID existing product(s) quantity.
What to do if discounts already exists in the pending sale.
Accepted values:
- replace
- Will replace existing discounts with new discounts. Default
- skip
- Will skip if discounts exist.
What to do if shipping already exists in the pending sale.
Accepted values:
- replace
- Will replace existing shipping with new shipping. Default
- skip
- Will skip if shipping exists.
What to do if tax already exists in the pending sale.
Accepted values:
- replace
- Will replace existing tax with new tax. Default
- skip
- Will skip if tax exists.
The payment object is not required when creating a pending sale. However, if you do include the payment object, the payment information will be saved and attached to the pending sales' customer for future payment.
Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.
If payment is by credit card.
The credit card code as a string. Depending on the card type this can be different lengths.
The credit card number. This value must be a valid credit card number as a string.
The credit card expiration month. Two digit integer, MM.
The credit card expiration year. Two digit integer, YY.
If you wish to set the credit card as the default payment method for the customer. Default is true if customer has no active or unexpired cards on file.
If payment is by PayPal, and already processed by PayPal with a return transaction ID.
The PayPal transaction ID, provided by PayPal for the corresponding transaction.
PayPal payments are processed by PayPal and not RevCent, therefore RevCent needs the transaction ID to create a PayPal sale.
Default: false. RevCent verifies all PayPal transactions using the PayPal API before officially confirming the sale.
If payment is a physical check, not ACH or electronic.
If you wish to specify the mailing address for a customer to mail the physical check to. Useful when utilizing SMTP messages containing customer instructions.
If you wish to specify the pay to address for a customer to make the check out to. Useful when utilizing SMTP messages containing customer instructions.
If payment is in cash, etc., or it is necessary to create a sale without an actual payment type.
The customer object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details later.
If you are creating a pending sale for an existing customer. This value can be the RevCent customer ID or your internal customer ID.
The bill_to object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details when processing a payment.
If you wish to associate the sale with a third party shop provide the RevCent ID for the third party shop.
Use a specific gateway for processing the item payment. This value can either be the RevCent gateway ID or the custom gateway name you created.
Use a payment profile for processing the item payment. This value can either be the RevCent payment profile ID or the custom payment profile name you created.
Your internal customer ID.
Your internal sale ID.
To use as the shipping information. Any shipping entries created will use the ship_to object field.
If not present the customer object will be used.
The shipping array. Can contain multiple shipping objects.
Note: View our Provider Method Table for mapping provider and provider_method values for shipping object entries.
The shipping amount to charge.
Your shipping cost. This is for your internal purposes.
Shipping description.
Whether you wish to internally identify this as a free shipping item. This value will NOT be used to calculate any amounts. This if for your internal purposes. Default: false
Shipping name.
The shipping provider.
The shipping provider method.
The shipping provider tracking.
The tax array. Can contain multiple tax objects.
Tax amount to charge.
Tax description.
Tax name.
Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts
The coupon array. Can contain multiple coupon objects, each containing a coupon code.
The coupon code.
The discount array. Can contain multiple discount objects.
The actual discount value according to the discount type. Currently the discount value is a fixed amount, i.e. 5 will deduct the sale price by 5.
The discount type. Default: amount.
The discount name.
The discount description.
Response JSON Schema
The amount of the item.
The API call ID of the request. Every API request is assigned an ID.
Indicates whether the API call was processed.
The unix timestamp of when the API call was made.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
The result code for the request.
0 = RevCent Error
1 = Success
The RevCent ID of the customer.
The API request method.
The API request type.
The a brief description of the result of the API call.
The RevCent ID for the pending sale. You can use this to reference the pending sale in future updates or to process the final payment.
The unique request ID for the pending sale, either created by RevCent or supplied by you in the request. You can use this to reference the pending sale in future updates or to process the final payment.
Request JSON
{
"request": {
"type": "sale",
"method": "create",
"campaign": "Adwords Campaign",
"is_pending": true,
"unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5",
"product": [
{
"id": "robo_vac",
"quantity": 2
},
{
"id": "av_2017",
"quantity": 1
}
],
"pending_options": {
"exists_options": {
"product": "merge_combine",
"discount": "replace",
"shipping": "skip",
"tax": "replace"
}
}
}
}Response JSON
{
"amount": 75.7,
"api_call_id": "X82JQZYRyqUqajGypN9l",
"api_call_processed": true,
"api_call_unix": 1613349181,
"campaign_id": "mJ1zZoOobEuP8pnWKXd1",
"campaign_name": "Adwords Campaign",
"code": 1,
"customer_id": "6rKPj6nlXACJRKKd5nXa",
"payment_type": "Credit Card",
"request_method": "create",
"request_type": "sale",
"result": "Pending sale updated.",
"sale_id": "0pKnzNPq54U2yvvzJwVY",
"unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
}Pending Sale Process
Process a pending sale, i.e. charge credit card, using the sale create API call without including the "is_pending" property in the request. By not including the "is_pending" property, RevCent assumes that the sale is to be processed. Any payment methods submitted in the process request, or submitted previously while the sale is pending, will be used to process the payment of the pending sale.
Note: The example request JSON is a simplified example and does not include all properties available. Please refer to the Sale Create section for full request JSON example and all properties that can be included in a pending sale process request. The response JSON for pending sale process is omitted as it is the same that will be returned in the sale create response.
Note: If using a credit card payment type, you must include either the payment_profile or gateway property.
Required: Do not include "is_pending", or set "is_pending: false", in the pending sale process request to ensure that RevCent processes the payment and does not simply update the pending sale.
Required: You must include the unique_request_id of the pending sales' initial response. If you omit the unique_request_id field, then RevCent will create a new sale, as there is no way to know which pending sale you are processing.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.
ISO 4217 currency code. If not provided default is 'USD'.
Use a specific gateway for processing the pending sale. This value can either be the RevCent gateway ID or the custom gateway name you created. You can also use a payment profile instead of a gateway.
Use a payment profile for processing the pending sale. This value can either be the RevCent payment profile ID or the custom payment profile name you created. You can also use a gateway instead of a payment profile.
You must include the is_pending property and set to false in order to process a pending sale.
You must include the unique_request_id, or the RevCent sale_id, of the existing pending sale.
The product array contains individual product objects.
Pricing is automatically calculated based upon the quantity, price or both if present.
The ID for the product, this can be the RevCent ID, SKU, internal_id, product name or additional_id values.
The pric