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.

Example

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


                            

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer

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.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip

metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.




bill_to

To use as the billing information. If not present the customer object will be used.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


internal_customer_id

Your internal customer ID.


campaign

The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.


payment

If you wish to add a payment method with the customer upon creation.


credit_card

card_number

The credit card number. This value must be a valid credit card number as a string.


exp_month

The credit card expiration month. Two digit integer, MM.


exp_year

The credit card expiration year. Two digit integer, YY.


card_code

The credit card code as a string. Depending on the card type this can be different lengths.


set_as_default

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.




metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


card_id

The RevCent ID of the customer credit card used if a transaction occurred.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_email

The email address of the related customer.


customer_first_name

The first name of the related customer.


customer_id

The RevCent ID of the customer.


customer_last_name

The last name of the related customer.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.

Request JSON

Response JSON

Customer Edit

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer_id

The customer ID


customer

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.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip

metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.




internal_customer_id

Your internal customer ID.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.

Request JSON

Response JSON

Customer Enable

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer_id

The customer ID


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.

Request JSON

Response JSON

Customer Disable

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer_id

The customer ID


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.

Request JSON

Response JSON

Customer Add Card

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer_id

The customer ID


bill_to

To use as the billing information. If not present the customer object will be used.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


payment

The payment object containing the credit card you wish to add.


credit_card

card_number

The credit card number. This value must be a valid credit card number as a string.


exp_month

The credit card expiration month. Two digit integer, MM.


exp_year

The credit card expiration year. Two digit integer, YY.


card_code

The credit card code as a string. Depending on the card type this can be different lengths.


set_as_default

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.




metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


request_method

The API request method.


request_type

The API request type.


result

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


address_line_1

address_line_2

anonymous

Whether the customer was created without first name and last name fields.


blocked

Whether the customer is currently blocked.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


city

company

country

created_date_unix

The unix timestamp of when the item was created.


customer_card

An array of objects, each a credit card associated with the customer.


created_date_unix

The unix timestamp of when the item was created.


updated_date_unix

The unix timestamp of when the item was updated.


id

The RevCent ID of the object item.


type

The credit card type


last_4

The last four digits of the credit card.


exp_date

The expiration month and year as a string. MM/YY.


exp_month

The credit card expiration month. Two digit integer, MM.


exp_year

The credit card expiration year. Two digit integer, YY.


is_default

Whether the specific card is the default payment method for the customer.



discounts

An array containing discount IDs related to the item.


email

enabled

Whether the customer is enabled and available to purchase and make payments.


first_name

full_address

geocode_success

True if customer address was submitted and geocoding was successful, otherwise false.


google_place_id

Google place ID of customer if successfully geocoded.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

Geocode latitude of customer if successfully geocoded.


lon

Geocode longitude of customer if successfully geocoded.


metadata

The metadata array containing name:value objects.


offline_payments

An array containing offline payment IDs related to the item.


paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


phone

product_sales

An array containing product sale IDs related to the item.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


state

state_long

subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.


zip


total_count

The total number of result items for the given request.


total_pages

The total number of pages for the given request.

Request JSON

Response JSON

Discount

A discount is created when RevCent recieves a discount entry during a request and is treated as its own entity for tracking and metrics purposes. In the future we will support integrated coupon codes and other discount methods.

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


description

The description of the item.


discount_amount

The total discount amount applied.


discount_percent

The percentage of total request amount before discount is applied.


discount_type

The discount type corresponds to discount amount. Default is amount.


id

The RevCent ID of the object item.


name

The name of the item.


offline_payments

An array containing offline payment IDs related to the item.


paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount

The amount of the item.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_number

The check number.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


id

The RevCent ID of the object item.


offline_payments

An array containing offline payment IDs related to the item.


paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


received

Whether the check has been received.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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 settlment.

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


transaction_id

The RevCent ID of the credit card transaction.


amount

The amount to refund. If not provided the entire transaction amount will be refunded.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


origin_campaign_id

The campaign ID of the transaction being refunded.


origin_customer_id

The customer ID of the transaction being refunded.


origin_sale_id

The sale ID of the transaction being refunded.


origin_transaction_id

The ID of the transaction being refunded.


pending_refund

Array containing IDs of each pending refund created as a result of the request.


product_sale_refunded

Array containing IDs of each product sale refunded as a result of the request.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


shipping_refunded

Array containing IDs of each shipping refunded as a result of the request.


tax_refunded

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount

The amount of the item.


amount_captured

The amount captured.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_refunded

Total amount of any refunds.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_settled

The current amount settled.


amount_total

The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).


amount_void

Total amount of any items that have been voided.


approved

Whether the transaction was approved.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


captured

Whether the transaction was captured.


check_directs

An array containing check direct IDs related to the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


customer_card

The customer credit card associated with the transaction.


created_date_unix

The unix timestamp of when the item was created.


updated_date_unix

The unix timestamp of when the item was updated.


id

The RevCent ID of the object item.


type

The credit card type


last_4

The last four digits of the credit card.


exp_date

The expiration month and year as a string. MM/YY.


exp_month

The credit card expiration month. Two digit integer, MM.


exp_year

The credit card expiration year. Two digit integer, YY.



declined

Whether the transaction was declined.


details_last_updated_unix

The unix timestamp of when RevCent requested details on the transaction status.


details_response

The latest response from the merchant gateway when RevCent requested details on the transaction status.


discounts

An array containing discount IDs related to the item.


error

Whether the transaction had an error.


gateway_id

The RevCent ID of the gateway.


gateway_name

The name of the gateway.


has_salvage

Whether the transaction has an associated salvage transaction.


held

Whether the transaction was held.


id

The RevCent ID of the object item.


is_payment_profile

Whether the transaction is part of a payment profile request.


is_refund

Whether the transaction is a refund transaction.


is_salvage

Whether the transaction is a salvage transaction.


is_subscription

Whether the transaction is a subscription transaction.


is_subscription_renewal

Whether the transaction is a subscription renewal transaction.


live_mode

Whether the item was created using a live or test RevCent API key.


metadata

The metadata array containing name:value objects.


offline_payments

An array containing offline payment IDs related to the item.


payment_profile

Payment profile related to the item.


id

The RevCent ID of the object item.


name

The name of the item.


results

An array of objects, each object being a unique item.



paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


result

The result of the transaction request.


sale_initial

Whether the transaction is an initial sale transaction.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


settled

Whether the transaction has been settled.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_profile

Details on the subscription profile associated with the subscription.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


occurrences

If the number of renewals allowed is specific or indefinite.


occurrences_value

If occurrences = specific, then the number of occurrence allowed.


subscription_specific

Whether the subscription profile is specific to a single subscription. I.e. customized.


subscription_id

If the subscription profile is specific to a single subscription, the subscription ID.


frequency

The frequency setting. Either unit, calendar or fiscal.


frequency_unit

The unit based frequency settings for the subscription profile.


unit_value

The frequency unit value.


unit

The frequency unit, i.e. days, weeks, months or years.



frequency_calendar

The calendar based frequency settings for the subscription profile.


calendar_unit

The calendar unit, i.e. The 2nd X of every month.


calendar_value

The calendar value, i.e. The X day of every month.


calendar_parent

The calendar parent, i.e. The 2nd day of every X



frequency_fiscal

The fiscal based frequency settings for the subscription profile.


fiscal_setting

The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.


fiscal_value

The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.


fiscal_unit

The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.




subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.


void

Whether the transaction is void.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount

The amount of the item.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


id

The RevCent ID of the object item.


paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


created_date_unix

The unix timestamp of when the item was created.


id

The RevCent ID of the object item.


paypal_account

The PayPal account you integrated with RevCent.


id

The RevCent ID of the object item.


name

The name of the item.


paypal_account_email

The email address within PayPal for this specific account.



paypal_details_response

The exact API response RevCent received regarding the PayPal dispute.


paypal_dispute_amount

The amount disputed, from paypal_details_response.


paypal_dispute_created_date

The date the dispute was created within PayPal, from paypal_details_response


paypal_dispute_created_date_unix

The unix timestamp of when the dispute was created within PayPal, from paypal_details_response


paypal_dispute_id

The PayPal dispute ID, from paypal_details_response


paypal_dispute_outcome

Dispute outcome, from paypal_details_response


paypal_dispute_updated_date

The date the dispute was last updated within PayPal, from paypal_details_response.


paypal_dispute_updated_date_unix

The unix timestamp of when the dispute was last updated within PayPal, from paypal_details_response.


paypal_messages

PayPal messages, from paypal_details_response.


posted_by

time_posted

content


paypal_reason

The dispute reason, from paypal_details_response.


paypal_status

The status within PayPal, from paypal_details_response.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount_captured

The amount captured.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_refunded

Total amount of any refunds.


amount_remaining

PayPal transactions do not receive an amount_remaining, as they are considered complete when created.


amount_settled

PayPal transactions do not receive an amount_settled, as they are considered complete when created.


amount_total

The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


id

The RevCent ID of the object item.


metadata

The metadata array containing name:value objects.


offline_payments

An array containing offline payment IDs related to the item.


paypal_account

The PayPal account you integrated with RevCent.


id

The RevCent ID of the object item.


name

The name of the item.


paypal_account_email

The email address within PayPal for this specific account.



paypal_customer_id

The customer ID within PayPal.


paypal_transaction_amount

The transaction amount within PayPal.


paypal_transaction_date

The transaction date within PayPal.


paypal_transaction_date_unix

The transaction unix timestamp within PayPal.


paypal_transaction_id

The PayPal transaction ID.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount

The amount of the item.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


gateway_id

The RevCent ID of the gateway.


gateway_name

The name of the gateway.


id

The RevCent ID of the object item.


is_check_direct

If the item was created using a check_direct payment method.


is_offline_payment

If the item was created using an offline payment method.


live_mode

Whether the item was created using a live or test RevCent API key.


offline_payments

An array containing offline payment IDs related to the item.


payment_type

The payment type related to the item.


id

The system ID of the payment type related to the item.


name

The system name of the payment type related to the item.



paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


processed

Whether the pending refund has been processed.


product_sales

An array containing product sale IDs related to the item.


refund_transaction_id

The credit card transaction ID being refunded.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


success_transaction_id

The credit card refund transaction ID.


tax

An array containing tax IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


product

The product object, containing the actual product and its attributes.


name

Product name.


description

Product description.


brand

Product brand. For upcoming search engine integration.


enabled

If the product is enabled, i.e. available for purchase.


is_child_product

If the product is a child product of a parent product.


parent_product

If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product


product_group

If you wish to contain the product within one or more RevCent product groups. Provide the RevCent ID(s) of each product group.


