RevCent API
The RevCent API is a REST based API. Current version is v1. All calls are performed via http POST, with JSON within the post 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".
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 a request object. The request object contains a type and method. This determines the actions that the specific request is going to perform.
In the example, the type is 'sale' and the method is 'retrieve'. Each type has specific methods as you will read below.
Example
Campaign
A campaign is created within the RevCent web app and is a way to group, categorize and filter various items within your account. New sale and new customer requests require a RevCent campaign ID in the request.
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
Response JSON
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
Response JSON
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.
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. Example below.
"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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
Customer Edit
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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
Your internal customer ID.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
Customer Enable
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The customer ID
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
Customer Disable
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The customer ID
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
Customer Add Card
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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
Customer Retrieve
Retrieve current information on a single customer or multiple customers.
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.
Whether the customer was created without first name and last name fields.
Whether the customer is currently blocked.
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.
An array of objects, each a credit 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
The last four digits of the credit card.
The expiration month and year as a string. MM/YY.
The credit card expiration month. Two digit integer, MM.
The credit card expiration year. Two digit integer, YY.
Whether the specific card is the default payment method for the customer.
An array containing discounts related to the item.
Whether the customer is enabled and available to purchase and make payments.
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.
Geocode latitude of customer if successfully geocoded.
Geocode longitude of customer if successfully geocoded.
The metadata array containing name:value objects.
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.
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
Response JSON
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
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
Response JSON
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.
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
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
Response JSON
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
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
Response JSON
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
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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
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.
The expiration month and year as a string. MM/YY.
The credit card expiration month. Two digit integer, MM.
The credit card expiration year. Two digit integer, YY.
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.
The metadata array containing name:value objects.
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
Response JSON
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
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
Response JSON
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
Response JSON
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
An array containing discounts related to the item.
The RevCent ID of the object item.
The metadata array containing name:value objects.
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
Response JSON
Pending Refund
All credit card transactions, paypal transactions, checks and offline payments create a pending refund when refunded. RevCent processes a pending refund once a credit card transaction has settled with the merchant gateway. For PayPal, offline and check direct payments, RevCent processes the pending refunds immediately.
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
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
Response JSON
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.
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.
Metadata specific to the product.
The name property for the metadata object.
The value property for the metadata object.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
Product Edit
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.
Metadata specific to the product.
The name property for the metadata object.
The value property for the metadata object.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
Product Enable
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product ID
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
Request JSON
Response JSON
Product Disable
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product ID
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
Request JSON
Response JSON
Product Delete
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The product ID
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
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.
Metadata specific to the product.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
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.
The metadata array containing name:value objects.
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
Response JSON
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' account. Send requests to retrieve a customers' balance, credit or debit the balance as well as retrieve ledger entries for a quota account.
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 without an existing quota account. Each quota account is specific to a customer and contains a running balance of one or more quota units within a 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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
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
Response JSON
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
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.
The metadata array containing name:value objects.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
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 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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
The RevCent ID of the object item.
The metadata array containing name:value objects.
The name property for the metadata object.
The value property for the metadata object.
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
Response JSON
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
Response JSON
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
Response JSON
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 specifying a payment type, which saves the sale information to be finalized later.
Sale Create
Create a sale using the sale create API call.
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. Example below.
"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 payment object. Multiple payment methods are accepted when creating a sale. However, each payment method has specific required fields.
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.
RevCent by default verifies all PayPal transactions using the PayPal API.
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.
Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.
If you wish to create the sale as pending, not processing any payments. Payments are manually processed via the web app.
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.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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 an idempotent request. This allows you to successfully retry a failed API call without risk of charging a customer twice.
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, your 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.
Metadata specific to the product being purchased.
The name property for the metadata object.
The value property for the metadata object.
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.
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
Metadata specific to the shipping item.
The name property for the metadata object.
The value property for the metadata object.
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.
Metadata specific to the tax item.
The name property for the metadata object.
The value property for the metadata object.
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.
Metadata specific to the discount. Useful for indicating discount code used, etc.
The name property for the metadata object.
The value property for the metadata object.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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
The customer object.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
The metadata array containing name:value objects.
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.
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.
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.
Request JSON
Response JSON
Sale Void
Voiding a sale will void all product sales, tax and shipping associated with the sale. Any subscriptions or trials created will be cancelled. The actual transactions associated with the sale will be refunded. Transactions that have yet to settle will be in a pending refund phase until it has settled. It is important to note that voiding a sale is irreversible.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The sale ID
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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.
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.
The RevCent ID of the sale.
Array containing IDs of each shipping refunded as a result of the request.
Array containing IDs of each subscription cancelled as a result of the request.
Array containing IDs of each tax refunded as a result of the request.
Array containing IDs of each trial cancelled as a result of the request.
Request JSON
Response JSON
Sale Estimate
Estimate the total cost with itemized results including products, shipping, tax, coupons and discounts.
The request object is the same as the the sale create request object, except the request method is "estimate" and not "create".
The response object contains detailed information that can be useful for displaying information to a customer during checkout, including how much the customer will save due to discounts.
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
To use as the billing information. If not present the customer object will be used.
The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.
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.
The RevCent ID of the customer.
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.
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.
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, your 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.
Metadata specific to the product being purchased.
The name property for the metadata object.
The value property for the metadata object.
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.
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
Metadata specific to the shipping item.
The name property for the metadata object.
The value property for the metadata object.
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.
Metadata specific to the tax item.
The name property for the metadata object.
The value property for the metadata object.
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.
Metadata specific to the discount. Useful for indicating discount code used, etc.
The name property for the metadata object.
The value property for the metadata object.
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
A breakdown of both valid and invalid coupons if one or more coupon codes are submitted in the request.
An array of valid coupons if one or more coupon codes are submitted in the request.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The coupon code submitted.
The ID of the coupon you created in RevCent.
The ID of the related coupon profile you created in RevCent.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The discount amount.
The discount percentage (discount_multiplier * 100) rounded to max two decimal places.
The discount multiplier, i.e. the mathematical number to apply to the total amount.
The discount value relative to the discount type.
The discount type relative to the discount value.
An array of invalid coupons if one or more coupon codes are submitted in the request.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The coupon code submitted.
An array of error messages as to why the coupon code is invalid.
Will list available coupons not submitted that can apply to the submitted estimate. Not yet implemented but coming in a future API update.
An array of individual discount items, which will be created if the sale is successfully processed.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The discount amount.
The discount percentage (discount_multiplier * 100) rounded to max two decimal places.
The discount multiplier, i.e. the mathematical number to apply to the total amount.
The discount value relative to the discount type.
The discount type relative to the discount value.
Whether the discount is a result of a coupon code or a static discount submitted.
If the discount is the result of a coupon, the coupon ID.
The unique ID of the coupon in the coupons array.
An array of product entries that the discount is being applied to if applicable.
The RevCent ID of the object item.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The discount amount.
The discount percentage (discount_multiplier * 100) rounded to max two decimal places.
The discount multiplier, i.e. the mathematical number to apply to the total amount.
The total amount the customer will pay for the specific product after the discount has been applied.
An array of shipping entries that the discount is being applied to if applicable.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The discount amount.
The discount percentage (discount_multiplier * 100) rounded to max two decimal places.
The discount multiplier, i.e. the mathematical number to apply to the total amount.
An array of individual product items, which will be created if the sale is successfully processed.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The ID of the product.
The name of the product.
The description of the product.
The product quantity.
The product price.
The total amount before any applicable discounts are applied.
Whether the product will created a trial.
If the product is a trial product, whether the product will ship immediately upon sale completion.
Whether the product is a free product.
An array of unique discount IDs that apply to the product.
The discount amount.
The discount percentage (discount_multiplier * 100) rounded to max two decimal places.
The discount multiplier, i.e. the mathematical number to apply to the total amount.
The total product amount after discounts are applied.
The maximum quantity of the product the customer is able to purchase based on product settings.
The API request method.
The API request type.
An array of individual shipping items, which will be created if the sale is successfully processed.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The individual shipping amount
An array of products which will be associated with the specific shipping item.
The product ID.
A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.
The product quantity.
The shipping provider.
The shipping provider method.
The total shipping amount after any discounts are applied.
An array of individual tax items, which will be created if the sale is successfully processed.
The calculated tax rate.
The total tax amount.
The totals object, containing the sum of all related products, shipping, discounts and tax. Ultimate amounts are based on any delayed trial amounts, which the customer will not pay immediately.
The total amount the customer will ultimately pay for all items including any discounts applied.
The total amount the customer will immediately pay upon initial sale purchase.
The breakdown of ultimate and immediate amounts for all products the customer will pay.
The ultimate amount the customer will pay for products.
The immediate amount the customer will pay for products before any applicable discounts are applied.
The immediate amount the customer will pay for products after any applicable discounts are applied.
The breakdown of ultimate and immediate amounts for all shipping the customer will pay.
The ultimate amount the customer will pay for shipping.
The immediate amount the customer will pay for shipping before any applicable discounts are applied.
The immediate amount the customer will pay for shipping after any applicable discounts are applied.
The breakdown of the total discount amount.
The immediate discount amount being applied to purchase.
The breakdown of ultimate and immediate amounts for all tax the customer will pay.
The ultimate amount the customer will pay for tax.
The immediate amount the customer will pay for tax.
Request JSON
Response JSON
Sale Retrieve
Retrieve current information on a single sale or multiple 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.
An array containing api call IDs related to the item.
The RevCent ID of the campaign.
The name of the campaign associated with the item.
If the sale was pending payment and ultimately cancelled without processing payment.
An array containing check direct IDs related to the item.
The unix timestamp of when the item was created.
The customer object.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
An array containing discounts related to the item.
The RevCent ID of the object item.
The discount type, either percent or amount.
The discount amount after all calculations.
The discount percent of the overall amount.
The coupon object.
The RevCent ID of the object item.
The name of the item.
The description of the item.
The coupon code.
The hosted endpoint related to the sale, if applicable.
The hosted endpoint ID.
The hosted endpoint name.
The hosted endpoint path.
The RevCent hosted page related to the sale, if applicable.
The RevCent hosted page ID.
The RevCent hosted page name.
The RevCent hosted page path.
The hosted page template related to the sale, if applicable.
The hosted page template ID.
The hosted page template name.
The hosted page visit related to the sale, if applicable.
The hosted page visit ID.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
If the item was created using a check_direct payment method.
If the sale is currently pending payment with a payment type of check_direct. I.e. waiting for check receipt before processing.
If the item was created using an offline payment method.
ISO 4217 currency code.
Whether the item was created using a live or test RevCent API key.
The metadata array containing name:value objects.
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.
The RevCent ID of the gateway.
Whether the item is enabled or disabled.
Whether the item is enabled or disabled.
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.
If the sale is currently pending payment.
An array containing pending refund IDs related to the item.
An array containing product sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
The ship to object.
An array containing shipping IDs related to the item.
The total amount of shipping for the related 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 total amount of tax for the related 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.
The RevCent tracking visitor related to the item, if TrackJS was initialized.
The tracking visitor ID.
An array containing credit card transaction IDs related to the item.
An array containing trial IDs related to the item.
The unique_request_id provided, or system generated, during the initial request creating 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
Response JSON
Salvage Transaction
A salvage transaction is a fully or partially declined credit card transaction. We save all submitted customer information regardless if a credit card transaction is declined.
Salvage Transaction Process
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The salvage transaction ID
The payment object. Contains the credit_card object. If not present the existing default payment method associated with the related customer will be used.
The credit_card object.
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.
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.
To use as the billing information. If not present the customer object will be used.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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 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
The RevCent ID of the customer.
Gateway related to the item.
The RevCent ID of the gateway.
The full response from the merchant gateway as a JSON string.
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 RevCent ID of the salvage transaction.
The RevCent ID of the credit card transaction.
Request JSON
Response JSON
Salvage Transaction Retrieve
Retrieve current information on a single salvage transaction or multiple salvage 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 successfully charged in the originating transaction.
The total calculated amount when an item is created.
The current amount of related salvage transactions not yet salvaged.
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
An array containing discounts related to the item.
Whether the salvage transaction is enabled, thus able to be processed.
The ID of the gateway which originated the salvage transaction
The name of the gateway which originated the salvage transaction
The RevCent ID of the object item.
Whether the item is related to a payment profile transaction.
Whether the item is related to a failed subscription renewal transaction.
Whether the item was created using a live or test RevCent API key.
Total number of salvage attempts.
An array containing offline payment IDs related to the item.
The payment profile related to the salvage transaction.
The payment profile ID to the salvage transaction.
The payment profile name to the salvage transaction.
Whether the payment profile resulted in a partial transaction or a full decline.
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 total amount of the sale associated with the salvage transaction, if applicable.
Whether the salvage transaction will create a new sale.
Whether the salvage transaction is part of an initial sale transaction.
An array containing sale IDs related to the item.
Whether the salvage transaction was successfully processed.
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 transaction ID of a successful salvage.
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
Response JSON
Shipping
A shipping is a completely isolated part of a sale. Each shipping is its own entity capable of separate transactions and tracking
Shipping Edit
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The shipping ID
A description of the shipping.
Indicated whether this is a free shipping item.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
The name of the item.
The shipping provider.
The shipping provider method.
The shipping provider tracking.
If you wish to modify the ship_to info.
Whether the shipment has been shipped.
Whether the shipment has been delivered.
Whether to send a notification to the customer upon modification. Useful when editing a shipping item as shipped and wishing to let the customer know. Default: false.
Deprecated.
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 shipping.
Request JSON
Response JSON
Shipping Refund
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The amount to refund. If not provided the entire shipping amount will be refunded.
The RevCent ID of the shipping.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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 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 RevCent ID of the shipping.
Request JSON
Response JSON
Shipping Retrieve
Retrieve current information on a single shipping item or multiple shipping items.
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.
Deprecated.
Any cost value provided when creating the shipping item.
The unix timestamp of when the item was created.
The customer object.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
The customer notification object provides information on if the customer was notified upon certain shipping events.
The customer object.
If the customer was notified when the item shipped.
If the customer was notified when the item was delivered.
The description of the item.
An array containing discounts related to the item.
The fulfillment account associated with the shipping item, if applicable.
The RevCent ID of the object item.
The name of the item.
The RevCent ID of the object item.
If the item was created using a check_direct payment method.
If the shipping item was delivered.
If the shipping item was indicated as free shipping when created.
If the item was created using an offline payment method.
Deprecated.
If the shipping item was shipped.
Whether the item was created using a live or test RevCent API key.
The metadata array containing name:value objects.
The name of 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.
Products detailed is an array of individual product objects, indicating the products which were contained in each shipping item.
The RevCent ID of the object item.
The name of the item.
The list price of the product.
The weighted price of the product compared to other products.
The sale price of the product.
The sale quantity of the product.
The total sale amount of the product. Price x Quantity.
The shipping provider.
The shipping provider delivered date.
The shipping provider method.
Deprecated.
The shipping provider tracking number or ID.
Whether there was an error when updating information about the shipping from the shipping provider, using the provider_tracking.
The last date in unix timestamp that RevCent acquired an update from the provider.
The latest response that RevCent received when requesting an update from the provider.
An array containing sale IDs related to the item.
An array containing salvage transaction IDs related to the item.
Indicates whether the customer will receive a notification for this shipping item.
The unix timestamp of when the shipping was shipped.
The ship to object.
The current shipping status.
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.
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.
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.
Deprecated.
The total number of result items for the given request.
The total number of pages for the given request.
Request JSON
Response JSON
Subscription
Subscriptions are automatically charged based on the subscription profile associated with a subscription. RevCent only supports credit card payment types for subscriptions at this time. RevCent automatically processes renewals, however you have the ability to manually process them as well.
Subscription Activate
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The subscription ID
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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 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 subscription.
The RevCent ID of the trial.
Request JSON
Response JSON
Subscription Suspend
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The subscription ID
Whether or not to refund the product sale related to the subscription. Default: false
Only applies if refund_product_sale = true. If you wish to specify the amount to refund. If the amount property is not present the entire product sale amount will be refunded.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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 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 subscription.
Request JSON
Response JSON
Subscription Cancel
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The subscription ID
Whether or not to refund the product sale related to the subscription. Default: false
Only applies if refund_product_sale = true. If you wish to specify the amount to refund. If the amount property is not present the entire product sale amount will be refunded.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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 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 subscription.
Request JSON
Response JSON
Subscription Renew
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The subscription ID
If you wish to specify an amount to renew. By default this is the subscription amount.
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.
If you wish to specify a payment profile for processing the renewal. Default is subscription profile setting.
If you wish to update the renewal schedule. Default: true.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
Response JSON Schema
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.
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
The customer object.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
The metadata array containing name:value objects.
The RevCent ID of the customer.
Gateway related to the item.
The RevCent ID of the gateway.
The full response from the merchant gateway as a JSON string.
The next subscription renewal date.
The next subscription renewal date in unix timestamp format.
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.
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 request.
The product quantity for the specific request.
The API request method.
The API request type.
The a brief description of the result of the API call.
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.
Whether the subscription schedule was updated as a result of the renewal.
The ship to object.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
The metadata array containing name:value objects.
An array of shipping items created. Each object is an individual shipping item containing details.
Brief details on the subscription.
Subscription ID.
Whether the subscription is overdue.
Whether the subscription has reached its occurrence limit.
The RevCent ID of the subscription.
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.
The RevCent ID of the subscription profile.
The RevCent ID of the subscription renewal.
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.
The RevCent ID of the credit card transaction.
Request JSON
Response JSON
Subscription Retrieve
Retrieve current information on a single subscription or multiple subscriptions.
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 billing object contains details on the last and next renewals.
The next renewal date.
The next renewal date in unix timestamp format.
The last renewal amount.
The last renewal date in unix timestamp format.
The last renewal ID.
The last renewal date.
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
An array containing discounts related to the item.
An array containing the next 10 renewal dates, or until occurrence limit.
The RevCent ID of the object item.
Whether the subscription is active.
Whether the subscription is cancelled.
Whether the subscription has reached its occurrence limit.
Whether the subscription has one or more overdue renewals.
Whether the subscription is suspended.
Whether the item was created using a live or test RevCent API key.
The metadata array containing name:value objects.
The total number of overdue renewals.
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.
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 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.
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.
The unix timestamp of when the subscription started.
An array containing tax IDs related to the item.
An array containing credit card transaction IDs related to the item.
If a trial is associated with the subscription, trial details are provided within the trial object.
The trial ID.
The trial start date.
The trial end date.
The trial start date as a unix timestamp.
The trial end date as a unix timestamp.
Whether the trial is still active.
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
Response JSON
Subscription Renewal
A subscription renewal is created when a renewal transaction occurs on a subscription, whether the transaction succeeds or fails. A failed renewal is considered overdue, however the subscription associated with it will continue to be processed. Partial or full declines on a subscription renewal will create a salvage transaction.
Subscription Renewal Refund
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The amount to refund. If not provided the entire item amount will be refunded.
The RevCent ID of the subscription renewal.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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 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 RevCent ID of the subscription renewal.
Request JSON
Response JSON
Subscription Renewal Retrieve
Retrieve current information on a single subscription renewal or multiple subscription renewals.
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 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 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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
An array containing discounts related to the item.
The RevCent ID of the object item.
Whether the subscription renewal is overdue. I.e. fully or partially declined.
Whether the item was created using a live or test RevCent API key.
The metadata array containing name:value objects.
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.
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 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.
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 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
Response JSON
Tax
Tax is created with when a tax entry is provided in a request or a tax profile matches the customer zip code. Tax profiles, when created and configured, will automatically calculate and create a tax for the customer payment.
Tax Refund
Request JSON Schema
The main request object
The type of request being made.
The method for the request type.
The amount to refund. If not provided the entire tax amount will be refunded.
The RevCent ID of the tax.
An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.
The name property for the metadata object.
The value property for the metadata object.
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 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 RevCent ID of the tax.
Request JSON
Response JSON
Tax Retrieve
Retrieve current information on a single tax entry or multiple tax entries.
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.
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.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The internal_id you provided when creating the item.
The description of the item.
An array containing discounts related to the item.
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.
The metadata array containing name:value objects.
The name of 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.
Tax rate calculated based on tax amount and total related item amount.
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.
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
Response JSON
Tracking
RevCent tracking integrates multiple tracking channels and sources. AdWords, TrackJs and hosted pages are all unique tracking channels.
AdWords
Implement your Google AdWords accounts within RevCent to receive detailed insight into your AdWords data in combination with RevCent data.
AdWords Campaign
AdWords campaign details.
AdWords Campaign Retrieve
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 object item.
Whether the item is enabled or disabled.
The unix timestamp of when the item was created.
Whether the item is enabled or disabled.
The RevCent ID of the object 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
Response JSON
Request JSON
Response JSON
AdWords Ad
AdWords ad details.
Request JSON
Response JSON
AdWords Keyword
AdWords keyword details.
AdWords Keyword Retrieve
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 object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The unix timestamp of when the item was created.
Whether the item is enabled or disabled.
The RevCent ID of the object 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
Response JSON
AdWords Click
AdWords click details.
AdWords Click Retrieve
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 object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The unix timestamp of when the item was created.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The RevCent ID of the object item.
The amount 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
Response JSON
AdWords Response Objects
When a retrieve response has an associated AdWords click ID, the AdWords response objects will be included in the response object(s). If a sale, product sale, tracking visitor, etc. has an AdWords click ID associated with it, RevCent will append each response object with additional details specific to the AdWords click ID.
Example: If a sale has an associated AdWords click ID, the sale retrieve response will include the AdWords response objects. If a sale does not have an AdWords click ID, the AdWords response objects will not be included.
Response JSON Schema
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
The RevCent ID of the object item.
Whether the item is enabled or disabled.
The RevCent ID of the object item.
Whether the item is enabled or disabled.