is_price_sale

If the product is currently on sale. For upcoming search engine integration.


price

Product price. Default price to be charged upon purchase.


price_trial

The product trial price. Price to charge when the trial ends, if different from initial sale price.


price_subscription

If the subscription renewal price if different from initial sale price


price_sale

If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.


stock

Current available stock. For upcoming search engine integration.


in_stock

If the product is currently in stock. For upcoming search engine integration.


cost

Product cost. For upcoming profit calculations.


msrp

Product MSRP. For upcoming search engine integration.


rating_value

The rating value of the product. For upcoming search engine integration.


review_count

The total number of reviews. For upcoming search engine integration.


condition

Product condition. For upcoming search engine integration.


internal_id

An internal ID for the product. Can be used as an identifier for sale creation


sku

Product SKU. Can be used as an identifier for sale creation.


upc

Product UPC. For upcoming search engine integration.


ean

Product EAN. For upcoming search engine integration.


isbn

Product ISBN. For upcoming search engine integration.


asin

Product ASIN. For upcoming search engine integration.


mpn

Product MPN. For upcoming search engine integration.


max_quantity_allowed

The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.


trial_days

Trial duration in days. This will create a trial for the product and not charge the customer until the trial ends.


trial_shipping_setting

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.


subscription_profile

If this is a subscription product, provide the ID of the subscription profile to use for recurring billing.


third_party_shop

If the product is specific to a third party shop provide the ID of the third party shop.


is_shippable

If the product is a shippable product. A shipping entry will be created when the product is sold.


shipping_attributes

Shipping attributes specific to the product.


weight

Product weight in lbs. For upcoming search engine and shipping cost integration.


length

Product length in inches. For upcoming search engine and shipping cost integration.


width

Product width in inches. For upcoming search engine and shipping cost integration.


height

Product height in inches. For upcoming search engine and shipping cost integration.


fulfillment_account

The fulfillment account for this product, if applicable.


rate

Deprecated.



additional_id

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.


name

A description of the ID, not used as the additional ID or identifier when creating a sale.


value

The actual additional ID, used to identify a specific product.



metadata

Metadata specific to the product.


name

The name property for the metadata object.


value

The value property for the metadata object.




metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


product_id

The RevCent ID of the product.


product_name

request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.

Request JSON

Response JSON

Product Edit

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


product_id

The product ID


product

The product object, containing the actual product and its attributes.


name

Product name.


description

Product description.


brand

Product brand. For upcoming search engine integration.


enabled

If the product is enabled, i.e. available for purchase.


is_child_product

If the product is a child product of a parent product.


parent_product

If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product


product_group

If you wish to contain the product within one or more RevCent product groups. Provide the RevCent ID(s) of each product group.


is_price_sale

If the product is currently on sale. For upcoming search engine integration.


price

Product price. Default price to be charged upon purchase.


price_trial

The product trial price. Price to charge when the trial ends, if different from initial sale price.


price_subscription

If the subscription renewal price if different from initial sale price


price_sale

If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.


stock

Current available stock. For upcoming search engine integration.


in_stock

If the product is currently in stock. For upcoming search engine integration.


cost

Product cost. For upcoming profit calculations.


msrp

Product MSRP. For upcoming search engine integration.


rating_value

The rating value of the product. For upcoming search engine integration.


review_count

The total number of reviews. For upcoming search engine integration.


condition

Product condition. For upcoming search engine integration.


internal_id

An internal ID for the product. Can be used as an identifier for sale creation


sku

Product SKU. Can be used as an identifier for sale creation.


upc

Product UPC. For upcoming search engine integration.


ean

Product EAN. For upcoming search engine integration.


isbn

Product ISBN. For upcoming search engine integration.


asin

Product ASIN. For upcoming search engine integration.


mpn

Product MPN. For upcoming search engine integration.


max_quantity_allowed

The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.


trial_days

Trial duration in days. This will create a trial for the product and not charge the customer until the trial ends.


trial_shipping_setting

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.


subscription_profile

If this is a subscription product, provide the ID of the subscription profile to use for recurring billing.


third_party_shop

If the product is specific to a third party shop provide the ID of the third party shop.


is_shippable

If the product is a shippable product. A shipping entry will be created when the product is sold.


shipping_attributes

Shipping attributes specific to the product.


weight

Product weight in lbs. For upcoming search engine and shipping cost integration.


length

Product length in inches. For upcoming search engine and shipping cost integration.


width

Product width in inches. For upcoming search engine and shipping cost integration.


height

Product height in inches. For upcoming search engine and shipping cost integration.


fulfillment_account

The fulfillment account for this product, if applicable.


rate

Deprecated.



additional_id

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.


name

A description of the ID, not used as the additional ID or identifier when creating a sale.


value

The actual additional ID, used to identify a specific product.



metadata

Metadata specific to the product.


name

The name property for the metadata object.


value

The value property for the metadata object.




metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


product_id

The RevCent ID of the product.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.

Request JSON

Response JSON

Product Enable

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


product_id

The product ID


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Request JSON

Response JSON

Product Disable

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


product_id

The product ID


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Request JSON

Response JSON

Product Delete

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


product_id

The product ID


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


product_id

The RevCent ID of the product.


request_method

The API request method.


request_type

The API request type.


result

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


additional_id

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.


name

A description of the ID, not used as the additional ID or identifier when creating a sale.


value

The actual additional ID, used to identify a specific product.



asin

Product ASIN. For upcoming search engine integration.


brand

Product brand. For upcoming search engine integration.


condition

Product condition. For upcoming search engine integration.


cost

Product cost. Will be used for future profit calculations.


created_date_unix

The unix timestamp of when the item was created.


description

Product description.


discount_rate

Deprecated.


ean

Product EAN. For upcoming search engine integration.


enabled

If the product is enabled, i.e. available for purchase.


id

The RevCent product ID.


images

Product images. For upcoming search engine integration.


images_url

Product images url. For upcoming search engine integration.


in_stock

If the product is currently in stock. For upcoming search engine integration.


internal_id

An internal ID for the product. Can be used as an identifier for sale creation


is_child_product

If the product is a child product of a parent product.


is_discount

Deprecated.


is_price_sale

If the product is currently on sale. For upcoming search engine integration.


is_shippable

If the product is a shippable product. A shipping entry will be created when the product is sold.


isbn

Product ISBN. For upcoming search engine integration.


max_quantity_allowed

The maximum allowed quantity of this product to be purchased in a single sale. 0 = No limit.


metadata

Metadata specific to the product.


name

The name property for the metadata object.


value

The value property for the metadata object.



mpn

Product MPN. For upcoming search engine integration.


msrp

Product MSRP. For upcoming search engine integration.


name

Product name.


parent_product

If the product is a child product, or variation, of a different product provide the RevCent ID for the parent product


price

Product price. Default price to be charged upon purchase.


price_sale

If the sale price if different from initial sale price and product is currently on sale. For upcoming search engine integration.


price_subscription

If the subscription renewal price if different from initial sale price


price_trial

The product trial price. Price to charge when the trial ends, if different from initial sale price.


product_group

If the product is contained within a product group, each product group will be displayed as an object.


id

Product group ID.


name

Product group name.



rating_value

The rating value of the product. For upcoming search engine integration.


review_count

The total number of reviews. For upcoming search engine integration.


shipping_attributes

Shipping attributes specific to the product.


weight

Product weight in lbs. For upcoming search engine and shipping cost integration.


length

Product length in inches. For upcoming search engine and shipping cost integration.


width

Product width in inches. For upcoming search engine and shipping cost integration.


height

Product height in inches. For upcoming search engine and shipping cost integration.


rate

Deprecated.


fulfillment_account

The fulfillment account for this product, if applicable.


id

The fulfillment account ID.


name

The fulfillment account name.



shipping_profile

Deprecated.



sku

Product SKU. Can be used as an identifier for sale creation.


stock

Current available stock. For upcoming search engine integration.


subscription_profile

Details on the subscription profile associated with the subscription.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


occurrences

If the number of renewals allowed is specific or indefinite.


occurrences_value

If occurrences = specific, then the number of occurrence allowed.


subscription_specific

Whether the subscription profile is specific to a single subscription. I.e. customized.


subscription_id

If the subscription profile is specific to a single subscription, the subscription ID.


frequency

The frequency setting. Either unit, calendar or fiscal.


frequency_unit

The unit based frequency settings for the subscription profile.


unit_value

The frequency unit value.


unit

The frequency unit, i.e. days, weeks, months or years.



frequency_calendar

The calendar based frequency settings for the subscription profile.


calendar_unit

The calendar unit, i.e. The 2nd X of every month.


calendar_value

The calendar value, i.e. The X day of every month.


calendar_parent

The calendar parent, i.e. The 2nd day of every X



frequency_fiscal

The fiscal based frequency settings for the subscription profile.


fiscal_setting

The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.


fiscal_value

The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.


fiscal_unit

The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.




third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



trial_days

Trial duration in days.


trial_shipping_setting

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.


upc

Product UPC. For upcoming search engine integration.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


product_sale_id

The product sale ID


amount

The amount to refund. If not provided or blank the entire product sale amount will be refunded.


cancel_sub_trial

Whether to cancel any subscription or trial associated with the product sale. Default is true.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


pending_refund

Array containing IDs of each pending refund created as a result of the request.


product_sale_id

The RevCent ID of the product sale.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


subscription_cancelled

An array of subscription IDs that were cancelled.


trial_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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount_captured

The amount captured.


amount_discounted

The total amount discounted.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_refunded

Total amount of any refunds.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_settled

The current amount settled.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


amount_total

The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).


amount_void

Total amount of any items that have been voided.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


live_mode

Whether the item was created using a live or test RevCent API key.


metadata

The metadata array containing name:value objects.


offline_payments

An array containing offline payment IDs related to the item.


payment_type

The payment type related to the item.


id

The system ID of the payment type related to the item.


name

The system name of the payment type related to the item.



paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.


price

The product price for the specific item.


quantity

The product quantity for the specific item.



sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


bill_to

To use as the billing information. If not present the customer object will be used.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


campaign

The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.


customer

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.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip

metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.




customer_id

If you are creating a sale for an existing customer. This value can be the RevCent customer ID or your internal customer ID.


unique_request_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.


third_party_shop

If you wish to associate the sale with a third party shop provide the RevCent ID for the third party shop.


gateway

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.


payment_profile

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.


internal_customer_id

Your internal customer ID.


internal_sale_id

Your internal sale ID.


payment

The payment object. Multiple payment methods are accepted when creating a sale. However, each payment method has specific required fields.


credit_card

If payment is by credit card.


card_code

The credit card code as a string. Depending on the card type this can be different lengths.


card_number

The credit card number. This value must be a valid credit card number as a string.


exp_month

The credit card expiration month. Two digit integer, MM.


exp_year

The credit card expiration year. Two digit integer, YY.


set_as_default

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.



paypal

If payment is by PayPal, and already processed by PayPal with a return transaction ID.


paypal_type

paypal_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.


paypal_account_id

force_transaction

RevCent by default verifies all PayPal transactions using the PayPal API.



check_direct

If payment is a physical check, not ACH or electronic.


check_number

mail_to_address

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.


first_name

last_name

address_line_1

address_line_2

city

company

state

zip

country


pay_to_address

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.


first_name

last_name

address_line_1

address_line_2

city

company

state

zip

country



offline

If payment is in cash, etc., or it is necessary to create a sale without an actual payment type.


offline_type


payment_type

Default: credit_card. If the payment is not credit_card you must specify the payment type. Options: check_direct, offline, paypal.


is_pending

If you wish to create the sale as pending, not processing any payments. Payments are manually processed via the web app.



product

The product array contains individual product objects.

Pricing is automatically calculated based upon the quantity, price or both if present.


id

The ID for the product, this can be the RevCent ID, your internal_id, product name or additional_id values.


price

The price, if different from the product default price, you wish to charge.


quantity

The quantity. Default is 1.


custom_trial_end_date

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.


custom_trial_days

Create a trial for the specific product being sold ending after the number of days provided.


metadata

Metadata specific to the product being purchased.


name

The name property for the metadata object.


value

The value property for the metadata object.




ship_to

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.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


shipping

The shipping array. Can contain multiple shipping objects.


amount

The shipping amount to charge.


cost

Your shipping cost. This is for your internal purposes.


description

Shipping description.


free_shipping

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

Metadata specific to the shipping item.


name

The name property for the metadata object.


value

The value property for the metadata object.



name

Shipping name.


provider

The shipping provider.


provider_method

The shipping provider method.


provider_tracking

The shipping provider tracking.



tax

The tax array. Can contain multiple tax objects.


amount

Tax amount to charge.


description

Tax description.


metadata

Metadata specific to the tax item.


name

The name property for the metadata object.


value

The value property for the metadata object.



name

Tax name.


rate

Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts



discount

The discount array. Can contain multiple discount objects.


discount_value

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.


discount_type

The discount type. Default: amount.


name

The discount name.


description

The discount description.


metadata

Metadata specific to the discount. Useful for indicating discount code used, etc.


name

The name property for the metadata object.


value

The value property for the metadata object.




metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


amount_captured

The amount captured.


amount_discounted

The total amount discounted.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


card_id

The RevCent ID of the customer credit card used if a transaction occurred.


code

The result code for the request.
0 = RevCent Error
1 = Success
2 = Merchant Declined
3 = Merchant Error
4 = Merchant Hold


customer

The customer object.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone

metadata

The metadata array containing name:value objects.



customer_id

The RevCent ID of the customer.


discount_created

An array of discounts created as a result of the request.


name

The name of the discount created.


description

The description of the discount created.


discount_amount

The total discount amount.


discount_percent

The percentage of the total.


id

The ID of the discount created.



gateway

Gateway related to the item.


gateway_id

The RevCent ID of the gateway.


gateway_raw_response

The full response from the merchant gateway as a JSON string.


internal_customer_id

Your internal customer ID.


internal_sale_id

Your internal sale ID.


payment_profile_results

If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.


payment_profile_id

The ID of the payment profile used.


original_amount

The original amount submitted in the request using the products, their prices and quantities.


final_amount

The final amount that was successfully charged after the payment profile was applied, if applicable.


successful_step_num

The step in the payment profile that ended in success, if applicable.


successful_gateway

The gateway that successfully processed the transaction, if applicable.


num_declined_transactions

The total number of declined transactions that occurred when the payment profile was processed.


declined_transaction_array

An array of IDs for declined transactions during the payment profile processing.


step_array

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.


step_action

The action taken during the step.


step_amount

The resulting step amount to be charged after any modifiers to payment amount.


step_cascade_result

If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.


cascade_order

The order of gateways used when processing the cascade.


enabled_gateways

The gateways which were enabled within the cascade for processing.


gateway_results

The results for each gateway validated within the cascade, after being passed or failed due to in place rules.


gateway_id

The ID of the gateway validated.


order

The order of the gateway within the cascade.


revenue_rules

Revenue rules validation result for the gateway.


enabled

If revenue rules were enabled for the gateway.


passed

If the gateway passed all revenue rules.


details

If revenue rules were present and enabled, the results of the revenue validation will be displayed here.



time_rules

Time rules validation result for the gateway.


enabled

If time rules were enabled for the gateway.


passed

If the gateway passed all time rules.


details

If time rules were present and enabled, the results of the time validation will be displayed here.



success

If the gateway passed all gateway validation requirements.



start_gateway

The ID of the gateway which was selected first for validation.



step_gateway

The name of gateway used to process the step transaction.


step_gateway_id

The ID of gateway used to process the step transaction.


step_gateway_response

The response returned by the gateway used to process the step transaction.


step_modifier

The modifier applied to the payment amount, if any.


step_num

The specific step number.


step_result

The result of the step transaction


step_setting

The step setting.


step_source

The step source, either gateway or cascade.


step_transaction

The ID of the step transaction.




product_sale_created

An array of product sales created. Each object is an individual product sale containing details.


amount_original_total

The total calculated amount when an item is created.


amount_captured

The amount captured.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


amount_discounted

The total amount discounted.


id

The RevCent ID of the object item.


price

The price of the product, either from product settings or if specific price provided in the request.


quantity

The quantity submitted in the request, or 1 if quantity was not provided.


product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.



subscription

Details if a subscription was created as a result of the product sale. Null if not applicable.


id

The RevCent ID of the object item.



trial

Details if a trial was created as a result of the product sale. Null if not applicable.


id

The RevCent ID of the object item.




request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


salvage_transaction

The salvage transaction details object, if created as a result of the request. Null if not applicable.


id

The RevCent ID of the object item.


amount

The salvage transaction amount.


enabled

If the salvage transaction is enabled.


sale_creator

If the salvage transaction will create a new sale.



salvage_transaction_created

If a salvage transaction was created as a result of the request.


ship_to

The ship to object.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone


shipping_created

An array of shipping items created. Each object is an individual shipping item containing details.


amount_original_total

The total calculated amount when an item is created.


amount_captured

The amount captured.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


amount_discounted

The total amount discounted.


id

The RevCent ID of the object item.


provider

The shipping provider.


provider_method

The shipping provider method.


provider_tracking

The shipping provider tracking if provided.


weight

Deprecated.



subscription_created

An array of subscriptions created. Each object is an individual subscription containing details.


id

The RevCent ID of the object item.


start_date_unix

The unix timestamp of when the subscription starts, either sale creation or when related trial is set to end.


next_renewal_date_unix

The unix timestamp of when the subscription next renews. Calcaulted on sale creation or null and ultimately calculated when trial ends.


product_sale

Details of the related product sale.


product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.



trial

Details if a trial was created related to the subscription. Null if not applicable.


id

The RevCent ID of the object item.




tax_created

An array of tax items created. Each object is an individual tax item containing details.


amount_original_total

The total calculated amount when an item is created.


amount_captured

The amount captured.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


rate

Tax rate calculated based on tax amount and total related item amount.



third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



transaction_id

The ID of the credit card transaction charged to create the sale, if applicable.


trial_created

An array of trials created. Each object is an individual trial containing details.


id

The RevCent ID of the object item.


num_days

The trial duration in number of days.


end_date_unix

The unix timestamp of when the trial is set to expire.


product_sale

Details of the related product sale.


id

The RevCent ID of the object item.



product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.



subscription

Details of any related subscription.


id

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


sale_id

The sale ID


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


pending_refund

Array containing IDs of each pending refund created as a result of the request.


product_sale_refunded

Array containing IDs of each product sale refunded as a result of the request.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


shipping_refunded

Array containing IDs of each shipping refunded as a result of the request.


subscription_cancelled

Array containing IDs of each subscription cancelled as a result of the request.


tax_refunded

Array containing IDs of each tax refunded as a result of the request.


trial_cancelled

Array containing IDs of each trial cancelled as a result of the request.

Request JSON

Response JSON

Sale Estimate

Estimate the total cost, including itemized results including products, shipping and tax.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


bill_to

To use as the billing information. If not present the customer object will be used.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


campaign

The campaign to associate with the request. This can be either the RevCent ID of the campaign or the RevCent name of the campaign.


customer

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.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


customer_id

The RevCent ID of the customer.


payment_profile

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.


gateway

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.


product

The product array contains individual product objects.

Pricing is automatically calculated based upon the quantity, price or both if present.


id

The ID for the product, this can be the RevCent ID, your internal_id, product name or additional_id values.


price

The price, if different from the product default price, you wish to charge.


quantity

The quantity. Default is 1.


custom_trial_end_date

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.


custom_trial_days

Create a trial for the specific product being sold ending after the number of days provided.


metadata

Metadata specific to the product being purchased.


name

The name property for the metadata object.


value

The value property for the metadata object.




ship_to

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.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


shipping

The shipping array. Can contain multiple shipping objects.


amount

The shipping amount to charge.


cost

Your shipping cost. This is for your internal purposes.


description

Shipping description.


free_shipping

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

Metadata specific to the shipping item.


name

The name property for the metadata object.


value

The value property for the metadata object.



name

Shipping name.


provider

The shipping provider.


provider_method

The shipping provider method.


provider_tracking

The shipping provider tracking.



tax

The tax array. Can contain multiple tax objects.


amount

Tax amount to charge.


description

Tax description.


metadata

Metadata specific to the tax item.


name

The name property for the metadata object.


value

The value property for the metadata object.



name

Tax name.


rate

Tax rate. This is for your internal purposes. This value will NOT be used to calculate any amounts



discount

The discount array. Can contain multiple discount objects.


discount_value

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.


discount_type

The discount type. Default: amount.


name

The discount name.


description

The discount description.


metadata

Metadata specific to the discount. Useful for indicating discount code used, etc.


name

The name property for the metadata object.


value

The value property for the metadata object.



Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


products

An array of individual product items, which will be created if the sale is successfully processed.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


quantity

The product quantity.


price

The product price.


total_amount

The total product amount.


total_amount_with_discount

The total product amount after discounts are applied.


max_quantity_allowed

The maximum quantity of the product the customer is able to purchase based on product settings.



request_method

The API request method.


request_type

The API request type.


shipping

An array of individual shipping items, which will be created if the sale is successfully processed.


amount

The individual shipping amount


products

An array of products which will be associated with the specific shipping item.


id

The RevCent ID of the object item.


quantity

The product quantity.


price

The product price.


list_price

The default list price in the product settings.


total_amount

The total amount being charged for the specific product based on quantity and price.


discount_amount

The total discount amount for the specific product.


discount_multiplier

The discount multiplier for the product.


discount_percent

The total percentage discount being applied to the specific product.


is_trial

If the product willl create a trial.


is_trial_ship_now

If the product will ship immediately even though it is a trial product.


is_free_product

If the product is calculated as 0.


is_shippable

If the product is shippable.


default_shipping_rate

Deprecated.


percent_of_shipping

The percentage of the total shipping item cost.



provider

The shipping provider.


provider_method

The shipping provider method.


total_amount_with_discount

The total shipping amount after any discounts are applied.



tax

An array of individual tax items, which will be created if the sale is successfully processed.


rate

The calculated tax rate.


amount

The total tax amount.



totals

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.


amount_total

The total amount the customer will ultimately pay for all items, trials included.


amount_bill_now

The total amount the customer will immediately pay upon initial sale purchase.


products

The breakdown of ultimate and immediate amounts for all products the customer will pay.


amount_total

The ultimate amount the customer will pay for products.


amount_bill_now

The immediate amount the customer will pay for products.



shipping

The breakdown of ultimate and immediate amounts for all shipping the customer will pay.


amount_total

The ultimate amount the customer will pay for shipping.


amount_bill_now

The immediate amount the customer will pay for shipping.



discount

The breakdown of the total discount amount.


amount_total

The immediate discount amount being applied to purchase.



tax

The breakdown of ultimate and immediate amounts for all tax the customer will pay.


amount_total

The ultimate amount the customer will pay for tax.


amount_bill_now

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount_captured

The amount captured.


amount_discounted

The total amount discounted.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_refunded

Total amount of any refunds.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_settled

The current amount settled.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


amount_total

The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).


amount_void

Total amount of any items that have been voided.


api_calls

An array containing api call IDs related to the item.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


cancelled

If the sale was pending payment and ultimately cancelled without processing payment.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


hosted_endpoint

The hosted endpoint related to the sale, if applicable.


id

The hosted endpoint ID.


name

The hosted endpoint name.


path

The hosted endpoint path.



hosted_page

The RevCent hosted page related to the sale, if applicable.


id

The RevCent hosted page ID.


name

The RevCent hosted page name.


path

The RevCent hosted page path.



hosted_page_template

The hosted page template related to the sale, if applicable.


id

The hosted page template ID.


name

The hosted page template name.



hosted_page_visit

The hosted page visit related to the sale, if applicable.


id

The hosted page visit ID.



id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


is_check_direct

If the item was created using a check_direct payment method.


is_check_direct_pending

If the sale is currently pending payment with a payment type of check_direct. I.e. waiting for check receipt before processing.


is_offline_payment

If the item was created using an offline payment method.


live_mode

Whether the item was created using a live or test RevCent API key.


metadata

The metadata array containing name:value objects.


offline_payments

An array containing offline payment IDs related to the item.


payment_profile

Payment profile related to the item.


id

The RevCent ID of the object item.


name

The name of the item.


results

An array of objects, each object being a unique item.


declined_transaction_array

final_amount

num_declined_transactions

original_amount

payment_profile_id

step_array

step_action

step_amount

step_cascade_result

cascade_order

enabled_gateways

gateway_results

gateway_id

The RevCent ID of the gateway.


order

revenue_rules

enabled

passed

details


success

time_rules

enabled

passed

details



start_gateway


step_gateway

step_gateway_id

step_gateway_response

step_modifier

step_num

step_result

step_setting

step_source

step_transaction


successful_gateway

successful_step_num



payment_type

The payment type related to the item.


id

The system ID of the payment type related to the item.


name

The system name of the payment type related to the item.



paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_payment

If the sale is currently pending payment.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


ship_to

The ship to object.


first_name

last_name

address_line_1

address_line_2

city

state

zip

country

company

email

phone


shipping

An array containing shipping IDs related to the item.


shipping_amount

The total amount of shipping for the related item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


tax_amount

The total amount of tax for the related item.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



tracking_visitor

The RevCent tracking visitor related to the item, if TrackJS was initialized.


id

The tracking visitor ID.



transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


unique_request_id

The unique_request_id provided, or system generated, during the initial request creating the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


salvage_transaction_id

The salvage transaction ID


payment

The payment object. Contains the credit_card object. If not present the existing default payment method associated with the related customer will be used.


credit_card

The credit_card object.


card_number

The credit card number. This value must be a valid credit card number as a string.


exp_month

The credit card expiration month. Two digit integer, MM.


exp_year

The credit card expiration year. Two digit integer, YY.


card_code

The credit card code as a string. Depending on the card type this can be different lengths.


set_as_default

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.




gateway

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.


bill_to

To use as the billing information. If not present the customer object will be used.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


card_id

The RevCent ID of the customer credit card used if a transaction occurred.


code

The result code for the request.
0 = RevCent Error
1 = Success
2 = Merchant Declined
3 = Merchant Error
4 = Merchant Hold


customer_id

The RevCent ID of the customer.


gateway

Gateway related to the item.


gateway_id

The RevCent ID of the gateway.


gateway_raw_response

The full response from the merchant gateway as a JSON string.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


salvage_transaction_id

The RevCent ID of the salvage transaction.


transaction_id

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount_charged

The amount successfully charged in the originating transaction.


amount_original_total

The total calculated amount when an item is created.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


enabled

Whether the salvage transaction is enabled, thus able to be processed.


gateway_id

The ID of the gateway which originated the salvage transaction


gateway_name

The name of the gateway which originated the salvage transaction


id

The RevCent ID of the object item.


is_payment_profile

Whether the item is related to a payment profile transaction.


is_subscription_renewal

Whether the item is related to a failed subscription renewal transaction.


live_mode

Whether the item was created using a live or test RevCent API key.


num_retries

Total number of salvage attempts.


offline_payments

An array containing offline payment IDs related to the item.


payment_profile

The payment profile related to the salvage transaction.


id

The payment profile ID to the salvage transaction.


name

The payment profile name to the salvage transaction.



payment_profile_partial

Whether the payment profile resulted in a partial transaction or a full decline.


paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


sale_amount_total

The total amount of the sale associated with the salvage transaction, if applicable.


sale_creator

Whether the salvage transaction will create a new sale.


sale_initial

Whether the salvage transaction is part of an initial sale transaction.


sales

An array containing sale IDs related to the item.


salvaged

Whether the salvage transaction was successfully processed.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


success_transaction_id

The transaction ID of a successful salvage.


tax

An array containing tax IDs related to the item.


transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


shipping_id

The shipping ID


description

A description of the shipping.


free_shipping

Indicated whether this is a free shipping item.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.



name

The name of the item.


provider

The shipping provider.


provider_method

The shipping provider method.


provider_tracking

The shipping provider tracking.


ship_to

If you wish to modify the ship_to info.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


shipped

Whether the shipment has been shipped.


delivered

Whether the shipment has been delivered.


send_notification

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.


weight

Deprecated.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


shipping_id

The RevCent ID of the shipping.

Request JSON

Response JSON

Shipping Refund

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


amount

The amount to refund. If not provided the entire shipping amount will be refunded.


shipping_id

The RevCent ID of the shipping.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


pending_refund

Array containing IDs of each pending refund created as a result of the request.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


shipping_id

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount_captured

The amount captured.


amount_discounted

The total amount discounted.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_refunded

Total amount of any refunds.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_settled

The current amount settled.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


amount_total

The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).


amount_void

Total amount of any items that have been voided.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


complete

Deprecated.


cost

Any cost value provided when creating the shipping item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


customer_notification

The customer notification object provides information on if the customer was notified upon certain shipping events.


customer

The customer object.


notified_shipped

If the customer was notified when the item shipped.


notified_delivered

If the customer was notified when the item was delivered.




description

The description of the item.


discounts

An array containing discount IDs related to the item.


fulfillment_account

The fulfillment account associated with the shipping item, if applicable.


id

The RevCent ID of the object item.


name

The name of the item.



id

The RevCent ID of the object item.


is_check_direct

If the item was created using a check_direct payment method.


is_delivered

If the shipping item was delivered.


is_free

If the shipping item was indicated as free shipping when created.


is_offline_payment

If the item was created using an offline payment method.


is_received

Deprecated.


is_shipped

If the shipping item was shipped.


live_mode

Whether the item was created using a live or test RevCent API key.


metadata

The metadata array containing name:value objects.


name

The name of the item.


offline_payments

An array containing offline payment IDs related to the item.


payment_type

The payment type related to the item.


id

The system ID of the payment type related to the item.


name

The system name of the payment type related to the item.



paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


products_detailed

Products detailed is an array of individual product objects, indicating the products which were contained in each shipping item.


id

The RevCent ID of the object item.


name

The name of the item.


list_price

The list price of the product.


percent_of_shipping

The weighted price of the product compared to other products.


price

The sale price of the product.


quantity

The sale quantity of the product.


total_amount

The total sale amount of the product. Price x Quantity.



provider

The shipping provider.


provider_delivered_date_unix

The shipping provider delivered date.


provider_method

The shipping provider method.


provider_received_date_unix

Deprecated.


provider_tracking

The shipping provider tracking number or ID.


provider_update_error

Whether there was an error when updating information about the shipping from the shipping provider, using the provider_tracking.


provider_update_last_unix

The last date in unix timestamp that RevCent acquired an update from the provider.


provider_update_response

The latest response that RevCent received when requesting an update from the provider.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


send_notification

Indicates whether the customer will receive a notification for this shipping item.


ship_date_unix

The unix timestamp of when the shipping was shipped.


ship_to

The ship to object.


first_name

last_name

address_line_1

address_line_2

city

state

zip

country

company

email

phone


shipping_status

The current shipping status.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


tax_rate

Tax rate calculated based on tax amount and total related item amount.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.


weight

Deprecated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


subscription_id

The subscription ID


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


subscription_id

The RevCent ID of the subscription.


trial_id

The RevCent ID of the trial.

Request JSON

Response JSON

Subscription Suspend

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


subscription_id

The subscription ID


refund_product_sale

Whether or not to refund the product sale related to the subscription. Default: false


amount

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.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


subscription_id

The RevCent ID of the subscription.

Request JSON

Response JSON

Subscription Cancel

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


subscription_id

The subscription ID


refund_product_sale

Whether or not to refund the product sale related to the subscription. Default: false


amount

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.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


subscription_id

The RevCent ID of the subscription.

Request JSON

Response JSON

Subscription Renew

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


subscription_id

The subscription ID


amount

If you wish to specify an amount to renew. By default this is the subscription amount.


gateway

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.


payment_profile

If you wish to specify a payment profile for processing the renewal. Default is subscription profile setting.


update_schedule

If you wish to update the renewal schedule. Default: true.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


amount_captured

The amount captured.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


card_id

The RevCent ID of the customer credit card used if a transaction occurred.


code

The result code for the request.
0 = RevCent Error
1 = Success
2 = Merchant Declined
3 = Merchant Error
4 = Merchant Hold


customer

The customer object.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone

metadata

The metadata array containing name:value objects.



customer_id

The RevCent ID of the customer.


gateway

Gateway related to the item.


gateway_id

The RevCent ID of the gateway.


gateway_raw_response

The full response from the merchant gateway as a JSON string.


next_renewal_date

The next subscription renewal date.


next_renewal_date_unix

The next subscription renewal date in unix timestamp format.


payment_profile_results

If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.


payment_profile_id

The ID of the payment profile used.


original_amount

The original amount submitted in the request using the products, their prices and quantities.


final_amount

The final amount that was successfully charged after the payment profile was applied, if applicable.


successful_step_num

The step in the payment profile that ended in success, if applicable.


successful_gateway

The gateway that successfully processed the transaction, if applicable.


num_declined_transactions

The total number of declined transactions that occurred when the payment profile was processed.


declined_transaction_array

An array of IDs for declined transactions during the payment profile processing.


step_array

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.


step_action

The action taken during the step.


step_amount

The resulting step amount to be charged after any modifiers to payment amount.


step_cascade_result

If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.


cascade_order

The order of gateways used when processing the cascade.


enabled_gateways

The gateways which were enabled within the cascade for processing.


gateway_results

The results for each gateway validated within the cascade, after being passed or failed due to in place rules.


gateway_id

The ID of the gateway validated.


order

The order of the gateway within the cascade.


revenue_rules

Revenue rules validation result for the gateway.


enabled

If revenue rules were enabled for the gateway.


passed

If the gateway passed all revenue rules.


details

If revenue rules were present and enabled, the results of the revenue validation will be displayed here.



time_rules

Time rules validation result for the gateway.


enabled

If time rules were enabled for the gateway.


passed

If the gateway passed all time rules.


details

If time rules were present and enabled, the results of the time validation will be displayed here.



success

If the gateway passed all gateway validation requirements.



start_gateway

The ID of the gateway which was selected first for validation.



step_gateway

The name of gateway used to process the step transaction.


step_gateway_id

The ID of gateway used to process the step transaction.


step_gateway_response

The response returned by the gateway used to process the step transaction.


step_modifier

The modifier applied to the payment amount, if any.


step_num

The specific step number.


step_result

The result of the step transaction


step_setting

The step setting.


step_source

The step source, either gateway or cascade.


step_transaction

The ID of the step transaction.




product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.


price

The product price for the specific request.


quantity

The product quantity for the specific request.



request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


salvage_transaction

The salvage transaction details object, if created as a result of the request. Null if not applicable.


id

The RevCent ID of the object item.


amount

The salvage transaction amount.


enabled

If the salvage transaction is enabled.


sale_creator

If the salvage transaction will create a new sale.



salvage_transaction_created

If a salvage transaction was created as a result of the request.


schedule_updated

Whether the subscription schedule was updated as a result of the renewal.


ship_to

The ship to object.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone

metadata

The metadata array containing name:value objects.



shipping_created

An array of shipping items created. Each object is an individual shipping item containing details.


subscription

Brief details on the subscription.


id

Subscription ID.


is_overdue

Whether the subscription is overdue.


is_occurrence_limit

Whether the subscription has reached its occurrence limit.



subscription_id

The RevCent ID of the subscription.


subscription_profile

Details on the subscription profile associated with the subscription.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


occurrences

If the number of renewals allowed is specific or indefinite.


occurrences_value

If occurrences = specific, then the number of occurrence allowed.


subscription_specific

Whether the subscription profile is specific to a single subscription. I.e. customized.


subscription_id

If the subscription profile is specific to a single subscription, the subscription ID.


frequency

The frequency setting. Either unit, calendar or fiscal.


frequency_unit

The unit based frequency settings for the subscription profile.


unit_value

The frequency unit value.


unit

The frequency unit, i.e. days, weeks, months or years.



frequency_calendar

The calendar based frequency settings for the subscription profile.


calendar_unit

The calendar unit, i.e. The 2nd X of every month.


calendar_value

The calendar value, i.e. The X day of every month.


calendar_parent

The calendar parent, i.e. The 2nd day of every X



frequency_fiscal

The fiscal based frequency settings for the subscription profile.


fiscal_setting

The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.


fiscal_value

The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.


fiscal_unit

The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.




subscription_profile_id

The RevCent ID of the subscription profile.


subscription_renewal_id

The RevCent ID of the subscription renewal.


tax_created

An array of tax items created. Each object is an individual tax item containing details.


amount_original_total

The total calculated amount when an item is created.


amount_captured

The amount captured.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


rate

Tax rate calculated based on tax amount and total related item amount.



transaction_id

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount

The amount of the item.


billing

The billing object contains details on the last and next renewals.


next_renewal_date

The next renewal date.


next_renewal_date_unix

The next renewal date in unix timestamp format.


last_renewal_amount

The last renewal amount.


last_renewal_date_unix

The last renewal date in unix timestamp format.


last_renewal_id

The last renewal ID.


last_renewal_date

The last renewal date.



campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


future_renewal_dates

An array containing the next 10 renewal dates, or until occurrence limit.


id

The RevCent ID of the object item.


is_active

Whether the subscription is active.


is_cancelled

Whether the subscription is cancelled.


is_occurrence_limit

Whether the subscription has reached its occurrence limit.


is_overdue

Whether the subscription has one or more overdue renewals.


is_suspended

Whether the subscription is suspended.


live_mode

Whether the item was created using a live or test RevCent API key.


metadata

The metadata array containing name:value objects.


num_overdue

The total number of overdue renewals.


offline_payments

An array containing offline payment IDs related to the item.


payment_type

The payment type related to the item.


id

The system ID of the payment type related to the item.


name

The system name of the payment type related to the item.



paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.


price

The product price for the specific item.


quantity

The product quantity for the specific item.



product_sales

An array containing product sale IDs related to the item.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_profile

Details on the subscription profile associated with the subscription.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


occurrences

If the number of renewals allowed is specific or indefinite.


occurrences_value

If occurrences = specific, then the number of occurrence allowed.


subscription_specific

Whether the subscription profile is specific to a single subscription. I.e. customized.


subscription_id

If the subscription profile is specific to a single subscription, the subscription ID.


frequency

The frequency setting. Either unit, calendar or fiscal.


frequency_unit

The unit based frequency settings for the subscription profile.


unit_value

The frequency unit value.


unit

The frequency unit, i.e. days, weeks, months or years.



frequency_calendar

The calendar based frequency settings for the subscription profile.


calendar_unit

The calendar unit, i.e. The 2nd X of every month.


calendar_value

The calendar value, i.e. The X day of every month.


calendar_parent

The calendar parent, i.e. The 2nd day of every X



frequency_fiscal

The fiscal based frequency settings for the subscription profile.


fiscal_setting

The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.


fiscal_value

The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.


fiscal_unit

The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.




subscription_renewals

An array containing subscription renewal IDs related to the item.


subscription_start_date_unix

The unix timestamp of when the subscription started.


tax

An array containing tax IDs related to the item.


transactions

An array containing credit card transaction IDs related to the item.


trial

If a trial is associated with the subscription, trial details are provided within the trial object.


id

The trial ID.


start_date

The trial start date.


end_date

The trial end date.


start_date_unix

The trial start date as a unix timestamp.


end_date_unix

The trial end date as a unix timestamp.


active

Whether the trial is still active.



trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


amount

The amount to refund. If not provided the entire item amount will be refunded.


subscription_renewal_id

The RevCent ID of the subscription renewal.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


pending_refund

Array containing IDs of each pending refund created as a result of the request.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


subscription_renewal_id

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount

The amount of the item.


amount_captured

The amount captured.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_refunded

Total amount of any refunds.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_settled

The current amount settled.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


amount_total

The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).


amount_void

Total amount of any items that have been voided.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


discounts

An array containing discount IDs related to the item.


id

The RevCent ID of the object item.


is_overdue

Whether the subscription renewal is overdue. I.e. fully or partially declined.


live_mode

Whether the item was created using a live or test RevCent API key.


metadata

The metadata array containing name:value objects.


offline_payments

An array containing offline payment IDs related to the item.


payment_profile

Payment profile related to the item.


id

The RevCent ID of the object item.


name

The name of the item.


results

An array of objects, each object being a unique item.


final_amount

num_declined_transactions

original_amount

payment_profile_id

step_array

step_action

step_amount

step_cascade_result

step_gateway

step_gateway_id

step_modifier

step_num

step_result

step_setting

step_source

step_transaction


successful_gateway

successful_step_num



payment_type

The payment type related to the item.


id

The system ID of the payment type related to the item.


name

The system name of the payment type related to the item.



paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.


price

The product price for the specific item.


quantity

The product quantity for the specific item.



product_sales

An array containing product sale IDs related to the item.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_profile

Details on the subscription profile associated with the subscription.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


occurrences

If the number of renewals allowed is specific or indefinite.


occurrences_value

If occurrences = specific, then the number of occurrence allowed.


subscription_specific

Whether the subscription profile is specific to a single subscription. I.e. customized.


subscription_id

If the subscription profile is specific to a single subscription, the subscription ID.


frequency

The frequency setting. Either unit, calendar or fiscal.


frequency_unit

The unit based frequency settings for the subscription profile.


unit_value

The frequency unit value.


unit

The frequency unit, i.e. days, weeks, months or years.



frequency_calendar

The calendar based frequency settings for the subscription profile.


calendar_unit

The calendar unit, i.e. The 2nd X of every month.


calendar_value

The calendar value, i.e. The X day of every month.


calendar_parent

The calendar parent, i.e. The 2nd day of every X



frequency_fiscal

The fiscal based frequency settings for the subscription profile.


fiscal_setting

The fiscal setting. Either standard or infrequent. If standard, then Quarterly or Yearly. If infrequent then fiscal_unit and fiscal_value determine schedule.


fiscal_value

The fiscal value when fiscal_setting = infrequent, i.e. every X quarter.


fiscal_unit

The fiscal unit when fiscal_setting = infrequent, i.e. every 2 X.




subscriptions

An array containing subscription IDs related to the item.


tax

An array containing tax IDs related to the item.


transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object


type

The type of request being made.


method

The method for the request type.


amount

The amount to refund. If not provided the entire tax amount will be refunded.


tax_id

The RevCent ID of the tax.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer_id

The RevCent ID of the customer.


pending_refund

Array containing IDs of each pending refund created as a result of the request.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


tax_id

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


amount_captured

The amount captured.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_refunded

Total amount of any refunds.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_settled

The current amount settled.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


amount_total

The current total amount after any refunds, cancellations or other changes. Equals amount_original_total - (amount_void + amount_refunded).


amount_void

Total amount of any items that have been voided.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


check_directs

An array containing check direct IDs related to the item.


created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

address_line_2

blocked

city

company

country

email

enabled

first_name

full_address

geocode_success

google_place_id

id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


last_name

lat

lon

phone

state

state_long

zip


description

The description of the item.


discounts

An array containing discount IDs related to the item.


id

The RevCent ID of the object item.


is_check_direct

If the item was created using a check_direct payment method.


is_offline_payment

If the item was created using an offline payment method.


live_mode

Whether the item was created using a live or test RevCent API key.


metadata

The metadata array containing name:value objects.


name

The name of the item.


offline_payments

An array containing offline payment IDs related to the item.


payment_type

The payment type related to the item.


id

The system ID of the payment type related to the item.


name

The system name of the payment type related to the item.



paypal_transactions

An array containing RevCent PayPal transaction IDs related to the item.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


rate

Tax rate calculated based on tax amount and total related item amount.


sales

An array containing sale IDs related to the item.


salvage_transactions

An array containing salvage transaction IDs related to the item.


shipping

An array containing shipping IDs related to the item.


smtp_messages

An array containing SMTP message IDs related to the item.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


subscriptions

An array containing subscription IDs related to the item.


third_party_shop

Will contain details if the root item is related to a third party shop.


id

The RevCent ID of the object item.


name

The name of the item.


shop_url

The URL of the third party shop.



transactions

An array containing credit card transaction IDs related to the item.


trials

An array containing trial IDs related to the item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


adwords_customer

id

The RevCent ID of the object item.


enabled

google_adwords_customer_id


created_date_unix

The unix timestamp of when the item was created.


enabled

google_adwords_advertising_channel_sub_type

google_adwords_advertising_channel_type

google_adwords_amount

google_adwords_bidding_strategy_id

google_adwords_bidding_strategy_name

google_adwords_bidding_strategy_type

google_adwords_campaign_desktop_bid_modifier

google_adwords_campaign_group_id

google_adwords_campaign_id

google_adwords_campaign_mobile_bid_modifier

google_adwords_campaign_name

google_adwords_campaign_status

google_adwords_campaign_tablet_bid_modifier

google_adwords_campaign_trial_type

google_adwords_customer_id

google_adwords_data_date_unix

google_adwords_end_date

google_adwords_enhanced_cpc_enabled

google_adwords_is_budget_explicitly_shared

google_adwords_label_ids

google_adwords_labels

google_adwords_latest_date_unix

google_adwords_maximize_conversion_value_target_roas

google_adwords_period

google_adwords_serving_status

google_adwords_total_amount

google_adwords_tracking_url_template

google_adwords_url_custom_parameters

id

The RevCent ID of the object item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

The total number of pages for the given request.

Request JSON

Response JSON

AdWords Ad Group

AdWords ad group details.

AdWords Ad Group Retrieve

Request JSON Schema


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


adwords_campaign

id

The RevCent ID of the object item.


enabled

google_adwords_campaign_id


adwords_customer

id

The RevCent ID of the object item.


enabled

google_adwords_customer_id


created_date_unix

The unix timestamp of when the item was created.


enabled

google_adwords_ad_group_desktop_bid_modifier

google_adwords_ad_group_id

google_adwords_ad_group_mobile_bid_modifier

google_adwords_ad_group_name

google_adwords_ad_group_status

google_adwords_ad_group_tablet_bid_modifier

google_adwords_ad_group_type

google_adwords_ad_rotation_mode

google_adwords_bidding_strategy_id

google_adwords_bidding_strategy_name

google_adwords_bidding_strategy_source

google_adwords_bidding_strategy_type

google_adwords_campaign_id

google_adwords_content_bid_criterion_type_group

google_adwords_cpc_bid

google_adwords_cpm_bid_str

google_adwords_cpv_bid

google_adwords_customer_id

google_adwords_data_date_unix

google_adwords_effective_targeting_roas

google_adwords_effective_targeting_roas_source

google_adwords_enhanced_cpc_enabled

google_adwords_label_ids

google_adwords_labels

google_adwords_latest_date_unix

google_adwords_target_cpa

google_adwords_target_cpa_bid_source

google_adwords_tracking_url_template

google_adwords_url_custom_parameters

id

The RevCent ID of the object item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

The total number of pages for the given request.

Request JSON

Response JSON

AdWords Ad

AdWords ad details.

AdWords Ad Retrieve

Request JSON Schema


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


adwords_ad_group

id

The RevCent ID of the object item.


enabled

google_adwords_ad_group_id


adwords_campaign

id

The RevCent ID of the object item.


enabled

google_adwords_campaign_id


adwords_customer

id

The RevCent ID of the object item.


enabled

google_adwords_customer_id


created_date_unix

The unix timestamp of when the item was created.


enabled

google_adwords_accent_color

google_adwords_ad_group_id

google_adwords_ad_type

google_adwords_allow_flexible_color

google_adwords_automated

google_adwords_business_name

google_adwords_call_only_phone_number

google_adwords_call_to_action_text

google_adwords_campaign_id

google_adwords_combined_approval_status

google_adwords_creative_destination_url

google_adwords_creative_final_app_urls

google_adwords_creative_final_mobile_urls

google_adwords_creative_final_urls

google_adwords_creative_id

google_adwords_creative_tracking_url_template

google_adwords_creative_url_custom_parameters

google_adwords_customer_id

google_adwords_data_date_unix

google_adwords_description

google_adwords_description_1

google_adwords_description_2

google_adwords_device_preference

google_adwords_display_url

google_adwords_enhanced_display_creative_landscape_logo_image_media_id

google_adwords_enhanced_display_creative_logo_image_media_id

google_adwords_enhanced_display_creative_marketing_image_media_id

google_adwords_enhanced_display_creative_marketing_image_square_media_id

google_adwords_format_setting

google_adwords_gmail_creative_header_image_media_id

google_adwords_gmail_creative_logo_image_media_id

google_adwords_gmail_creative_marketing_image_media_id

google_adwords_gmail_teaser_business_name

google_adwords_gmail_teaser_description

google_adwords_gmail_teaser_headline

google_adwords_headline

google_adwords_headline_part_1

google_adwords_headline_part_2

google_adwords_image_ad_url

google_adwords_image_creative_image_height

google_adwords_image_creative_image_width

google_adwords_image_creative_mime_type

google_adwords_image_creative_name

google_adwords_label_ids

google_adwords_labels

google_adwords_latest_date_unix

google_adwords_long_headline

google_adwords_main_color

google_adwords_marketing_image_call_to_action_text

google_adwords_marketing_image_call_to_action_text_color

google_adwords_marketing_image_description

google_adwords_marketing_image_headline

google_adwords_path_1

google_adwords_path_2

google_adwords_price_prefix

google_adwords_promo_text

google_adwords_responsive_search_ad_descriptions

google_adwords_responsive_search_ad_headlines

google_adwords_responsive_search_ad_path_1

google_adwords_responsive_search_ad_path_2

google_adwords_short_headline

google_adwords_status

google_adwords_system_managed_entity_source

id

The RevCent ID of the object item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

The total number of pages for the given request.

Request JSON

Response JSON

AdWords Keyword

AdWords keyword details.

AdWords Keyword Retrieve

Request JSON Schema


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


adwords_ad_group

id

The RevCent ID of the object item.


enabled

google_adwords_ad_group_id


adwords_campaign

id

The RevCent ID of the object item.


enabled

google_adwords_campaign_id


adwords_customer

id

The RevCent ID of the object item.


enabled

google_adwords_customer_id


created_date_unix

The unix timestamp of when the item was created.


enabled

google_adwords_ad_group_id

google_adwords_approval_status

google_adwords_bidding_strategy_id

google_adwords_bidding_strategy_name

google_adwords_bidding_strategy_source

google_adwords_bidding_strategy_type

google_adwords_campaign_id

google_adwords_cpc_bid

google_adwords_cpc_bid_source

google_adwords_cpm_bid_str

google_adwords_creative_quality_score

google_adwords_criteria

google_adwords_criteria_destination_url

google_adwords_criterion_id

google_adwords_customer_id

google_adwords_data_date_unix

google_adwords_enhanced_cpc_enabled

google_adwords_estimated_add_clicks_at_first_position_cpc

google_adwords_estimated_add_cost_at_first_position_cpc

google_adwords_first_page_cpc

google_adwords_first_position_cpc

google_adwords_has_quality_score

google_adwords_is_negative

google_adwords_keyword_match_type

google_adwords_label_ids

google_adwords_labels

google_adwords_latest_date_unix

google_adwords_post_click_quality_score

google_adwords_quality_score

google_adwords_search_predicted_ctr

google_adwords_status

google_adwords_system_serving_status

google_adwords_top_of_page_cpc

google_adwords_tracking_url_template

google_adwords_url_custom_parameters

google_adwords_verticle_id

id

The RevCent ID of the object item.


updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

The total number of pages for the given request.

Request JSON

Response JSON

AdWords Click

AdWords click details.

AdWords Click Retrieve

Request JSON Schema


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


adwords_ad

id

The RevCent ID of the object item.


enabled

google_adwords_creative_id


adwords_ad_group

id

The RevCent ID of the object item.


enabled

google_adwords_ad_group_id

google_adwords_ad_group_name


adwords_campaign

id

The RevCent ID of the object item.


enabled

google_adwords_campaign_id

google_adwords_campaign_name


adwords_customer

id

The RevCent ID of the object item.


enabled

google_adwords_customer_id


adwords_keyword

id

The RevCent ID of the object item.


enabled


created_date_unix

The unix timestamp of when the item was created.


enabled

google_adwords_account_descriptive_name

google_adwords_ad_format

google_adwords_ad_id

google_adwords_ad_network_type1

google_adwords_ad_network_type2

google_adwords_aoi_city_criteria_id

google_adwords_aoi_country_criteria_id

google_adwords_aoi_metro_criteria_id

google_adwords_aoi_most_specific_target_id

google_adwords_aoi_region_criteria_id

google_adwords_campaign_location_target_id

google_adwords_click_date

google_adwords_click_date_unix

google_adwords_click_id

google_adwords_click_type

google_adwords_clicks

google_adwords_criteria_parameters

google_adwords_customer_id

google_adwords_data_date_unix

google_adwords_device

google_adwords_keyword_id

google_adwords_keyword_match_type

google_adwords_latest_date_unix

google_adwords_lop_city_criteria_id

google_adwords_lop_country_criteria_id

google_adwords_lop_metro_criteria_id

google_adwords_lop_most_specific_target_id

google_adwords_lop_region_criteria_id

google_adwords_month_of_year

google_adwords_page

google_adwords_slot

google_adwords_user_list_id

id

The RevCent ID of the object item.


sale

id

The RevCent ID of the object item.


amount

The amount of the item.



updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

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


adwords_ad

id

The RevCent ID of the object item.


enabled

google_adwords_latest_date

google_adwords_latest_date_unix

google_adwords_data_date

google_adwords_data_date_unix

google_adwords_customer_id

google_adwords_ad_group_id

google_adwords_creative_id

google_adwords_campaign_id

google_adwords_ad_type

google_adwords_combined_approval_status

google_adwords_display_url

google_adwords_long_headline

google_adwords_headline

google_adwords_short_headline

google_adwords_description

google_adwords_price_prefix

google_adwords_promo_text

google_adwords_status

google_adwords_labels

google_adwords_label_ids

google_adwords_enhanced_display_creative_landscape_logo_image_media_id

google_adwords_enhanced_display_creative_logo_image_media_id

google_adwords_enhanced_display_creative_marketing_image_media_id

google_adwords_enhanced_display_creative_marketing_image_square_media_id

google_adwords_gmail_teaser_headline

google_adwords_gmail_teaser_description

google_adwords_gmail_teaser_business_name

google_adwords_gmail_creative_header_image_media_id

google_adwords_gmail_creative_logo_image_media_id

google_adwords_gmail_creative_marketing_image_media_id

google_adwords_marketing_image_call_to_action_text

google_adwords_marketing_image_call_to_action_text_color

google_adwords_marketing_image_headline

google_adwords_marketing_image_description

google_adwords_accent_color

google_adwords_business_name

google_adwords_call_to_action_text

google_adwords_call_only_phone_number

google_adwords_creative_destination_url

google_adwords_creative_final_app_urls

google_adwords_creative_final_mobile_urls

google_adwords_creative_final_urls

google_adwords_creative_tracking_url_template

google_adwords_creative_url_custom_parameters

google_adwords_format_setting

google_adwords_image_ad_url

google_adwords_image_creative_image_height

google_adwords_image_creative_image_width

google_adwords_image_creative_mime_type

google_adwords_image_creative_name

google_adwords_main_color

google_adwords_responsive_search_ad_descriptions

google_adwords_responsive_search_ad_headlines

google_adwords_system_managed_entity_source

google_adwords_device_preference

google_adwords_allow_flexible_color

google_adwords_automated


adwords_ad_group

id

The RevCent ID of the object item.


enabled

google_adwords_latest_date

google_adwords_latest_date_unix

google_adwords_data_date

google_adwords_data_date_unix

google_adwords_customer_id

google_adwords_campaign_id

google_adwords_ad_group_id

google_adwords_ad_group_name

google_adwords_ad_group_status

google_adwords_ad_group_type

google_adwords_ad_rotation_mode

google_adwords_bidding_strategy_name

google_adwords_bidding_strategy_id

google_adwords_bidding_strategy_source

google_adwords_bidding_strategy_type

google_adwords_target_cpa

google_adwords_target_cpa_bid_source

google_adwords_tracking_url_template

google_adwords_url_custom_parameters

google_adwords_content_bid_criterion_type_group

google_adwords_cpm_bid_str

google_adwords_cpc_bid

google_adwords_cpv_bid

google_adwords_labels

google_adwords_label_ids

google_adwords_ad_group_mobile_bid_modifier

google_adwords_ad_group_desktop_bid_modifier

google_adwords_ad_group_tablet_bid_modifier

google_adwords_enhanced_cpc_enabled


adwords_campaign

id

The RevCent ID of the object item.


enabled

google_adwords_latest_date

google_adwords_latest_date_unix

google_adwords_data_date

google_adwords_data_date_unix

google_adwords_customer_id

google_adwords_campaign_id

google_adwords_campaign_group_id

google_adwords_campaign_name

google_adwords_campaign_status

google_adwords_campaign_trial_type

google_adwords_tracking_url_template

google_adwords_url_custom_parameters

google_adwords_advertising_channel_type

google_adwords_advertising_channel_sub_type

google_adwords_bidding_strategy_id

google_adwords_bidding_strategy_type

google_adwords_bidding_strategy_name

google_adwords_period

google_adwords_serving_status

google_adwords_total_amount

google_adwords_labels

google_adwords_label_ids

google_adwords_maximize_conversion_value_target_roas

google_adwords_campaign_tablet_bid_modifier

google_adwords_campaign_mobile_bid_modifier

google_adwords_campaign_desktop_bid_modifier

google_adwords_amount

google_adwords_enhanced_cpc_enabled

google_adwords_is_budget_explicitly_shared

google_adwords_end_date


adwords_click

id

The RevCent ID of the object item.


google_adwords_latest_date

google_adwords_latest_date_unix

google_adwords_data_date

google_adwords_data_date_unix

google_adwords_aoi_city_criteria_id

google_adwords_aoi_country_criteria_id

google_adwords_aoi_metro_criteria_id

google_adwords_aoi_most_specific_target_id

google_adwords_aoi_region_criteria_id

google_adwords_campaign_location_target_id

google_adwords_lop_city_criteria_id

google_adwords_lop_country_criteria_id

google_adwords_lop_metro_criteria_id

google_adwords_lop_most_specific_target_id

google_adwords_lop_region_criteria_id

google_adwords_user_list_id

google_adwords_account_descriptive_name

google_adwords_ad_format

google_adwords_ad_network_type1

google_adwords_ad_network_type2

google_adwords_click_type

google_adwords_clicks

google_adwords_criteria_parameters

google_adwords_device

google_adwords_keyword_match_type

google_adwords_month_of_year

google_adwords_page

google_adwords_slot

google_adwords_customer_id

google_adwords_ad_id

google_adwords_keyword_id

google_adwords_click_id

google_adwords_click_date


adwords_customer

id

The RevCent ID of the object item.


enabled

google_adwords_customer_id


adwords_keyword

id

The RevCent ID of the object item.


enabled

google_adwords_latest_date

google_adwords_latest_date_unix

google_adwords_data_date

google_adwords_data_date_unix

google_adwords_customer_id

google_adwords_ad_group_id

google_adwords_campaign_id

google_adwords_criterion_id

google_adwords_bidding_strategy_id

google_adwords_bidding_strategy_name

google_adwords_bidding_strategy_source

google_adwords_bidding_strategy_type

google_adwords_cpc_bid

google_adwords_cpc_bid_source

google_adwords_cpm_bid_str

google_adwords_approval_status

google_adwords_criteria

google_adwords_criteria_destination_url

google_adwords_quality_score

google_adwords_creative_quality_score

google_adwords_post_click_quality_score

google_adwords_keyword_match_type

google_adwords_status

google_adwords_system_serving_status

google_adwords_labels

google_adwords_label_ids

google_adwords_first_page_cpc

google_adwords_first_position_cpc

google_adwords_search_predicted_ctr

google_adwords_top_of_page_cpc

google_adwords_tracking_url_template

google_adwords_url_custom_parameters

google_adwords_estimated_add_clicks_at_first_position_cpc

google_adwords_estimated_add_cost_at_first_position_cpc

google_adwords_enhanced_cpc_enabled

google_adwords_has_quality_score

google_adwords_is_negative

Response JSON

Hosted Page

When you receive visits and submissions to your hosted page(s), RevCent records each event as a separate hosted visit or submission. Each event is also tied to tracking visitors and AdWords tracking when applicable.

Hosted Page Visit

Hosted page visit details.

Hosted Page Visit Retrieve

Retrieve current information on a single hosted page visit or multiple hosted page visits.

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


created_date_unix

The unix timestamp of when the item was created.


hosted_endpoint

The RevCent hosted endpoint related to the item, if the item was created via a hosted page.


id

The RevCent ID of the object item.


name

The name of the item.


path


hosted_page

The RevCent hosted page related to the item, if the item was created via a hosted page.


id

The RevCent ID of the object item.


name

The name of the item.


path


hosted_page_template

The RevCent hosted page template related to the item, if the item was created via a hosted page.


id

The RevCent ID of the object item.


name

The name of the item.



id

The RevCent ID of the object item.


tracking_entry

id

The RevCent ID of the object item.



tracking_visitor

The RevCent tracking visitor related to the item, if TrackJS was initialized.


id

The RevCent ID of the object item.



updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

The total number of pages for the given request.

Request JSON

Response JSON

Hosted Page Submission

Hosted page submission details.

Hosted Page Submission Retrieve

Retrieve current information on a single hosted page submission or multiple hosted page submissions.

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


created_date_unix

The unix timestamp of when the item was created.


hosted_endpoint

The RevCent hosted endpoint related to the item, if the item was created via a hosted page.


id

The RevCent ID of the object item.


name

The name of the item.


path


hosted_page

The RevCent hosted page related to the item, if the item was created via a hosted page.


id

The RevCent ID of the object item.


name

The name of the item.


path


hosted_page_template

The RevCent hosted page template related to the item, if the item was created via a hosted page.


id

The RevCent ID of the object item.


name

The name of the item.



hosted_page_visit

The RevCent hosted page visit related to the item, if the item was created via a hosted page.


id

The RevCent ID of the object item.



id

The RevCent ID of the object item.


sale

id

The RevCent ID of the object item.



submission_type

tracking_entry

id

The RevCent ID of the object item.



tracking_visitor

The RevCent tracking visitor related to the item, if TrackJS was initialized.


id

The RevCent ID of the object item.



updated_date_unix

The unix timestamp of when the item was updated.



total_count

The total number of result items for the given request.


total_pages

The total number of pages for the given request.

Request JSON

Response JSON

Tracking Visitor

TrackJS was created by RevCent as an in house tracking solution. When you have successfully set up tracking, each visitor to your website will be assigned an ID and a tracking visitor will be created. Tracking visitors can be tracked across domains, and each visitor can have multiple tracking entries.

Tracking Visitor Retrieve

Retrieve current information on a single tracking visitor or multiple tracking visitors.

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


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the item. Required if multiple property equals false or is not present.


multiple

Whether it is a multiple type request.

Response JSON Schema


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


code

The result code for the request.
0 = RevCent Error
1 = Success


current_count

The number of result items contained in the current page.


current_page

The current page of result, same as requested page, default is page 1.


request_method

The API request method.


request_type

The API request type.


results

An array of objects, each object being a unique item.


created_date_unix

The unix timestamp of when the item was created.


hosted_page

The RevCent hosted page related to the initial visit which created the tracking visitor, if applicable.


id

The RevCent hosted page ID.


name

The RevCent hosted page name.


path

The RevCent hosted page path.



id

The RevCent ID of the object item.


ip_address

The IP address of the tracking visitor, when initially created.


metadata

The metadata array containing name:value objects.


sales

An array containing sale IDs related to the item.


tracking_domain

The tracking domain you created within RevCent.


id

The tracking domain ID.


name

The tracking domain name.


domain

The tracking domain url.



tracking_entries

Every tracking visitor recieves a tracking entry when navigating to a new page or domain. This allows the tracking across domains, i.e. see when a visitor leaves on website and goes to another.


created_date_unix

The unix timestamp of when the item was created.


id

The RevCent ID of the object item.


initial_visit

Whether the entry is the initial visit, i.e. when the tracking visitor was initially created.


hostname

The tracking entry hostname.


pathname

The tracking entry path.


host

The tracking entry host.


referer

The tracking entry referrer.


ip_address

The IP address of the tracking visitor when the tracking entry was created.


tracking_domain

The tracking domain you created within RevCent.


id

The tracking domain ID.


name

The tracking domain name.


domain

The tracking domain url.



hosted_page

The RevCent hosted page related to the tracking entry, if applicable.


id

The RevCent hosted page ID.


name

The RevCent hosted page name.


path

The RevCent hosted page path.




updated_date_unix

The unix timestamp of when the item was updated.


user_agent

The user agent, or browser, of the tracking visitor when initially created.



total_count

The total number of result items for the given request.


total_pages

The total number of pages for the given request.

Request JSON

Response JSON

Trial

A trial is created when a product has a trial period associated with it. A trial can have shipping associated with it, along with shipping rules depending on the product.

Trial Expire

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


trial_id

The trial ID


payment_profile

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.


gateway

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.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


amount_captured

The amount captured.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


card_id

The RevCent ID of the customer credit card used if a transaction occurred.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer

The customer object.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone

metadata

The metadata array containing name:value objects.



customer_id

The RevCent ID of the customer.


gateway

Gateway related to the item.


gateway_id

The RevCent ID of the gateway.


gateway_raw_response

The full response from the merchant gateway as a JSON string.


payment_profile_results

If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.


payment_profile_id

The ID of the payment profile used.


original_amount

The original amount submitted in the request using the products, their prices and quantities.


final_amount

The final amount that was successfully charged after the payment profile was applied, if applicable.


successful_step_num

The step in the payment profile that ended in success, if applicable.


successful_gateway

The gateway that successfully processed the transaction, if applicable.


num_declined_transactions

The total number of declined transactions that occurred when the payment profile was processed.


declined_transaction_array

An array of IDs for declined transactions during the payment profile processing.


step_array

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.


step_action

The action taken during the step.


step_amount

The resulting step amount to be charged after any modifiers to payment amount.


step_cascade_result

If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.


cascade_order

The order of gateways used when processing the cascade.


enabled_gateways

The gateways which were enabled within the cascade for processing.


gateway_results

The results for each gateway validated within the cascade, after being passed or failed due to in place rules.


gateway_id

The ID of the gateway validated.


order

The order of the gateway within the cascade.


revenue_rules

Revenue rules validation result for the gateway.


enabled

If revenue rules were enabled for the gateway.


passed

If the gateway passed all revenue rules.


details

If revenue rules were present and enabled, the results of the revenue validation will be displayed here.



time_rules

Time rules validation result for the gateway.


enabled

If time rules were enabled for the gateway.


passed

If the gateway passed all time rules.


details

If time rules were present and enabled, the results of the time validation will be displayed here.



success

If the gateway passed all gateway validation requirements.



start_gateway

The ID of the gateway which was selected first for validation.



step_gateway

The name of gateway used to process the step transaction.


step_gateway_id

The ID of gateway used to process the step transaction.


step_gateway_response

The response returned by the gateway used to process the step transaction.


step_modifier

The modifier applied to the payment amount, if any.


step_num

The specific step number.


step_result

The result of the step transaction


step_setting

The step setting.


step_source

The step source, either gateway or cascade.


step_transaction

The ID of the step transaction.




product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.


price

The product price for the specific item.


quantity

The product quantity for the specific item.



product_sale_id

The RevCent ID of the product sale.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


salvage_transaction

The salvage transaction details object, if created as a result of the request. Null if not applicable.


id

The RevCent ID of the object item.


amount

The salvage transaction amount.


enabled

If the salvage transaction is enabled.


sale_creator

If the salvage transaction will create a new sale.



salvage_transaction_created

If a salvage transaction was created as a result of the request.


ship_to

The ship to object.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone

metadata

The metadata array containing name:value objects.



shipping_created

An array of shipping items created. Each object is an individual shipping item containing details.


subscription

id

The RevCent ID of the object item.


is_overdue

is_occurrence_limit


subscription_id

The RevCent ID of the subscription.


tax_created

An array of tax items created. Each object is an individual tax item containing details.


amount_original_total

The total calculated amount when an item is created.


amount_captured

The amount captured.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


rate

Tax rate calculated based on tax amount and total related item amount.



transaction_id

The RevCent ID of the credit card transaction.


trial_id

The RevCent ID of the trial.

Request JSON

Response JSON

Trial Cancel

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


trial_id

The trial ID


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


amount_captured

The amount captured.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


card_id

The RevCent ID of the customer credit card used if a transaction occurred.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer

The customer object.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone

metadata

The metadata array containing name:value objects.



customer_id

The RevCent ID of the customer.


gateway

Gateway related to the item.


gateway_id

The RevCent ID of the gateway.


gateway_raw_response

The full response from the merchant gateway as a JSON string.


payment_profile_results

If a payment profile was used to process the credit card transaction for this item. The results of the payment profile are contained.


payment_profile_id

The ID of the payment profile used.


original_amount

The original amount submitted in the request using the products, their prices and quantities.


final_amount

The final amount that was successfully charged after the payment profile was applied, if applicable.


successful_step_num

The step in the payment profile that ended in success, if applicable.


successful_gateway

The gateway that successfully processed the transaction, if applicable.


num_declined_transactions

The total number of declined transactions that occurred when the payment profile was processed.


declined_transaction_array

An array of IDs for declined transactions during the payment profile processing.


step_array

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.


step_action

The action taken during the step.


step_amount

The resulting step amount to be charged after any modifiers to payment amount.


step_cascade_result

If the step source was cascade, the step_cascade_result object will display the result of the cascade processing.


cascade_order

The order of gateways used when processing the cascade.


enabled_gateways

The gateways which were enabled within the cascade for processing.


gateway_results

The results for each gateway validated within the cascade, after being passed or failed due to in place rules.


gateway_id

The ID of the gateway validated.


order

The order of the gateway within the cascade.


revenue_rules

Revenue rules validation result for the gateway.


enabled

If revenue rules were enabled for the gateway.


passed

If the gateway passed all revenue rules.


details

If revenue rules were present and enabled, the results of the revenue validation will be displayed here.



time_rules

Time rules validation result for the gateway.


enabled

If time rules were enabled for the gateway.


passed

If the gateway passed all time rules.


details

If time rules were present and enabled, the results of the time validation will be displayed here.



success

If the gateway passed all gateway validation requirements.



start_gateway

The ID of the gateway which was selected first for validation.



step_gateway

The name of gateway used to process the step transaction.


step_gateway_id

The ID of gateway used to process the step transaction.


step_gateway_response

The response returned by the gateway used to process the step transaction.


step_modifier

The modifier applied to the payment amount, if any.


step_num

The specific step number.


step_result

The result of the step transaction


step_setting

The step setting.


step_source

The step source, either gateway or cascade.


step_transaction

The ID of the step transaction.




product

The product object containing information on the related product.


id

The RevCent ID of the object item.


name

The product name.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.


price

The product price for the specific item.


quantity

The product quantity for the specific item.



product_sale_id

The RevCent ID of the product sale.


request_method

The API request method.


request_type

The API request type.


result

The a brief description of the result of the API call.


sale_id

The RevCent ID of the sale.


salvage_transaction

The salvage transaction details object, if created as a result of the request. Null if not applicable.


id

The RevCent ID of the object item.


amount

The salvage transaction amount.


enabled

If the salvage transaction is enabled.


sale_creator

If the salvage transaction will create a new sale.



salvage_transaction_created

If a salvage transaction was created as a result of the request.


ship_to

The ship to object.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone

metadata

The metadata array containing name:value objects.



shipping_created

An array of shipping items created. Each object is an individual shipping item containing details.


subscription

id

The RevCent ID of the object item.


is_overdue

is_occurrence_limit


subscription_id

The RevCent ID of the subscription.


tax_created

An array of tax items created. Each object is an individual tax item containing details.


amount_original_total

The total calculated amount when an item is created.


amount_captured

The amount captured.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


rate

Tax rate calculated based on tax amount and total related item amount.



transaction_id

The RevCent ID of the credit card transaction.


trial_id

The RevCent ID of the trial.

Request JSON

Response JSON

Trial Extend

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


trial_id

The trial ID


days

The total number of days to extend the trial.


metadata

An array containing one or more objects. Each object must contain a name property and a value property or else the object is omitted.


name

The name property for the metadata object.


value

The value property for the metadata object.


Response JSON Schema


amount

The amount of the item.


amount_captured

The amount captured.


amount_fees

The current amount of calculated fees charged by the payment processor.


amount_gross

The current gross amount. Equals (amount_captured + amount_settled).


amount_net

The current net amount. Equals (amount_captured + amount_settled) - amount_fees.


amount_original_total

The total calculated amount when an item is created.


amount_remaining

The current amount remaining to be captured. Amounts yet to be captured due to a trial or salvage transaction.


amount_to_salvage

The current amount of related salvage transactions not yet salvaged.


api_call_id

The API call ID of the request. Every API request is assigned an ID.


api_call_processed

Indicates whether the API call was processed.


api_call_unix

The unix timestamp of when the API call was made.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


card_id

The RevCent ID of the customer credit card used if a transaction occurred.


code

The result code for the request.
0 = RevCent Error
1 = Success


customer

The customer object.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


first_name

last_name

address_line_1

address_line_2

city

state

zip

company

country

email

phone

metadata

The metadata array containing name:value objects.



customer_id

The RevCent ID of the customer.


gateway

Gateway related to the item.


gateway_id

The RevCent ID of the gateway.


gateway_raw_response

The full response from the merchant gateway as a JSON string.