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

Whitelist RevCent: All requests from RevCent will use the following IP address:
34.224.171.255

If you need help please do not hesitate to contact us.

API Endpoint

https://api.revcent.com/v1

Authentication

Each account has two API Keys, a live key and a test key. This allows you to test the API and view results using the test/live mode toggle in the user dashboard.

Depending on the key used, RevCent will use the appropriate merchant gateway endpoint for test/live transactions. For example, if you use a test RevCent key we will use the test endpoint for the merchant gateway. A live RevCent key will use the live merchant gateway endpoint.

The x-api-key should be in the header of the API request.

Example

"headers": { 
    "Content-Type": "application/json", 
    "x-api-key": "YOUR_REVCENT_API_KEY" 
}

Request Body

Every request body is a JSON object, containing 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

{ 
    "request": {
        "type": "sale",
        "method": "retrieve",
        "id": "mJWJbKNQ4QI8XbwmyyW7"
    }
}

Campaign

A campaign is created within the RevCent web app and is a way to group, categorize and filter various items within your account. New sale and new customer requests require a RevCent campaign ID in the request.

Campaign Retrieve

Retrieve current information on a single campaign or multiple campaigns.

Please view Pagination and Filters for details on retrieving multiple items.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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.


description

The description of the item.


enabled

Whether the campaign is enabled.


id

The RevCent ID of the object item.


name

The name 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

{
  "request": {
    "type": "campaign",
    "method": "retrieve",
    "id": "JN0Zpj7RGJiwKqAnRoy6"
  }
}

Response JSON

{
  "api_call_id": "Q45jJa6ZjgFYmK5Ek86l",
  "api_call_processed": true,
  "api_call_unix": 1570281688,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "campaign",
  "results": [
    {
      "created_date_unix": 1550530876,
      "description": "Twitter campaign sales and customers.",
      "enabled": true,
      "id": "JN0Zpj7RGJiwKqAnRoy6",
      "name": "Twitter Campaign",
      "updated_date_unix": 1551406538
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Coupon

A coupon is created within the RevCent web app and can be applied to initial sales, subsequent subscription renewals and future customer purchases based on settings. Create specific rules, expiration dates and discount types within the web app when creating a coupon.

Coupon Validate

Validate a coupon using the coupon code. A rejected coupon code will display an error explaining the reason for rejection, while an applicable coupon code will display the discount type and amount.

To get the actual discount amount for a new sale using a valid coupon, use the sale estimate API request.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


coupon_code

The coupon code.



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


coupon

The coupon associated with the coupon code.

If coupon code submitted is invalid, this coupon property will equal null.

Check for null coupon property in response to validate coupon code.


id

The RevCent ID of the object item.


coupon_code

The coupon code.


enabled

Whether the coupon is enabled.


start_date_unix

The coupon start date.


end_date_unix

The coupon end date.


discount_type

The coupon discount type, either percent or amount.


discount_value

The coupon discount value relative to the discount type.


num_use

The total number of times the coupon was used in a successful sale.


coupon_profile

The coupon profile associated with the coupon.


id

The RevCent ID of the object item.


enabled

Whether the coupon profile is enabled.


num_use_max

Whether there is a maximum use limit within the coupon profile associated with the coupon.




request_method

The API request method.


request_type

The API request type.


result

Whether the coupon code is valid. If invalid (coupon = null) the reason for the coupon code being invalid.


Request JSON

{
  "request": {
    "type": "coupon",
    "method": "validate",
    "coupon_code": "10percent"
  }
}

Response JSON

{
  "api_call_id": "qZBoPgKB0lIOJG6LJZ4R",
  "api_call_processed": true,
  "api_call_unix": 1570459361,
  "code": 1,
  "coupon": {
    "id": "VPmmrpbVl7cQ9JaXEanl",
    "coupon_code": "10percent",
    "enabled": true,
    "start_date_unix": 1567559820,
    "end_date_unix": 1580446800,
    "discount_type": "percent",
    "discount_value": 10,
    "num_use": 66,
    "coupon_profile": {
      "id": "k6vvXQwwNycvJM7yMwzL",
      "enabled": true,
      "num_use_max": 0
    }
  },
  "request_method": "validate",
  "request_type": "coupon",
  "result": "Valid"
}

Chargeback

A chargeback within RevCent is created either using the API or via a third party integration for credit card transactions within RevCent.

Chargeback Create

Create a chargeback within RevCent via the chargeback create method. A chargeback is specific to an existing RevCent credit card transaction. Therefore, when creating a chargeback, the transaction_id or gateway_transaction_id for the related transaction must be provided.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


transaction_id

The RevCent transaction ID for the chargeback related transaction. If not present, you must provide the gateway_transaction_id property.


gateway_transaction_id

The gateway transaction ID for the chargeback related transaction. Only provide if the transaction_id property is not present.


amount

The chargeback amount.


arn

The acquirer reference number.


chargeback_date

The date the chargeback created by the issuing bank.


received_date

The date the chargeback was received.


case_number

The chargeback case number.


reason_code

The chargeback reason code.


third_party_integration_id

The RevCent third party integration ID.


third_party_chargeback_id

The third party chargeback ID.


third_party_order_id

The third party order ID.



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.


chargeback_id

The RevCent ID of the chargeback.


code

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


customer_id

The RevCent ID of the customer.


gateway

Gateway related to the item.


gateway_id

The RevCent ID of the gateway.


gateway_transaction_id

The transaction ID assigned by the merchant gateway.


merchant_account_id

The merchant account ID associated with the merchant gateway.


request_method

The API request method.


request_type

The API request type.


result

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


transaction_id

The RevCent ID of the credit card transaction.


Request JSON

{
  "request": {
    "type": "chargeback",
    "method": "create",
    "transaction_id": "EMO5Xo8qMEf15YXQywkR",
    "gateway_transaction_id": "60157523306",
    "amount": 140,
    "arn": "arn_1",
    "chargeback_date": "12/01/2020",
    "received_date": "12/04/2020",
    "case_number": "1234",
    "reason_code": "4",
    "third_party_chargeback_id": "cb_1",
    "third_party_order_id": "or_1",
    "metadata": [
      {
        "name": "chargeback",
        "value": "12345"
      }
    ]
  }
}

Response JSON

{
  "amount": 21.39,
  "api_call_id": "WmbX7n17zGTL65ZqPnp9",
  "api_call_processed": true,
  "api_call_unix": 1609122150,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "chargeback_id": "j0a9dNwVKqu8Qz5Vl6ZZ",
  "code": 1,
  "customer_id": "2rn1nnqKN6i6wmdKolJE",
  "gateway": "Authorize.net",
  "gateway_id": "LYE26MW8Rlh5VbJmlp2l",
  "gateway_transaction_id": "60158956353",
  "merchant_account_id": "5678",
  "request_method": "create",
  "request_type": "chargeback",
  "result": "Chargeback created.",
  "transaction_id": "gYZVZZbdmRTl7g2aJyNN"
}

Chargeback Edit

Edit an existing chargeback within RevCent via the chargeback edit method.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


chargeback_id

The RevCent chargeback ID.


amount

The chargeback amount.


arn

The acquirer reference number.


chargeback_date

The date the chargeback created by the issuing bank.


received_date

The date the chargeback was received.


case_number

The chargeback case number.


reason_code

The chargeback reason code.


third_party_integration_id

The RevCent third party integration ID.


third_party_chargeback_id

The third party chargeback ID.


third_party_order_id

The third party order ID.



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.


chargeback_id

The RevCent ID of the chargeback.


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.


Request JSON

{
  "request": {
    "type": "chargeback",
    "method": "edit",
    "chargeback_id": "0p9yLjoq91u9wVEqZ2M2",
    "amount": 140,
    "arn": "arn_1",
    "chargeback_date": "10/01/2020",
    "received_date": "10/04/2020",
    "case_number": "1234",
    "reason_code": "4",
    "third_party_chargeback_id": "cb_1",
    "third_party_order_id": "or_1"
  }
}

Response JSON

{
  "api_call_id": "mJLY1aqWOvCJBL4wAqV8",
  "api_call_processed": true,
  "api_call_unix": 1609122072,
  "chargeback_id": "Nk6llENAROsKvm8PLlOw",
  "code": 1,
  "request_method": "edit",
  "request_type": "chargeback",
  "result": "Chargeback edited."
}

Chargeback Retrieve

Retrieve current information on a single chargeback or multiple chargebacks.

Please view Pagination and Filters for details on retrieving multiple items.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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 transaction associated with the fraud detection.


arn

The acquirer reference number, if applicable.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


case_number

The case number, if applicable.


chargeback_date

The date the chargeback occurred.


chargeback_date_unix

The unix timestamp of the date the chargeback occurred.


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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts related to the item.


fraud_detections

An array containing fraud detection IDs related to the item.


gateway

Gateway related to the item.


name

The name of the item.


id

The RevCent ID of the object item.


merchant_account_id

The merchant account ID associated with the merchant gateway.



gateway_transaction_id

The transaction ID assigned by the merchant gateway.


id

The RevCent ID of the object item.


invoices

An array containing invoice IDs related to the item.


is_third_party_integration

Whether the chargeback is associated with a RevCent third party integration.


iso_currency

ISO 4217 currency code.


live_mode

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


merchant_account_id

The merchant account ID associated with the merchant gateway.


offline_payments

An array containing offline payment IDs related to the item.


origin_api_call

The original API call that created the entity associated with the chargeback.


id

The RevCent ID of the original API call that created the entity associated with the chargeback.


date

The date of the API call.


date_unix

The unix timestamp of the date of the API call.


type

The API call type.


method

The API call method.


ip_address

The IP address that was used to make the API call.



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.


reason_code

The chargeback reason code.


received_date

The date the chargeback was received by you or the third party.


received_date_unix

The unix timestamp of the date the chargeback was received by you or the third party.


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.


status

The current status of the related item.


subscription_renewals

An array containing subscription renewal IDs related to the item.


tax

An array containing tax IDs related to the item.


third_party_chargeback_id

The third party chargeback ID.


third_party_integration

If the chargeback was created by a third party integration, details will appear here.


id

The ID of your RevCent third party integration.


name

The name of your RevCent third party integration.


third_party

Details on the specific third party.


id

The RevCent ID for the third party.


name

The name of the third party.




third_party_order_id

The third party order ID.


transaction

The specific transaction the chargeback is related to.


id

The RevCent transaction ID.


created_date_unix

The unix timestamp of the date the transaction was created.


created_date

The date the transaction was created.


updated_date_unix

The unix timestamp of the date the transaction was updated.


updated_date

The date the transaction was updated.


amount

The transaction amount.



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.


usage_account_invoices

An array containing usage account invoice IDs related to the item.


usage_accounts

An array containing usage account IDs related to the item.


usage_item_invoices

An array containing usage item invoice IDs related to the item.


usage_items

An array containing usage item IDs related to the item.



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

{
  "request": {
    "type": "chargeback",
    "method": "retrieve",
    "id": "O04ll4qkllTXqA5Xd79L"
  }
}

Response JSON

{
  "api_call_id": "5rkZvym5BNIO6WQX9PJl",
  "api_call_processed": true,
  "api_call_unix": 1609120332,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "chargeback",
  "results": [
    {
      "amount": 42.36,
      "arn": "12345",
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "Twitter Campaign",
      "case_number": "56789",
      "chargeback_date": "2020-12-23T05:00:00+00:00",
      "chargeback_date_unix": 1608699600,
      "check_directs": [],
      "created_date_unix": 1608738415,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "fraud_detections": [],
      "gateway": {
        "name": "Authorize.net",
        "id": "LYE26MW8Rlh5VbJmlp2l",
        "merchant_account_id": "12345678"
      },
      "gateway_transaction_id": "60158776104",
      "id": "O04ll4qkllTXqA5Xd79L",
      "invoices": [],
      "is_third_party_integration": false,
      "iso_currency": "USD",
      "live_mode": false,
      "merchant_account_id": "12345678",
      "metadata": [],
      "offline_payments": [],
      "origin_api_call": {
        "id": "RJblXjvvEgsqjGQrBjoX",
        "date": "2020-12-22T23:22:04+00:00",
        "date_unix": 1608679324,
        "type": "subscription",
        "method": "renew",
        "ip_address": "123.456.789.101"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [],
      "reason_code": "2",
      "received_date": "2020-12-23T05:00:00+00:00",
      "received_date_unix": 1608699600,
      "sales": [
        "y2wARbKL8PCPL46Xb7qA"
      ],
      "salvage_transactions": [],
      "shipping": [
        "y2Wrl6kwZoUdBWJjABp0"
      ],
      "status": "Created",
      "subscription_renewals": [
        "zGkXy5Qa0OH4qWAozq58"
      ],
      "tax": [
        "qZM1QVAqwRik6BJNq6vW"
      ],
      "third_party_chargeback_id": "",
      "third_party_integration": null,
      "third_party_order_id": "",
      "transaction": {
        "id": "pgPbQlGpr8fWQ72NbQrB",
        "created_date_unix": 1608679325,
        "created_date": "2020-12-22T23:22:05+00:00",
        "updated_date_unix": 1608859578,
        "updated_date": "2020-12-25T01:26:18+00:00",
        "amount": 42.36
      },
      "transactions": [
        "pgPbQlGpr8fWQ72NbQrB"
      ],
      "trials": [],
      "updated_date_unix": 1608738415,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Customer

A customer is an individual that is created either by sale, signup, etc. Every customer is given a unique ID as well as the ability to add multiple credit cards.

Implement metadata when creating a sale or customer for enhanced analytics. Our TrackJS feature is extremely useful for tracking visitors and linking them to new customers. We highly recommend you implement metadata as well as TrackJS to know more about your customers.

Customer Create

Create a customer via the customer create method. Useful for signup or prospect purposes where a sale has yet to take place.

AdWords Integration

If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID.

Example

"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


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.





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

{
  "request": {
    "type": "customer",
    "method": "create",
    "campaign": "Twitter Campaign",
    "customer": {
      "first_name": "udhi",
      "last_name": "pguolnvc",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ndjo@gmail.com",
      "phone": "1234567890"
    },
    "bill_to": {
      "first_name": "udhi",
      "last_name": "pguolnvc",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ndjo@gmail.com",
      "phone": "1234567890"
    },
    "internal_customer_id": "cus_7791",
    "payment": {
      "credit_card": {
        "card_number": "4242424242424242",
        "exp_month": 12,
        "exp_year": 20,
        "card_code": "999"
      }
    },
    "metadata": [
      {
        "name": "adwords_click",
        "value": "Cjat0KwhCQjdTq..."
      },
      {
        "name": "sign_up_page",
        "value": "v1"
      }
    ]
  }
}

Response JSON

{
  "api_call_id": "Nk5voyYVvgTOJkEdGRyj",
  "api_call_processed": true,
  "api_call_unix": 1565814918,
  "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
  "campaign_name": "Twitter Campaign",
  "card_id": "YaVqjAZNqzCGvrrZgGqm",
  "code": 1,
  "customer_email": "ndjo@gmail.com",
  "customer_first_name": "udhi",
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "customer_last_name": "pguolnvc",
  "request_method": "create",
  "request_type": "customer",
  "result": "Created new customer and added card."
}

Customer Edit

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


internal_customer_id

Your internal customer ID.



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

{
  "request": {
    "type": "customer",
    "method": "edit",
    "customer_id": "mJGAbQ0zAmU12rpngR1M",
    "customer": {
      "first_name": "ywbw",
      "last_name": "fbjdbefa",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "izlo@gmail.com",
      "phone": "1234567890"
    }
  }
}

Response JSON

{
  "api_call_id": "P65Gn2z6WMs552lNYg6q",
  "api_call_processed": true,
  "api_call_unix": 1565814919,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "edit",
  "request_type": "customer",
  "result": "Customer information successfully edited."
}

Customer Enable

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



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

{
  "request": {
    "type": "customer",
    "method": "enable",
    "customer_id": "mJGAbQ0zAmU12rpngR1M"
  }
}

Response JSON

{
  "api_call_id": "BvwOyAQgd8u226OMrOqY",
  "api_call_processed": true,
  "api_call_unix": 1565814920,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "enable",
  "request_type": "customer",
  "result": "Customer enabled."
}

Customer Disable

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



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

{
  "request": {
    "type": "customer",
    "method": "disable",
    "customer_id": "mJGAbQ0zAmU12rpngR1M"
  }
}

Response JSON

{
  "api_call_id": "ZVEGoyPVA0fZJMPo8Kav",
  "api_call_processed": true,
  "api_call_unix": 1565814919,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "disable",
  "request_type": "customer",
  "result": "Customer disabled."
}

Customer Add Card

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.





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

{
  "request": {
    "type": "customer",
    "method": "add_card",
    "customer_id": "mJGAbQ0zAmU12rpngR1M",
    "bill_to": {
      "first_name": "orhw",
      "last_name": "selldjxk",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "utnl@gmail.com",
      "phone": "1234567890"
    },
    "payment": {
      "credit_card": {
        "card_number": "4141414141414141",
        "exp_month": 10,
        "exp_year": 23,
        "card_code": "123",
        "set_as_default": true
      }
    }
  }
}

Response JSON

{
  "api_call_id": "j0LNQJG1B7UggmXw950J",
  "api_call_processed": true,
  "api_call_unix": 1565814920,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "add_card",
  "request_type": "customer",
  "result": "Customer card added."
}

Customer Retrieve

Retrieve current information on a single customer or multiple customers.

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 type of request being made.


method

The method for the request type.


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


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

{
  "request": {
    "type": "customer",
    "method": "retrieve",
    "id": "ajOAl24bBXc5nXwagAOg"
  }
}

Response JSON

{
  "api_call_id": "VPm9vVEzOjf6laVPQ0QP",
  "api_call_processed": true,
  "api_call_unix": 1565833756,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "customer",
  "results": [
    {
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "anonymous": false,
      "blocked": false,
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "check_directs": [],
      "city": "Washington",
      "company": "",
      "country": "USA",
      "created_date_unix": 1565833753,
      "customer_card": [
        {
          "created_date_unix": 1565833753,
          "updated_date_unix": 1565833755,
          "id": "WmPn2g8bakcKnWWEmRlJ",
          "type": "visa",
          "last_4": "4242",
          "exp_date": "04/22",
          "exp_month": 4,
          "exp_year": 2022,
          "is_default": true
        }
      ],
      "discounts": [],
      "email": "ctnb@gmail.com",
      "enabled": true,
      "first_name": "vqjh",
      "full_address": "",
      "geocode_success": false,
      "google_place_id": "",
      "id": "ajOAl24bBXc5nXwagAOg",
      "internal_id": "cus_3197",
      "last_name": "slszhjru",
      "lat": "0",
      "lon": "0",
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "phone": "1234567890",
      "product_sales": [
        "7rwyAzL5LXUa8QrGMoMR",
        "Nk5vOzGAGRfrmg8LZXVM",
        "8rwvAzd6dQU6kXkB2VQq"
      ],
      "sales": [
        "rm9EG1BjrXcqm64KKq6z"
      ],
      "salvage_transactions": [
        "9rdE4zvXvQUjVp22ddgm"
      ],
      "shipping": [
        "Q45o8zGpGRu098B88npR"
      ],
      "smtp_messages": [],
      "state": "DC",
      "state_long": "DC",
      "subscription_renewals": [],
      "subscriptions": [
        "4r15qAlZlyUoMprMNVpE",
        "VPm9vVEoERc6Wy6Jg7Jg"
      ],
      "tax": [
        "2rdJNg4E4yUplpKWYnpo"
      ],
      "transactions": [
        "vEwWZv5B5zIXM9bq1yQd",
        "RJ5MaZMap1cZdP9w7ayE"
      ],
      "trials": [
        "k6vn81lElqsvKEB4K2JA"
      ],
      "updated_date_unix": 1565833753,
      "zip": "20500"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Discount

A discount is created when RevCent receives a static discount entry or a coupon code during a request.

Discount Retrieve

Retrieve current information on a single discount or multiple discounts.

Please view Pagination and Filters for details on retrieving multiple items.

The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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.


coupon

The details of any coupon related to the discount.


id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.


coupon_code

The coupon code.



created_date_unix

The unix timestamp of when the item was created.


customer

The customer object.


address_line_1

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



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

{
  "request": {
    "type": "discount",
    "method": "retrieve",
    "id": "5r1wN8EbAgsPvLlbMava"
  }
}

Response JSON

{
  "api_call_id": "ZVE5YRjd7RsXZpVw4krG",
  "api_call_processed": true,
  "api_call_unix": 1566160507,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "discount",
  "results": [
    {
      "check_directs": [],
      "coupon": {
        "id": "VPmmrpbVl7cQ9JaXEanl",
        "name": "test2",
        "description": "",
        "coupon_code": "10percent"
      },
      "created_date_unix": 1565965034,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "description": "$5 Off Coupon from facebook link.",
      "discount_amount": 5,
      "discount_percent": 4.17,
      "discount_type": "amount",
      "id": "5r1wN8EbAgsPvLlbMava",
      "name": "$5 Off Coupon",
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [],
      "sales": [
        "Kn5aKb8lQZfXMl0NGjRZ"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1565965035
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Fraud

RevCent fraud detections and requests, using manual or third party integrations.

Fraud Detection

A fraud detection within RevCent is created either using the API, or via a third party integration, for credit card, PayPal, checks or offline payments.

Fraud Detection Create

Create a fraud detection within RevCent via the fraud detection create method.

Important: A fraud detection must have an originating RevCent API call, which RevCent will find when you provide a value for source_id. The value for the source_id property can be from one of the items listed below.

API Call ID
The RevCent ID for the originating API call.
Transaction ID
The RevCent ID for a credit card transaction.
Gateway Transaction ID
The payment gateways' ID for a credit card transaction.
PayPal Transaction ID
The RevCent ID or PayPal ID for a PayPal transaction.
Check ID
The RevCent ID for a check payment.
Offline Payment ID
The RevCent ID for an offline payment.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


source_id

The source ID. Read the important information above.


arn

The acquirer reference number.


event_date

The date of the fraud event.


fraud_detection_date

The date the fraud was detected.


case_number

The case number.


third_party_integration_id

The RevCent third party integration ID.


third_party_fraud_detection_id

The third party fraud detection ID.


third_party_order_id

The third party order ID.



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.


fraud_detection_id

The RevCent ID of the fraud detection.


origin_api_call_id

The RevCent ID of the original API call that created the entity associated with the fraud.


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

{
  "request": {
    "type": "fraud_detection",
    "method": "create",
    "source_id": "2rnYMVFGraRJBnPpgvQV",
    "arn": "93994",
    "event_date": "12/01/2020",
    "fraud_detection_date": "12/11/2020",
    "case_number": "4999",
    "third_party_integration_id": "8r4lFWLbEr1PZglb7d8z",
    "third_party_fraud_detection_id": "123456",
    "third_party_order_id": "00001",
    "metadata": [
      {
        "name": "fraud",
        "value": "12345"
      }
    ]
  }
}

Response JSON

{
  "amount": 21.61,
  "api_call_id": "y2WG1ApMMKhW6ZoBb72o",
  "api_call_processed": true,
  "api_call_unix": 1609086154,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "9rZ68zWWglFY8O26azRX",
  "fraud_detection_id": "VPwOydX2ArHJy8gX2o98",
  "origin_api_call_id": "O04EbzqqdltXb7EOGQpz",
  "request_method": "create",
  "request_type": "fraud_detection",
  "result": "Fraud detection created."
}

Fraud Detection Edit

Edit an existing fraud detection within RevCent via the fraud detection edit method.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


fraud_detection_id

The RevCent ID of the fraud detection.


amount

The amount of the related transaction associated with the fraud detection.


arn

The acquirer reference number, if applicable.


event_date

The date of the fraud event.


fraud_detection_date

The date the fraud was detected.


case_number

The case number, if applicable.


false_positive

Whether the fraud detection is incorrect. I.e. The related payment is not actually fraud.


third_party_integration_id

The RevCent third party integration ID.


third_party_fraud_detection_id

The third party fraud detection ID.


third_party_order_id

The third party order ID.



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


fraud_detection_id

The RevCent ID of the fraud detection.


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

{
  "request": {
    "type": "fraud_detection",
    "method": "edit",
    "fraud_detection_id": "LYklEVoPJLfq65rR290A",
    "amount": 140,
    "arn": "93995",
    "event_date": "12/29/2020",
    "fraud_detection_date": "12/30/2020",
    "case_number": "5000",
    "false_positive": true,
    "third_party_integration_id": "8r4lFWLbEr1PZglb7d8z",
    "third_party_fraud_detection_id": "7890",
    "third_party_order_id": "00002"
  }
}

Response JSON

{
  "api_call_id": "qZM6vXNEVasgj0XVJO50",
  "api_call_processed": true,
  "api_call_unix": 1609118598,
  "code": 1,
  "fraud_detection_id": "LYklEVoPJLfq65rR290A",
  "request_method": "edit",
  "request_type": "fraud_detection",
  "result": "Fraud detection edited."
}

Fraud Detection Retrieve

Retrieve current information on a single fraud detection or multiple fraud detections.

Please view Pagination and Filters for details on retrieving multiple items.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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 transaction associated with the fraud detection.


arn

The acquirer reference number, if applicable.


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


case_number

The case number, if applicable.


chargebacks

An array containing chargeback IDs related to 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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts related to the item.


event_date

The date of the fraud event.


event_date_unix

The unix timestamp of the date of the fraud event.


false_positive

Whether the fraud detection is incorrect. I.e. The related payment is not actually fraud.


fraud_detection_date

The date the fraud was detected.


fraud_detection_date_unix

The unix timestamp of the date the fraud was detected.


fraud_detection_requests

An array containing fraud detection request IDs related to the item.


id

The RevCent ID of the object item.


invoices

An array containing invoice IDs related to the item.


is_third_party_integration

Whether the fraud detection is associated with a RevCent third party integration.


iso_currency

ISO 4217 currency code.


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.


origin_api_call

The original API call that created the entity associated with the fraud detection.


id

The RevCent ID of the original API call that created the entity associated with the fraud.


date

The date of the API call.


date_unix

The unix timestamp of the date of the API call.


type

The API call type.


method

The API call method.


ip_address

The IP address that was used to make the API call.



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.


revcent_shop

The RevCent hosted shopping cart that item originated from.


sale_id

The RevCent ID of the sale.


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.


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_fraud_detection_id

The third party fraud detection ID.


third_party_integration

If the fraud detection was created by a third party integration, details will appear here.


id

The ID of your RevCent third party integration.


name

The name of your RevCent third party integration.


third_party

Details on the specific third party.


id

The RevCent ID for the third party.


name

The name of the third party.




third_party_order_id

The third party order ID.


third_party_shop

The third party shop 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.


usage_account_invoices

An array containing usage account invoice IDs related to the item.


usage_accounts

An array containing usage account IDs related to the item.


usage_item_invoices

An array containing usage item invoice IDs related to the item.


usage_items

An array containing usage item IDs related to the item.



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

{
  "request": {
    "type": "fraud_detection",
    "method": "retrieve",
    "id": "d9bmzA9lr8tYJAyLkBZO"
  }
}

Response JSON

{
  "api_call_id": "BvGBOZ2k14cXbZ1AvE17",
  "api_call_processed": true,
  "api_call_unix": 1609092655,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "fraud_detection",
  "results": [
    {
      "amount": 21.61,
      "arn": "arn234",
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "case_number": "fraud123",
      "chargebacks": [],
      "check_directs": [],
      "created_date_unix": 1609086154,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "details_response": "{}",
      "discounts": [],
      "event_date": "2020-12-01T00:00:00+00:00",
      "event_date_unix": 1606780800,
      "false_positive": false,
      "fraud_detection_date": "2020-12-11T00:00:00+00:00",
      "fraud_detection_date_unix": 1607644800,
      "fraud_detection_requests": [],
      "id": "VPwOydX2ArHJy8gX2o98",
      "invoices": [],
      "is_third_party_integration": true,
      "iso_currency": "USD",
      "license_keys": [],
      "live_mode": false,
      "metadata": [
        {
          "name": "fraud",
          "value": "12345",
          "entry_date": "2020-12-27"
        }
      ],
      "notes": [],
      "offline_payments": [],
      "origin_api_call": {
        "id": "O04EbzqqdltXb7EOGQpz",
        "date": "2020-12-27T16:20:24+00:00",
        "date_unix": 1609086024,
        "type": "sale",
        "method": "create",
        "ip_address": "123.456.789.101"
      },
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "zGkMgj2aKPhWBbNqdGjG"
      ],
      "quota_accounts": [],
      "revcent_shop": null,
      "sale_id": "BvGqjz00dlT2jEk65OnW",
      "sales": [
        "BvGqjz00dlT2jEk65OnW"
      ],
      "salvage_transactions": [],
      "shipping": [
        "d9bgVWPpEvFwBW29R8jP"
      ],
      "smtp_messages": [],
      "status": "Created",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [
        "pgPZnmRpYkf710aQ8jRA"
      ],
      "third_party_fraud_detection_id": "third_party_id123",
      "third_party_integration": {
        "id": "8r4Er1PZglFWLblb7d8z",
        "name": "Midigator Prevention",
        "third_party": {
          "id": "zGkz8XvX9yT48q6LRqjW",
          "name": "Midigator Prevention"
        }
      },
      "third_party_order_id": "third_party_order_id4342",
      "third_party_shop": null,
      "transactions": [
        "2rnPpgvYMVFGraRJBnQV"
      ],
      "trials": [],
      "updated_date_unix": 1609086154,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_entries": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Fraud Detection Request

A fraud detection request within RevCent is created when RevCent contacts a third party integration and requests information on a payment before the payment is processed.

Fraud Detection Request Retrieve

Retrieve current information on a single fraud detection request or multiple fraud detection requests.

Please view Pagination and Filters for details on retrieving multiple items.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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.


chargebacks

An array containing chargeback IDs related to 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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts related to the item.


fraud_detections

An array containing fraud detection IDs related to the item.


id

The RevCent ID of the object item.


integration_mode

The third party integration mode, i.e. live or test.


invoices

An array containing invoice IDs related to the item.


is_error

Whether the request resulted in an error.


is_fraud_detected

Whether the fraud detection request resulted in a fraud detection.


is_payment_allowed

When the fraud detection request allowed the source payment to be processed.


is_third_party_integration

Whether the request was sent to a third party integration.


iso_currency

ISO 4217 currency code.


license_keys

An array of RevCent license key ID's associated with the item.


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.


pending_refunds

An array containing pending refund IDs related to the item.


product_sales

An array containing product sale IDs related to the item.


quota_accounts

An array containing quota account IDs related to the item.


raw_response

The raw response returned from the third party when originally contacted.


revcent_shop

The RevCent hosted shopping cart that item originated from.


sale_id

The RevCent ID of the sale.


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_fraud_detection_id

The third party ID for the request.


third_party_integration

Third party integration.


id

The ID of your RevCent third party integration.


name

The name of your RevCent third party integration.


third_party

Details on the specific third party.


id

The RevCent ID for the third party.


name

The name of the third party.




third_party_shop

The third party shop 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.


usage_account_invoices

An array containing usage account invoice IDs related to the item.


usage_accounts

An array containing usage account IDs related to the item.


usage_item_entries

An array containing usage item entry IDs related to the item.


usage_item_invoices

An array containing usage item invoice IDs related to the item.


usage_items

An array containing usage item IDs related to the item.



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

{
  "request": {
    "type": "fraud_detection_request",
    "method": "retrieve",
    "id": "RJ8a2blwBlFbbwPppNZA"
  }
}

Response JSON

{
  "api_call_id": "j08r887w1ahVE88gl0z5",
  "api_call_processed": true,
  "api_call_unix": 1611257424,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "fraud_detection_request",
  "results": [
    {
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "chargebacks": [],
      "check_directs": [],
      "created_date_unix": 1611181895,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "fraud_detections": [],
      "id": "RJ8a2blwBlFbbwPppNZA",
      "integration_mode": "Test",
      "invoices": [],
      "is_error": false,
      "is_fraud_detected": false,
      "is_payment_allowed": true,
      "is_third_party_integration": true,
      "iso_currency": "USD",
      "license_keys": [],
      "live_mode": false,
      "metadata": [
        {
          "name": "kount_session_id",
          "value": "c8ed4debf8f242be972c1071731052e8",
          "entry_date": "2021-01-20"
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "Wmv2Bb1nOdu55kl22JKV"
      ],
      "quota_accounts": [],
      "raw_response": "",
      "revcent_shop": null,
      "sale_id": "Nk4OV6Wdm5INNEPXXVr7",
      "sales": [
        "Nk4OV6Wdm5INNEPXXVr7"
      ],
      "salvage_transactions": [],
      "shipping": [
        "0pKAO9JoNYFrrNall7Xp"
      ],
      "smtp_messages": [],
      "status": "Success",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [
        "k6a8rV2nw9FLLO9GGXvy"
      ],
      "third_party_fraud_detection_id": "DWKW0YW258ZM",
      "third_party_integration": {
        "id": "ajYRoLokyXf62qy06JpZ",
        "name": "Kount Risk Inquiry",
        "third_party": {
          "id": "mJEZdyVavzUL0gGoLR1Z",
          "name": "Kount"
        }
      },
      "third_party_shop": null,
      "transactions": [
        "zGWVMkz0m0h22EMLL61r"
      ],
      "trials": [],
      "updated_date_unix": 1611181898,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_entries": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Invoice

An Invoice is a pending sale with an option to pay online. The only difference between an invoice and a vanilla pending sale is the Hosted Page integration, allowing the customer to pay the amount due online at via a customizable web page.

Invoice Create

Create an invoice via the invoice create method. All fields that are available in a regular Sale Create API call, with the exception of the payment object, are also available i.e. discounts, shipping, etc.

AdWords Integration

If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID.

Example

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


invoice_type

The invoice type. Always set to "sale_create".


invoice_profile

The invoice profile ID to associate with the invoice being created. This determines the hosted page markup and URL.


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.


iso_currency

ISO 4217 currency code. If not provided default is 'USD'.


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, SKU, 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.



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.


first_name

last_name

address_line_1

address_line_2

city

state

zip

country

company

email

phone



Response JSON Schema


amount_total

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


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

The customer object.


address_line_1

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



customer_id

The RevCent ID of the customer.


hosted_url

The Hosted Page URL for online payment.


invoice_id

The newly created invoice ID.


invoice_profile

id

The RevCent ID of the object item.


name

The name of the item.



iso_currency

ISO 4217 currency code.


metadata

The metadata array containing name:value objects.


entry_date

name

The name property for the metadata object.


value

The value property for the metadata object.



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 sale ID for the invoice.


status

The current status of the related item.


Request JSON

{
  "request": {
    "type": "invoice",
    "method": "create",
    "invoice_type": "sale_create",
    "invoice_profile": "gYo0YVd24Qf7QvdBYM2O",
    "iso_currency": "USD",
    "product": [
      {
        "id": "av_2017",
        "price": 19.99,
        "quantity": 2
      }
    ],
    "campaign": "Adwords Campaign",
    "customer": {
      "first_name": "vqjh",
      "last_name": "slszhjru",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ctnb@gmail.com",
      "phone": "1234567890"
    },
    "metadata": [
      {
        "name": "invoice_create",
        "value": "test"
      }
    ]
  }
}

Response JSON

{
  "amount_total": 176.79,
  "api_call": {
    "id": "ZVRV87lEoLuKWJY5gg8z"
  },
  "api_call_id": "ZVRV87lEoLuKWJY5gg8z",
  "api_call_processed": true,
  "api_call_unix": 1602980700,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "johndoe@gmail.com",
    "enabled": true,
    "first_name": "John",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "cus_0001",
    "last_name": "Doe",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "customer_id": "8rQrl21wjYcvJkzLaad8",
  "hosted_url": "https://securehost.revcent.com/MyCompanyName/invoice?invoice_id=ajqjGdVO9Bi1Ly2nkkW7",
  "invoice_id": "ajqjGdVO9Bi1Ly2nkkW7",
  "invoice_profile": {
    "id": "gYo0YVd24Qf7QvdBYM2O",
    "name": "tqawqtq"
  },
  "iso_currency": "USD",
  "metadata": [
    {
      "entry_date": "2020-10-18",
      "name": "invoice_create",
      "value": "test"
    }
  ],
  "request_method": "create",
  "request_type": "invoice",
  "result": "Invoice created.",
  "sale_id": "mJqJ6mnGbrUwmG0q22V9",
  "status": "Unpaid"
}

Invoice Retrieve

Retrieve current information on a single invoice or multiple invoices.

Please view Pagination and Filters for details on retrieving multiple items.

The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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_original_total

The total calculated amount when an item is 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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



date_paid

discounts

An array containing discounts related to the item.


download_url

hosted_url

id

The RevCent ID of the object item.


invoice_profile

id

The RevCent ID of the object item.


name

The name of the item.



is_sale

is_subscription_renewal

iso_currency

ISO 4217 currency code.


license_keys

An array of RevCent license key ID's associated with the item.


offline_payments

An array containing offline payment IDs related to the item.


paid

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.


quota_accounts

An array containing quota account IDs related to the item.


revcent_shop

The RevCent hosted shopping cart that item originated from.


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.


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.


usage_account_invoices

An array containing usage account invoice IDs related to the item.


usage_accounts

An array containing usage account IDs related to the item.


usage_item_invoices

An array containing usage item invoice IDs related to the item.


usage_items

An array containing usage item IDs related to the item.


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

{
  "request": {
    "type": "invoice",
    "method": "retrieve",
    "id": "bOqOV2gJ6nca1aKq1Ezb"
  }
}

Response JSON

{
  "api_call_id": "d959LvNN6ytzWzGvW5J6",
  "api_call_processed": true,
  "api_call_unix": 1602978780,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "invoice",
  "results": [
    {
      "amount_original_total": 176.79,
      "amount_total": 176.79,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1602978433,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "date_paid": null,
      "discounts": [],
      "download_url": "",
      "hosted_url": "https://securehost.revcent.com/MyCompanyName/invoice?invoice_id=bOqOV2gJ6nca1aKq1Ezb",
      "id": "bOqOV2gJ6nca1aKq1Ezb",
      "invoice_profile": {
        "id": "gYo0YVd24Qf7QvdBYM2O",
        "name": "tqawqtq"
      },
      "is_sale": true,
      "is_subscription_renewal": false,
      "iso_currency": "USD",
      "license_keys": [],
      "metadata": [
        {
          "entry_date": "2020-10-17",
          "name": "invoice_create",
          "value": "test"
        }
      ],
      "notes": [],
      "offline_payments": [],
      "paid": false,
      "payment_type": null,
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [],
      "quota_accounts": [],
      "revcent_shop": null,
      "sales": [
        "4ryrgOZkvAtKNK9wNv8l"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Unpaid",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [],
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1602978433,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_invoices": [],
      "usage_items": [],
      "void": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

License Key

A license key is created via web app import, remote request or auto generated by RevCent. A license key is issued when a product is purchased that has an attached license key profile.

License Key Retrieve

Retrieve current information on a single license key or multiple license keys.

Please view Pagination and Filters for details on retrieving multiple items.

The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


id

The RevCent ID of the license key OR the license key value. Required if multiple property equals false or is not present.



Response JSON Schema


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.


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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts related to the item.


enabled

Whether the license key is currently enabled.


expired_date

The date the license key was expired. Only for keys with a license key profile with expired settings.


expired_date_unix

The date as a unix timestamp the license key was expired. Only for keys with a license key profile with expired settings.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


invoices

An array containing invoice IDs related to the item.


is_expired

Whether the license key is expired after being issued.


is_issued

Whether the license key has been issued as a result of a successful purchase.


issued_date

The date the license key was issued as a result of a successful purchase.


issued_date_unix

The date as a unix timestamp the license key was issued as a result of a successful purchase.


license_key_profile

The license key profile related to the license key.


id

The RevCent ID of the object item.


name

The name of the item.



license_key_source

The source of the license key. Remote, imported or RevCent generated.


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.


sale

id

The RevCent ID of the object 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

The third party shop 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.


usage_account_invoices

An array containing usage account invoice IDs related to the item.


usage_accounts

An array containing usage account IDs related to the item.


usage_item_invoices

An array containing usage item invoice IDs related to the item.


usage_items

An array containing usage item IDs related to the item.



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

{
  "request": {
    "type": "license_key",
    "method": "retrieve",
    "id": "0pZwRNgwKwIXvMKKBbpZ"
  }
}

Response JSON

{
  "api_call_id": "KngPNGlrqvikawbWlGXr",
  "api_call_processed": true,
  "api_call_unix": 1592237703,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "license_key",
  "results": [
    {
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "check_directs": [],
      "created_date_unix": 1591892064,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [
        "LYg5NmwXlYhJoyll4wgZ"
      ],
      "enabled": true,
      "expired_date": null,
      "expired_date_unix": null,
      "id": "0pZwRNgwKwIXvMKKBbpZ",
      "internal_id": "",
      "invoices": [],
      "is_expired": false,
      "is_issued": true,
      "issued_date": "2020-06-11T16:14:30+00:00",
      "issued_date_unix": 1591892070,
      "license_key_profile": {
        "id": "0pZwpLpPw4UrdOkQpqyv",
        "name": "Imported Keys Only"
      },
      "license_key_source": "imported",
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "P6g5kEaEzjt6VyllpEGL"
      ],
      "sale": {
        "id": "qZEBboR8W0hOPpVV02rZ"
      },
      "sales": [
        "qZEBboR8W0hOPpVV02rZ"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Enabled",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [
        "ZV7EmNBNP5TA7122OyKX"
      ],
      "third_party_shop": null,
      "transactions": [
        "EMgw2p6q5MfEnm55pPag"
      ],
      "trials": [],
      "updated_date_unix": 1591892070,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

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 type of request being made.


method

The method for the request type.


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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts 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

{
  "request": {
    "type": "check_direct",
    "method": "retrieve",
    "id": "GO51EXbbAPS6pP1Ov9kK"
  }
}

Response JSON

{
  "api_call_id": "9rdXJQ5z4bcLYqLkV656",
  "api_call_processed": true,
  "api_call_unix": 1566160507,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "check_direct",
  "results": [
    {
      "amount": 201.58,
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "check_number": "",
      "created_date_unix": 1565832518,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "GO51EXbbAPS6pP1Ov9kK",
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "5r1MyL99VouMNRl9Pnkd",
        "d9ZolGRRwnu6lZb2Jo64",
        "WmPn2q99GzSKXWmbJjVd"
      ],
      "received": true,
      "sales": [
        "1rQAp8MM46uzN4Rw0Kgk"
      ],
      "salvage_transactions": [],
      "shipping": [
        "X8anGkNN5XfZK5mK06VX"
      ],
      "smtp_messages": [],
      "status": "Received",
      "subscription_renewals": [],
      "subscriptions": [
        "nbM1P5aa2VfNvVJvWjb1",
        "WmPn2q99GzSKRnQjZmkz"
      ],
      "tax": [
        "k6vn8JZZAmUv8G5z6klR"
      ],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop",
        "shop_url": "myshop.com"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1565832519
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Credit Card

Credit card payments are supported via merchant gateway integrations. Integrate a merchant gateway within the RevCent web app. Once integrated you can conduct most payment actions, and RevCent updates transaction status to reflect payment settlement.

Transaction

A credit card transaction can be two types, either a payment is captured, or a refund where a previous payment is refunded. RevCent only supports the auth-capture method when processing a payment, auth-only is not supported.

Transaction Create Refund

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.



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

{
  "request": {
    "type": "transaction",
    "method": "create_refund",
    "transaction_id": "ALRjyqRE27fjMonyKLny",
    "amount": 1.25
  }
}

Response JSON

{
  "amount": 1.25,
  "api_call_id": "0pwokmGgzRc0yg8dXp7q",
  "api_call_processed": true,
  "api_call_unix": 1565814903,
  "code": 1,
  "origin_campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "origin_customer_id": "4r158EzJmmcVM69dNLkg",
  "origin_sale_id": "k6vnbJom00Ug89mpRj78",
  "origin_transaction_id": "ALRjyqRE27fjMonyKLny",
  "pending_refund": [
    "MW5LoAVymnHww96XllEr",
    "vEwWrAjn8RcM9yQdyjOy",
    "9rdEMaP59RuYg41zRJwW",
    "Nk5voyEw8YiOmaRvjgyG"
  ],
  "product_sale_refunded": [
    "LY5yop5nk7hbPzpBn8aY",
    "9rdEMadyZ7uYgnbKWwX5"
  ],
  "request_method": "create_refund",
  "request_type": "transaction",
  "result": "Pending refund created for transaction.",
  "shipping_refunded": [
    "gYamRbaGZphKn8zJVow1"
  ],
  "tax_refunded": [
    "ALRjyqRE27fjjpmRzBRd"
  ]
}

Transaction Retrieve

Retrieve current information on a single transaction or multiple transactions.

Please view Pagination and Filters for details on retrieving multiple items.

The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



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


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

{
  "request": {
    "type": "transaction",
    "method": "retrieve",
    "id": "ALRjyqRE27fjMonyKLny"
  }
}

Response JSON

{
  "api_call_id": "o1jGw57PVgFLLMJ8VJW7",
  "api_call_processed": true,
  "api_call_unix": 1565814903,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "transaction",
  "results": [
    {
      "amount": 111.86,
      "amount_captured": 111.86,
      "amount_fees": 3.02,
      "amount_gross": 111.86,
      "amount_net": 108.84,
      "amount_original_total": 111.86,
      "amount_refunded": 0,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_total": 111.86,
      "amount_void": 0,
      "approved": true,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "captured": true,
      "check_directs": [],
      "code": 1,
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "customer_card": {
        "type": "visa",
        "id": "1rQA58w6XXcMNRApYLPn",
        "last_4": "4242",
        "created_date_unix": 1565814899,
        "updated_date_unix": 1565814901,
        "exp_date": "04/22",
        "exp_month": 4,
        "exp_year": 2022
      },
      "declined": false,
      "details_last_updated_unix": null,
      "details_response": "",
      "discounts": [],
      "error": false,
      "gateway_id": "NkAMJOzpB5iEAOrdloV0",
      "gateway_name": "Braintree",
      "has_salvage": true,
      "held": false,
      "id": "ALRjyqRE27fjMonyKLny",
      "is_payment_profile": false,
      "is_refund": false,
      "is_salvage": false,
      "is_subscription": false,
      "is_subscription_renewal": false,
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_profile": {
        "id": "ajyXm76OpjSL4p5oO2By",
        "name": "AuthBrainStripe",
        "results": null
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "9rdEMadyZ7uYgnbKWwX5",
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "result": "Approved",
      "sale_initial": true,
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "settled": false,
      "shipping": [
        "gYamRbaGZphKn8zJVow1"
      ],
      "smtp_messages": [],
      "status": "Fully Captured",
      "subscription_profile": null,
      "subscription_renewals": [],
      "subscriptions": [
        "o1jGw5jY2RILLl4dBMwa"
      ],
      "tax": [
        "ALRjyqRE27fjjpmRzBRd"
      ],
      "third_party_shop": null,
      "trials": [],
      "updated_date_unix": 1565814901,
      "void": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Offline Payment

An offline payment is essentially a cash or any other means of exchange which needs to be recorded. Offline payments are also useful during replacements, rebates, etc.

Offline Payment Refund

To refund an offline payment you instead refund the entity that the refund is associated with, i.e. sale, product_sale, tax, shipping, etc.

Offline Payment Retrieve

Retrieve current information on a single offline payment or multiple offline payments.

Please view Pagination and Filters for details on retrieving multiple items.

The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts 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

{
  "request": {
    "type": "offline_payment",
    "method": "retrieve",
    "id": "zGldyKJGORfkP1O1vJ4B"
  }
}

Response JSON

{
  "api_call_id": "gYagkq56lAsJn0K98Y4M",
  "api_call_processed": true,
  "api_call_unix": 1566160508,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "offline_payment",
  "results": [
    {
      "amount": 255.92,
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "Twitter Campaign",
      "check_directs": [],
      "created_date_unix": 1565830657,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [
        "6r1EpBQrbRCz91q8E6qb"
      ],
      "id": "zGldyKJGORfkP1O1vJ4B",
      "notes": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "BvwOk6VvpEs17GrozWaa",
        "gYamd2VYr9h4M5zOE7zN",
        "o1jGQnO1m4iQWpYjNaB6"
      ],
      "sales": [
        "4r15pjKr4RCraznBnvZ1"
      ],
      "salvage_transactions": [],
      "shipping": [
        "qZBAQK9Zabf4KgXRPmvA"
      ],
      "smtp_messages": [],
      "status": "Complete",
      "subscription_renewals": [],
      "subscriptions": [
        "Kn51QPBnE9iGE5mmBRqA"
      ],
      "tax": [
        "bOBywapOAGtjzk9PjWyd"
      ],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop",
        "shop_url": "myshop.com"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1565830657
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

PayPal

Integrate your PayPal account(s) with RevCent using the web app and PayPal API credentials. Integrating PayPal with RevCent has several benefits, including dispute detection. PayPal payments made via third party shops and hosted pages are automatically integrated within RevCent.

PayPal Dispute

Once you have integrated your PayPal account with RevCent, we will continuously monitor your PayPal account for any disputes.

RevCent will create a dispute item when a new dispute is found, and attempt to link the specific dispute to a known PayPal transaction within RevCent. Dispute action must be taken within PayPal. We do plan, in the future, to add the ability to take action within RevCent.

PayPal Dispute Retrieve

Retrieve current information on a single PayPal dispute or multiple PayPal disputes.

Please view Pagination and Filters for details on retrieving multiple items.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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

{
  "request": {
    "type": "paypal_dispute",
    "method": "retrieve",
    "id": "wLzYlmJdqGiM0RlvvLKp"
  }
}

Response JSON

{
  "api_call_id": "ZVE5YRjd7RsXdJmN02pp",
  "api_call_processed": true,
  "api_call_unix": 1566160506,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "paypal_dispute",
  "results": [
    {
      "created_date_unix": 1565956199,
      "id": "wLzYlmJdqGiM0RlvvLKp",
      "paypal_account": {
        "id": "mJVWkmzVz0i42j0GEVK4",
        "name": "My PayPal Account",
        "paypal_account_email": "myemail@gmail.com"
      },
      "paypal_details_response": "",
      "paypal_dispute_amount": 89.98,
      "paypal_dispute_created_date": "2019-08-16T09:27:24+00:00",
      "paypal_dispute_created_date_unix": 1565947644,
      "paypal_dispute_id": "PP-D-XXXXXXXXX",
      "paypal_dispute_outcome": "",
      "paypal_dispute_updated_date": "2019-08-16T10:31:35+00:00",
      "paypal_dispute_updated_date_unix": 1565951495,
      "paypal_messages": [
        {
          "posted_by": "BUYER",
          "time_posted": "2019-08-16T09:27:30.000Z",
          "content": "Did not receive product."
        }
      ],
      "paypal_reason": "MERCHANDISE_OR_SERVICE_NOT_RECEIVED",
      "paypal_status": "OPEN",
      "updated_date_unix": 1566129063
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

PayPal Transaction

A PayPal transaction is created within RevCent when a PayPal sale takes place via shopping cart plugin or a RevCent hosted page. RevCent confirms all transactions with PayPal and receives transaction details via the PayPal API.

RevCent also monitors your PayPal account for disputes, and will link disputes to existing transactions when detected.

PayPal Transaction Refund

To refund a PayPal transaction you instead refund the entity that the refund is associated with, the same as you would a credit card transaction. Refunding a sale, shipping, or tax will automatically refund any PayPal transactions using the PayPal API.

PayPal Transaction Retrieve

Retrieve current information on a single PayPal transaction or multiple PayPal transactions.

Please view Pagination and Filters for details on retrieving multiple items.

The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts 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_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

{
  "request": {
    "type": "paypal_transaction",
    "method": "retrieve",
    "id": "k6omOdKbrRTZnpP6d7Ng"
  }
}

Response JSON

{
  "api_call_id": "4r1ZLyqwrvcq9qLbA0qo",
  "api_call_processed": true,
  "api_call_unix": 1566160506,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "paypal_transaction",
  "results": [
    {
      "amount_captured": 0.01,
      "amount_fees": 0,
      "amount_gross": 0.01,
      "amount_net": 0.01,
      "amount_original_total": 0.01,
      "amount_refunded": 0,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_total": 0.01,
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "Twitter Campaign",
      "check_directs": [],
      "created_date_unix": 1562082423,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "k6omOdKbrRTZnpP6d7Ng",
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "paypal_account": {
        "id": "mJVWkmzVz0i42j0GEVK4",
        "name": "My PayPal Account",
        "paypal_account_email": "myemail@gmail.com"
      },
      "paypal_customer_id": null,
      "paypal_transaction_amount": 0.01,
      "paypal_transaction_date": "2019-07-02T15:46:58+00:00",
      "paypal_transaction_date_unix": 1562082418,
      "paypal_transaction_id": "XXXXXXXXXXXX",
      "pending_refunds": [
        "vEn8K4MKavIRAyw0NVbR"
      ],
      "product_sales": [
        "7rgo91jKVmtYk8NBnnNm"
      ],
      "sales": [
        "MWymZv5d6bSpQLl1ARMm"
      ],
      "salvage_transactions": [],
      "shipping": [
        "qZ4vKalGg5tv298VvO8V"
      ],
      "smtp_messages": [],
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1562082510
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Pending Refund

All credit card transactions, paypal transactions, checks and offline payments create a pending refund when refunded. RevCent 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 type of request being made.


method

The method for the request type.


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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts 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

{
  "request": {
    "type": "pending_refund",
    "method": "retrieve",
    "id": "MW5LoAVymnHww96XllEr"
  }
}

Response JSON

{
  "api_call_id": "bOBy95a444sy46EMwBj1",
  "api_call_processed": true,
  "api_call_unix": 1565814904,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "pending_refund",
  "results": [
    {
      "amount": 0.89,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1565814903,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "gateway_id": "NkAMJOzpB5iEAOrdloV0",
      "gateway_name": "Braintree",
      "id": "MW5LoAVymnHww96XllEr",
      "is_check_direct": false,
      "is_offline_payment": false,
      "live_mode": false,
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "processed": false,
      "product_sales": [
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "refund_transaction_id": "ALRjyqRE27fjMonyKLny",
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "shipping": [],
      "smtp_messages": [],
      "status": "Processing",
      "subscription_renewals": [],
      "subscriptions": [],
      "success_transaction_id": null,
      "tax": [],
      "trials": [],
      "updated_date_unix": 1565814903
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Product

Create, edit, enable, disable and delete products using the RevCent API. Keep product details and other information up to date.

Product Create

Create a product via the product create method.

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.





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

{
  "request": {
    "type": "product",
    "method": "create",
    "product": {
      "max_quantity_allowed": 0,
      "subscription_profile": "d9NXVR62vGfYMw6VEZOl",
      "shipping_attributes": {
        "rate": "",
        "weight": "",
        "length": "",
        "width": "",
        "height": "",
        "fulfillment_account": "j0o25b2YJRFdJb8EEXE1"
      },
      "additional_id": [
        {
          "name": "another_id",
          "value": "id_123"
        }
      ],
      "product_group": [
        "EMYlAaXA1yfkWWora9rG"
      ],
      "name": "New Product",
      "description": "New product description.",
      "sku": "new_product_sku",
      "price": 12.99,
      "price_trial": 12.99,
      "price_subscription": 19.99,
      "trial_shipping_setting": "both_trial_expiration_creation",
      "trial_days": 5,
      "enabled": true,
      "is_shippable": true
    }
  }
}

Response JSON

{
  "api_call_id": "EMwJyj8bdEfX9YwmR2EW",
  "api_call_processed": true,
  "api_call_unix": 1565814920,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "product_name": "New Product",
  "request_method": "create",
  "request_type": "product",
  "result": "Created new product."
}

Product Edit

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.





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

{
  "request": {
    "type": "product",
    "method": "edit",
    "product_id": "qZBAz5nL0RfBgpgg2r49",
    "product": {
      "max_quantity_allowed": 2,
      "subscription_profile": "d9NXVR62vGfYMw6VEZOl",
      "shipping_attributes": {
        "fulfillment_account": "j0o25b2YJRFdJb8EEXE1"
      },
      "name": "New Product Name",
      "price": 12.99,
      "price_trial": 12.99,
      "price_subscription": 19.99,
      "trial_shipping_setting": "both_trial_expiration_creation",
      "trial_days": 3,
      "enabled": true,
      "is_shippable": true
    }
  }
}

Response JSON

{
  "api_call_id": "VPm9MqdqLzUJJ1GNdyqR",
  "api_call_processed": true,
  "api_call_unix": 1565814921,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "request_method": "edit",
  "request_type": "product",
  "result": "Product successfully modified."
}

Product Enable

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



Request JSON

{
  "request": {
    "type": "product",
    "method": "enable",
    "product_id": "qZBAz5nL0RfBgpgg2r49"
  }
}

Response JSON

{
  "api_call_id": "ZVEGoylyMacZZ1XkLX1M",
  "api_call_processed": true,
  "api_call_unix": 1565814921,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "request_method": "enable",
  "request_type": "product",
  "result": "Product successfully enabled."
}

Product Disable

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



Request JSON

{
  "request": {
    "type": "product",
    "method": "disable",
    "product_id": "qZBAz5nL0RfBgpgg2r49"
  }
}

Response JSON

{
  "api_call_id": "YaVqjAdAG8tGGYALrzMg",
  "api_call_processed": true,
  "api_call_unix": 1565814921,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "request_method": "disable",
  "request_type": "product",
  "result": "Product successfully disabled."
}

Product Delete

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



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

{
  "request": {
    "type": "product",
    "method": "delete",
    "product_id": "qZBAz5nL0RfBgpgg2r49"
  }
}

Response JSON

{
  "api_call_id": "bOBy95E8awiypP4046jm",
  "api_call_processed": true,
  "api_call_unix": 1565814922,
  "code": 1,
  "product_id": "qZBAz5nL0RfBgpgg2r49",
  "request_method": "delete",
  "request_type": "product",
  "result": "Product successfully deleted."
}

Product Retrieve

Retrieve current information on a single product or multiple products.

Please view Pagination and Filters for details on retrieving multiple items.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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.


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

{
  "request": {
    "type": "product",
    "method": "retrieve",
    "id": "qZBAz5nL0RfBgpgg2r49"
  }
}

Response JSON

{
  "api_call_id": "bOBy95m1E7TypJ7X2lvL",
  "api_call_processed": true,
  "api_call_unix": 1565814920,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "product",
  "results": [
    {
      "additional_id": [
        {
          "name": "another_id",
          "value": "id_123"
        }
      ],
      "asin": "",
      "brand": "",
      "condition": "",
      "cost": null,
      "created_date_unix": 1565814920,
      "description": "New product description.",
      "discount_rate": null,
      "ean": "",
      "enabled": true,
      "id": "qZBAz5nL0RfBgpgg2r49",
      "images": [],
      "images_url": "productimg.revcent.com",
      "in_stock": true,
      "internal_id": "An7W08XVj_internal_id",
      "is_child_product": false,
      "is_discount": false,
      "is_price_sale": false,
      "is_shippable": true,
      "isbn": "",
      "max_quantity_allowed": 0,
      "metadata": [],
      "mpn": "",
      "msrp": null,
      "name": "New Product",
      "parent_product": null,
      "price": 12.99,
      "price_sale": null,
      "price_subscription": 19.99,
      "price_trial": 12.99,
      "product_group": [
        {
          "id": "EMYlAaXA1yfkWWora9rG",
          "name": "My Product Group"
        }
      ],
      "rating_value": null,
      "review_count": null,
      "shipping_attributes": {
        "height": null,
        "width": null,
        "length": null,
        "weight": null,
        "rate": null,
        "fulfillment_account": {
          "id": "j0o25b2YJRFdJb8EEXE1",
          "name": "ShipWorks"
        },
        "shipping_profile": null
      },
      "sku": "new_product_sku",
      "stock": 0,
      "subscription_profile": {
        "id": "LYE26aKJpPi5VbJmlp2A",
        "name": "Monthly",
        "description": "",
        "occurrences": "specific",
        "occurrences_value": 3,
        "subscription_specific": false,
        "subscription_id": null,
        "frequency_unit": {
          "unit_value": 1,
          "unit": "months"
        },
        "frequency_calendar": {},
        "frequency_fiscal": {},
        "frequency": "unit"
      },
      "third_party_shop": null,
      "trial_days": 5,
      "trial_shipping_setting": "both_trial_expiration_creation",
      "upc": "",
      "updated_date_unix": 1565814920
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Product Sale

A product sale is a sale on a per product basis. This allows us to provide advanced metrics on a product specific level.

Product Sale Refund

If you wish to void a product sale simply leave out the amount property in the request. If you wish to partially refund a product sale then include the amount property with the value amount to refund. If including the entire product sale amount then it will be void automatically. It is important to note that if a product sale is voided it is irreversible.

Request JSON Schema


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.



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

{
  "request": {
    "type": "product_sale",
    "method": "refund",
    "product_sale_id": "zGld6plAkacWRzRwblaJ",
    "amount": 2.25
  }
}

Response JSON

{
  "amount": 2.25,
  "api_call_id": "Kn51oqRdpbcyyEPpzQj5",
  "api_call_processed": true,
  "api_call_unix": 1565814910,
  "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
  "campaign_name": "Facebook Campaign",
  "code": 1,
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "pending_refund": [
    "BvwOyAod0NC221Z7A5mV"
  ],
  "product_sale_id": "zGld6plAkacWRzRwblaJ",
  "request_method": "refund",
  "request_type": "product_sale",
  "result": "Product sale refunded in the amount of $2.25.",
  "sale_id": "k6vnbJom00Ug89mpRj78",
  "subscription_cancelled": [],
  "trial_cancelled": []
}

Product Sale Retrieve

Retrieve current information on a single product sale or multiple product sales.

Please view Pagination and Filters for details on retrieving multiple items.

The response may include AdWords Response Objects within each item if an AdWords click ID is associated with the item.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



discounts

An array containing discounts related to the item.


id

The RevCent ID of the object item.


internal_id

The internal_id you provided when creating the item.


iso_currency

ISO 4217 currency code.


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.


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

{
  "request": {
    "type": "product_sale",
    "method": "retrieve",
    "id": "zGld6plAkacWRzRwblaJ"
  }
}

Response JSON

{
  "api_call_id": "X8anMkRdEmcbbGM9Gmwr",
  "api_call_processed": true,
  "api_call_unix": 1565814910,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "product_sale",
  "results": [
    {
      "amount_captured": 149.99,
      "amount_discounted": 0,
      "amount_fees": 4.35,
      "amount_gross": 149.99,
      "amount_net": 145.64,
      "amount_original_total": 149.99,
      "amount_refunded": 0,
      "amount_remaining": 0,
      "amount_settled": 0,
      "amount_to_salvage": 0,
      "amount_total": 149.99,
      "amount_void": 0,
      "campaign_id": "X849YQm7BEf0ZQd7Ol1K",
      "campaign_name": "Facebook Campaign",
      "check_directs": [],
      "created_date_unix": 1565814901,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "zGld6plAkacWRzRwblaJ",
      "internal_id": "robo_vac",
      "iso_currency": "USD",
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku",
        "name": "Robo Vac",
        "quantity": 1,
        "price": 149.99,
        "list_price": 149.99
      },
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Fully Captured",
      "subscription_renewals": [],
      "subscriptions": [
        "WmPnWqPKbpFRmy6Ma2BG"
      ],
      "tax": [
        "P65Gn2J15pc5KRdLp22w"
      ],
      "third_party_shop": null,
      "transactions": [
        "wLz5MAWPzoUW5VNlydoa"
      ],
      "trials": [
        "LY5yop5nk7hb6o2Pvl5j"
      ],
      "updated_date_unix": 1565814909
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Quota

RevCent supports quota based products, where a customer purchases a certain amount of "units" and has a running balance via a quota account. Create a sale containing one or more quota based products and utilize the RevCent API to manage all aspects of quota based revenue. Subsequent purchases by an existing customer will automatically credit the running balance of the customers' existing quota account. Send requests to retrieve a customers' balance, credit or debit the balance as well as retrieve ledger entries for a quota account. Read more detailed information and use cases on quota billing at our Knowledge Base

Quota Account: A quota account is created when one or more quota products is initially sold to a customer without an existing quota account. The quota account is specific to a customer and contains a running balance of quota units, each quota unit being the quota product sold with specific unit amounts. If a quota account already exists for a customer, then their quota account will receive appropriate unit credits upon subsequent purchases.

Quota Account Ledger Entry: A quota account ledger entry is created by RevCent when any action that affects the balance of a customers' quota account, via web or API, occurs. An entry will be created for either the purchase of a unit product, a quota account debit or a quota account credit. You are able to set metadata during an API request (sale create, account debit, account credit) which will attach to the ledger entry, allowing you to record and gather metrics for credits and debits.

Quota Unit Group: A quota unit group is the organization of quota units. A quota account for a customer is created based on the quota unit group that was initially purchased. This allows you to implement multiple brands without cross balance conflicts and better metrics tracking, i.e. The customer may have two quota accounts, but units are separated by unit group (brand).

Quota Unit: A quota unit is the actual unit the customer is purchasing, i.e. "Phone Minute" or "App Currency". When you create a quota based product you associate a quota unit and set a unit amount. When a quota based product is purchased, the unit amount specified in the product is credited to a customers' quota account. Multiple products can contain the same unit, allowing you to sell varying unit amounts at custom prices, i.e. 100 Minutes or 1000 Minutes. You can set a unit amount of 1 and allow units to be purchased based on product quantity as well.

Request JSON

{
  "request": {
    "type": "quota_account",
    "method": "credit",
    "quota_account_id": "0pP7L8X7Xoi0AG7k8Y5L",
    "quota_unit_id": "d9JqY40GoYc7WvVA2dgz",
    "unit_amount": 5,
    "metadata": [
      {
        "name": "metadata name",
        "value": "metadata value"
      }
    ]
  }
}

Response JSON

{
  "api_call_id": "mJ2BopNGGyh64m256lEr",
  "api_call_processed": true,
  "api_call_unix": 1599619450,
  "code": 1,
  "ledger_entry_id": "8rWmO7qwwXh2mJar2XGV",
  "quota_account_id": "0pP7L8X7Xoi0AG7k8Y5L",
  "quota_account_units": [
    {
      "id": "8rWyaqo44bSavN79WwOO",
      "name": "Gold Token",
      "balance": 273
    },
    {
      "id": "6rnmX4jmGjcvW6AGKrwJ",
      "name": "Silver Token",
      "balance": 61
    },
    {
      "id": "d9JqY40GoYc7WvVA2dgz",
      "name": "Platinum Token",
      "balance": 10
    }
  ],
  "quota_unit_id": "d9JqY40GoYc7WvVA2dgz",
  "request_method": "credit",
  "request_type": "quota_account",
  "result": "Quota account unit Platinum Token credited a total of 5 units.",
  "unit_amount": 5
}

Request JSON

{
  "request": {
    "type": "quota_account",
    "method": "debit",
    "quota_account_id": "0pP7L8X7Xoi0AG7k8Y5L",
    "quota_unit_id": "8rWyaqo44bSavN79WwOO",
    "unit_amount": 5,
    "metadata": [
      {
        "name": "metadata name",
        "value": "metadata value"
      }
    ]
  }
}

Response JSON

{
  "api_call_id": "0pPXVYM1Qnhl2NjolqAA",
  "api_call_processed": true,
  "api_call_unix": 1599619405,
  "code": 1,
  "ledger_entry_id": "6rn5MJ4yvPSBJ6mjByZ1",
  "quota_account_id": "0pP7L8X7Xoi0AG7k8Y5L",
  "quota_account_units": [
    {
      "id": "8rWyaqo44bSavN79WwOO",
      "name": "Gold Token",
      "balance": 273
    },
    {
      "id": "6rnmX4jmGjcvW6AGKrwJ",
      "name": "Silver Token",
      "balance": 61
    },
    {
      "id": "d9JqY40GoYc7WvVA2dgz",
      "name": "Platinum Token",
      "balance": 5
    }
  ],
  "quota_unit_id": "8rWyaqo44bSavN79WwOO",
  "request_method": "debit",
  "request_type": "quota_account",
  "result": "Quota account unit Gold Token debited a total of 5 units.",
  "unit_amount": 5
}

Request JSON

{
  "request": {
    "type": "quota_account",
    "method": "enable",
    "enabled": true,
    "quota_account_id": "JN0Zpj7RGJiwKqAnRoy6"
  }
}

Response JSON

{
  "api_call_id": "bOQYAM2P81i7YBo98wlL",
  "api_call_processed": true,
  "api_call_unix": 1586607193,
  "code": 1,
  "request_method": "enable",
  "request_type": "quota_account",
  "result": "Quota account set to enabled.",
  "quota_account_id": "EMLZvL2A6WS1oLazv4rm"
}

Request JSON

{
  "request": {
    "type": "quota_account",
    "method": "retrieve",
    "id": "EMLZvL2A6WS1oLazv4rm"
  }
}

Response JSON

{
  "api_call_id": "wLWPw9G2zASpO5PBGKYZ",
  "api_call_processed": true,
  "api_call_unix": 1599661039,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "quota_account",
  "results": [
    {
      "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
      "campaign_name": "Adwords Campaign",
      "check_directs": [],
      "created_date_unix": 1599445342,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "enabled": true,
      "id": "zGZqMWZ6EmFXRKvPzyZl",
      "invoices": [],
      "iso_currency": "USD",
      "license_keys": [],
      "metadata": [
        {
          "name": "re purchase account",
          "value": "test value",
          "entry_date": "2020-09-07"
        }
      ],
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "Q4JAvmJjlPT9JGNodQEz"
      ],
      "quota_account_units": [
        {
          "id": "8rWyaqo44bSavN79WwOO",
          "name": "Gold Token",
          "balance": 100
        },
        {
          "id": "d9JqY40GoYc7WvVA2dgz",
          "name": "Platinum Token",
          "balance": 10
        }
      ],
      "quota_unit_group": {
        "id": "6rnQQzm2mkSmrAorQ6ym",
        "name": "Currency Tokens"
      },
      "revcent_shop": null,
      "sales": [
        "MWKba6pVQztGVKm9PAad"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Enabled",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [
        "qZO6mGOa1JFXlrRbqPKw"
      ],
      "third_party_shop": null,
      "transactions": [
        "ALKOQGKzlrS0vXV4El6E"
      ],
      "trials": [],
      "updated_date_unix": 1599487612
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Request JSON

{
  "request": {
    "type": "quota_account_ledger_entry",
    "method": "retrieve",
    "id": "EMLZvL2A6WS1oLazv4rm"
  }
}

Response JSON

{
  "api_call_id": "j0EMk710oaFRY59MlEqp",
  "api_call_processed": true,
  "api_call_unix": 1599661292,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "quota_account_ledger_entry",
  "results": [
    {
      "created_date_unix": 1599503098,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "johndoe@gmail.com",
        "enabled": true,
        "first_name": "John",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "cus_0001",
        "last_name": "Doe",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "id": "X81WNRaG2ytO6r20Q9K4",
      "metadata": [
        {
          "name": "quota account",
          "value": "test value",
          "entry_date": "2020-09-07"
        }
      ],
      "method": "credit",
      "quota_account": {
        "id": "GOKmbYmVmyc5m5G9aE46"
      },
      "quota_unit": {
        "id": "6rnmX4jmGjcvW6AGKrwJ",
        "name": "Silver Token"
      },
      "quota_unit_group": {
        "id": "6rnQQzm2mkSmrAorQ6ym",
        "name": "Currency Tokens"
      },
      "unit_amount": 1,
      "updated_date_unix": 1599503098
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Quota Unit Group

A quota unit group is the organization of quota units. A quota account for a customer is created based on the quota unit group that was initially purchased. This allows you to implement multiple brands without cross balance conflicts and better metrics tracking, i.e. The customer may have two quota accounts, but units are separated by unit group (brand).

Quota Unit Group Retrieve

Retrieve current information on a single quota unit group or multiple unit groups.

Please view Pagination and Filters for details on retrieving multiple items.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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.


description

The description of the item.


enabled

Whether the item is enabled or disabled.


id

The RevCent ID of the object item.


name

The name 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

{
  "request": {
    "type": "quota_unit_group",
    "method": "retrieve",
    "id": "EMLZvL2A6WS1oLazv4rm"
  }
}

Response JSON

{
  "api_call_id": "zGZgzKy0bofkAl5VQAX7",
  "api_call_processed": true,
  "api_call_unix": 1599661400,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "quota_unit_group",
  "results": [
    {
      "created_date_unix": 1599221690,
      "description": "",
      "enabled": true,
      "id": "6rnQQzm2mkSmrAorQ6ym",
      "name": "Currency Tokens",
      "updated_date_unix": 1599612622
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Quota Unit

A quota unit is the actual unit the customer is purchasing, i.e. "Phone Minute" or "App Currency". When you create a quota based product you associate a quota unit and set a unit amount. When a quota based product is purchased, the unit amount specified in the product is credited to a customers' quota account. Multiple products can contain the same unit, allowing you to sell varying unit amounts at custom prices, i.e. 100 Minutes or 1000 Minutes. You can set a unit amount of 1 and allow units to be purchased based on product quantity as well.

Quota Unit Retrieve

Retrieve current information on a single quota unit or multiple units.

Please view Pagination and Filters for details on retrieving multiple items.

Request JSON Schema


request

The main request object.


type

The type of request being made.


method

The method for the request type.


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.


description

The description of the item.


enabled

Whether the item is enabled or disabled.


id

The RevCent ID of the object item.


name

The name of the item.


quota_unit_group

The quota unit group associated with the item.


id

The RevCent ID of the object item.


name

The name 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

{
  "request": {
    "type": "quota_unit",
    "method": "retrieve",
    "id": "EMLZvL2A6WS1oLazv4rm"
  }
}

Response JSON

{
  "api_call_id": "WmJwZQEl1pFrXOVa1XnQ",
  "api_call_processed": true,
  "api_call_unix": 1599661481,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "quota_unit",
  "results": [
    {
      "created_date_unix": 1599355824,
      "description": "",
      "enabled": true,
      "id": "6rnmX4jmGjcvW6AGKrwJ",
      "name": "Silver Token",
      "quota_unit_group": {
        "id": "6rnQQzm2mkSmrAorQ6ym",
        "name": "Currency Tokens"
      },
      "updated_date_unix": 1599355842
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Sale

A sale is one or more products sold. Shipping and tax can be manually provided or automatically created depending on your request and account settings. Several payment types are supported including credit card, PayPal, check and offline payment.

You also have the ability to create a pending sale without initially specifying a payment type, which saves the sale information to be finalized later. Refer to the Pending Sale section.

Sale Create

Create a new sale using the sale create API call. This is an important API call and we recommend viewing all property descriptions for both the request and response objects. Request object properties have some nuances depending on the product(s) being sold, tracking, customer, etc. Response object properties are useful for displaying information to a customer sale immediately after a payment is made.

AdWords Integration

If you wish to associate the item with a specific AdWords click ID include an "adwords_click" object in your request metadata array. RevCent will detect the specific metadata object with name="adwords_click" and pull data on the AdWords click ID.

Example

"metadata":[{"name": "adwords_click", "value": "ADWORDS_CLICK_ID_HERE"}]

Kount Integration

If you have setup Kount as a third party integration in RevCent, and wish to have Kount check the payment for fraud, include the "kount_session_id" object in your request metadata array. RevCent will detect the specific metadata object with name="kount_session_id" and perform the proper communication with Kount before sending the payment to the desired processor. Empty session IDs will result in an error from Kount.

Example

"metadata":[{"name": "kount_session_id", "value": "KOUNT_SESSION_ID_HERE"}]

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


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.



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.


iso_currency

ISO 4217 currency code. If not provided default is 'USD'.


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


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

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 a unique sale request. This allows you to successfully retry a failed API call without risk of charging a customer twice for the same sale. If a sale has been paid it will not allow future payments to be processed.


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.


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, SKU, 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.



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


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.


name

Tax name.


rate

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



coupon

The coupon array. Can contain multiple coupon objects, each containing a coupon code.


coupon_code

The coupon code.



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.




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
5 = Fraud Detected


customer

The customer object.


address_line_1

The customers' first address line.


address_line_2

The customers' second address line.


blocked

Whether the customer has been blocked from purchases.


city

The customers' city.


company

The customers' company.


country

The customers' country.


email

The customers' email.


enabled

Whether the customer is currently enabled.


first_name

The customers' first name.


full_address

The customers' full address.


geocode_success

Whether the customers' address was successfully geocoded using the Google geocoding service.


google_place_id

The Google place ID for the customers' address using the Google geocoding service.


id

The RevCent ID for the customer.


internal_id

Your internal ID for the customer.


last_name

The customers' last name.


lat

The approximate latitude for the customers' address using the Google geocoding service.


lon

The approximate longitude for the customers' address using the Google geocoding service.


phone

The customers' phone number.


state

The customers' state.


state_long

The customers' state in long format.


status

The customers' status.


zip

The customers' zip or postal code.



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.



fraud_detection_response

If fraud detection is active, the response from a detection request will be present. A fraud detection request is made prior to the payment attempt with the processor.


code

The request code. 1 = No fraud or no detection integrated. 5 = Fraud detected. 0 = Error.


message

The explained result of any fraud detection request related to the item.


fraud_detected

Whether fraud was detected before processing the items' related payment.


fraud_detection_created

Any fraud detections created.


fraud_detection_request

If fraud detection is integrated and a third party is contacted prior to payment, the details of a fraud detection request.


id

The RevCent ID of the object item.


third_party

Details on the specific third party.


id

The RevCent ID for the third party.


name

The name of the third party.



third_party_integration

id

The ID of your RevCent third party integration.


name

The name of your RevCent third party integration.



third_party_raw_response

The raw response returned from the third party when originally contacted.


third_party_fraud_detection_id

The third party ID for the request.


third_party_response_ms

The response time in milliseconds it took to receive a response from the third party integration.




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.


iso_currency

ISO 4217 currency code.


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.




quota_accounts

If any products purchased were quota based, then a quota account will be created or modified if already exists for the customer.


id

The quota account ID.


quota_unit_group

The quota unit group associated with the quota account.


id

The quota unit group ID.


name

The quota unit group name.



quota_account_units

An array of quota unit balances within the quota account. Displays current balance for each unit.


id

The quota unit ID.


name

The quota unit name.


balance

The quota unit balance within the quota account after the api call was processed.




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.




usage_account_created

If any product(s) were a usage/metered billing product, then usage account(s) will be created for each related products' usage profile billing period. Same period billing will group items into one usage account


id

The usage account ID.



usage_item_created

If any product(s) were a usage/metered billing product, then usage item(s) will be created for each related product.


id

The usage item ID.


product_sale

The product sale associated with the usage item.


id

The RevCent ID of the object item.



product

The product associated with the usage item.


id

The RevCent ID of the object item.


name

The name of the item.


internal_id

The internal_id you provided when creating the item.


sku

The product sku.



trial

The trial associated with the usage item, if applicable.


id

The RevCent ID of the object item.



usage_account

The usage account associated with the usage item.


id

The RevCent ID of the object item.




Request JSON

{
  "request": {
    "type": "sale",
    "method": "create",
    "payment": {
      "credit_card": {
        "card_number": "4242424242424242",
        "exp_month": 4,
        "exp_year": 22,
        "card_code": "000"
      },
      "payment_type": "credit_card"
    },
    "campaign": "Adwords Campaign",
    "iso_currency": "USD",
    "payment_profile": "AuthBrainStripe",
    "customer": {
      "first_name": "vqjh",
      "last_name": "slszhjru",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ctnb@gmail.com",
      "phone": "1234567890"
    },
    "bill_to": {
      "first_name": "vqjh",
      "last_name": "slszhjru",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ctnb@gmail.com",
      "phone": "1234567890"
    },
    "ship_to": {
      "first_name": "vqjh",
      "last_name": "slszhjru",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ctnb@gmail.com",
      "phone": "1234567890"
    },
    "product": [
      {
        "id": "robo_vac",
        "quantity": 1
      },
      {
        "id": "av_2017",
        "price": 19.99
      },
      {
        "id": "usb_hdd"
      }
    ],
    "tax": [
      {
        "amount": 9.31,
        "rate": 7.3,
        "name": "State Sales",
        "description": "seven percent"
      }
    ],
    "shipping": [
      {
        "amount": 5,
        "name": "USPS Priority",
        "description": "",
        "provider": "usps",
        "provider_method": "priority",
        "provider_tracking": "3546 5214 5698 5214 5488  91",
        "weight": 4.3
      }
    ],
    "coupon": [
      {
        "coupon_code": "10percent"
      }
    ],
    "discount": [
      {
        "discount_value": 5,
        "discount_type": "amount",
        "name": "$5 Off manually applied",
        "description": "Manually applied discount."
      }
    ],
    "internal_sale_id": "sale_7678",
    "internal_customer_id": "cus_3197",
    "metadata": [
      {
        "name": "adwords_click",
        "value": "Cjat0KwhCQjdTq..."
      },
      {
        "name": "sign_up_page",
        "value": "v1"
      },
      {
        "name": "kount_session_id",
        "value": "c8ed4debf8f242be972c1071731052e8"
      }
    ]
  }
}

Response JSON

{
  "amount": 111.86,
  "amount_captured": 111.86,
  "amount_discounted": 0,
  "amount_fees": 3.02,
  "amount_gross": 111.86,
  "amount_net": 108.84,
  "amount_original_total": 274.28,
  "amount_remaining": 162.42,
  "amount_to_salvage": 12.43,
  "api_call_id": "O051ZWQ4XjijnV5LkVGl",
  "api_call_processed": true,
  "api_call_unix": 1565833755,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "card_id": "WmPn2g8bakcKnWWEmRlJ",
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "johndoe@gmail.com",
    "enabled": true,
    "first_name": "John",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "cus_0001",
    "last_name": "Doe",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "customer_id": "ajOAl24bBXc5nXwagAOg",
  "discount_created": [],
  "fraud_detection_response": {
    "code": 1,
    "message": "No fraud detected. Continuing payment.",
    "fraud_detected": false,
    "fraud_detection_created": null,
    "fraud_detection_request": {
      "id": "rmMrXO5G8EFk8zO0rGlX",
      "third_party": {
        "id": "mJEZdyVavzUL0gGoLR1Z",
        "name": "Kount"
      },
      "third_party_integration": {
        "id": "ajYRoLokyXf62qy06JpZ",
        "name": "Kount Risk Inquiry"
      },
      "third_party_raw_response": "",
      "third_party_order_id": "",
      "third_party_fraud_detection_id": "DWN40J2NPKRW",
      "third_party_response_ms": 834
    }
  },
  "gateway": "Braintree",
  "gateway_id": "NkAMJOzpB5iEAOrdloV0",
  "gateway_raw_response": "",
  "internal_customer_id": "cus_3197",
  "internal_sale_id": "sale_7678",
  "iso_currency": "USD",
  "payment_profile_results": {
    "payment_profile_id": "ajyXm76OpjSL4p5oO2By",
    "original_amount": 124.29,
    "final_amount": 111.86,
    "successful_step_num": 2,
    "successful_gateway": "Braintree",
    "num_declined_transactions": 1,
    "declined_transaction_array": [
      "RJ5MaZMap1cZdP9w7ayE"
    ],
    "step_array": [
      {
        "step_action": "initial",
        "step_amount": 124.29,
        "step_cascade_result": {
          "cascade_order": "sort_order",
          "enabled_gateways": [
            "2rE2pQGMd7SYjGp42yEL",
            "LYE26MW8Rlh5VbJmlp2l",
            "GOJankNpkpsPzw6No1OP",
            "NkAMJOzpB5iEAOrdloV0"
          ],
          "gateway_results": [
            {
              "gateway_id": "2rE2pQGMd7SYjGp42yEL",
              "order": 1,
              "revenue_rules": {
                "enabled": false,
                "passed": true,
                "details": []
              },
              "success": true,
              "time_rules": {
                "enabled": false,
                "passed": true,
                "details": []
              }
            }
          ],
          "start_gateway": "2rE2pQGMd7SYjGp42yEL"
        },
        "step_gateway": "Worldpay",
        "step_gateway_id": "2rE2pQGMd7SYjGp42yEL",
        "step_gateway_response": "",
        "step_modifier": "",
        "step_num": 1,
        "step_result": "Declined",
        "step_setting": "initial",
        "step_source": "cascade",
        "step_transaction": "RJ5MaZMap1cZdP9w7ayE"
      },
      {
        "step_action": "next",
        "step_amount": 111.86,
        "step_cascade_result": null,
        "step_gateway": "Braintree",
        "step_gateway_id": "NkAMJOzpB5iEAOrdloV0",
        "step_modifier": "10",
        "step_num": 2,
        "step_result": "Approved",
        "step_setting": "modifypct",
        "step_source": "gateway",
        "step_transaction": "vEwWZv5B5zIXM9bq1yQd"
      }
    ]
  },
  "product_sale_created": [
    {
      "amount_original_total": 89.99,
      "amount_captured": 79.82,
      "amount_gross": 79.82,
      "amount_net": 77.66,
      "amount_fees": 2.16,
      "amount_remaining": 10.17,
      "amount_to_salvage": 10.17,
      "amount_discounted": 0,
      "id": "8rwvAzd6dQU6kXkB2VQq",
      "price": 89.99,
      "quantity": 1,
      "product": {
        "id": "k6EXjKzd7PHOpgvdYjXG",
        "name": "USB HDD",
        "internal_id": "usb_hdd",
        "sku": "usb_hdd_sku"
      },
      "subscription": null,
      "trial": null
    },
    {
      "amount_original_total": 149.99,
      "amount_captured": 0,
      "amount_gross": 0,
      "amount_net": 0,
      "amount_fees": 0,
      "amount_remaining": 149.99,
      "amount_to_salvage": 0,
      "amount_discounted": 0,
      "id": "7rwyAzL5LXUa8QrGMoMR",
      "price": 149.99,
      "quantity": 1,
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "name": "Robo Vac",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku"
      },
      "subscription": {
        "id": "4r15qAlZlyUoMprMNVpE"
      },
      "trial": {
        "id": "k6vn81lElqsvKEB4K2JA"
      }
    },
    {
      "amount_original_total": 19.99,
      "amount_captured": 17.73,
      "amount_gross": 17.73,
      "amount_net": 17.25,
      "amount_fees": 0.48,
      "amount_remaining": 2.26,
      "amount_to_salvage": 2.26,
      "amount_discounted": 0,
      "id": "Nk5vOzGAGRfrmg8LZXVM",
      "price": 19.99,
      "quantity": 1,
      "product": {
        "id": "6r8O5MLbw2t6n4v1lGqK",
        "name": "AV 2017",
        "internal_id": "av_2017",
        "sku": "av_2017_sku"
      },
      "subscription": {
        "id": "VPm9vVEoERc6Wy6Jg7Jg"
      },
      "trial": null
    }
  ],
  "quota_accounts": [
    {
      "id": "4rybZlBnGyCk85zlMmGj",
      "quota_unit_group": {
        "id": "6rnQQzm2mkSmrAorQ6ym",
        "name": "Currency Tokens"
      },
      "quota_account_units": [
        {
          "id": "6rnmX4jmGjcvW6AGKrwJ",
          "name": "Silver Token",
          "balance": 50
        }
      ]
    }
  ],
  "request_method": "create",
  "request_type": "sale",
  "result": "Approved",
  "sale_id": "rm9EG1BjrXcqm64KKq6z",
  "salvage_transaction": {
    "id": "9rdE4zvXvQUjVp22ddgm",
    "amount": 12.43,
    "enabled": true,
    "sale_creator": false
  },
  "salvage_transaction_created": true,
  "ship_to": {
    "first_name": "vqjh",
    "last_name": "slszhjru",
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "city": "Washington",
    "state": "DC",
    "zip": "20500",
    "company": "",
    "country": "USA",
    "email": "ctnb@gmail.com",
    "phone": "1234567890"
  },
  "shipping_created": [
    {
      "amount_original_total": 5,
      "amount_captured": 5,
      "amount_gross": 5,
      "amount_net": 4.87,
      "amount_fees": 0.14,
      "amount_remaining": 0,
      "amount_to_salvage": 0,
      "amount_discounted": 0,
      "id": "Q45o8zGpGRu098B88npR",
      "provider": "usps",
      "provider_method": "priority_mail_express_flat_rate_envelope",
      "provider_tracking": "3546 5214 5698 5214 5488  91",
      "weight": 0
    }
  ],
  "subscription_created": [
    {
      "id": "VPm9vVEoERc6Wy6Jg7Jg",
      "start_date_unix": 1565833755,
      "next_renewal_date_unix": 1568512155,
      "product_sale": {
        "id": "Nk5vOzGAGRfrmg8LZXVM"
      },
      "product": {
        "id": "6r8O5MLbw2t6n4v1lGqK",
        "name": "AV 2017",
        "internal_id": "av_2017",
        "sku": "av_2017_sku"
      },
      "trial": null
    },
    {
      "id": "4r15qAlZlyUoMprMNVpE",
      "start_date_unix": 1565920155,
      "next_renewal_date_unix": null,
      "product_sale": {
        "id": "7rwyAzL5LXUa8QrGMoMR"
      },
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "name": "Robo Vac",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku"
      },
      "trial": {
        "id": "k6vn81lElqsvKEB4K2JA"
      }
    }
  ],
  "tax_created": [
    {
      "amount_original_total": 9.31,
      "amount_captured": 9.31,
      "amount_gross": 9.31,
      "amount_net": 9.06,
      "amount_fees": 0.25,
      "amount_remaining": 0,
      "amount_to_salvage": 0,
      "id": "2rdJNg4E4yUplpKWYnpo",
      "name": "User Provided Tax",
      "description": "Tax rate calculated using provided tax amount.",
      "rate": 0.08
    }
  ],
  "third_party_shop": null,
  "transaction_id": "vEwWZv5B5zIXM9bq1yQd",
  "trial_created": [
    {
      "id": "k6vn81lElqsvKEB4K2JA",
      "num_days": 1,
      "end_date_unix": 1565920155,
      "product_sale": {
        "id": "7rwyAzL5LXUa8QrGMoMR"
      },
      "product": {
        "id": "0pBLXVZW08SNw0XOKZ7X",
        "name": "Robo Vac",
        "internal_id": "robo_vac",
        "sku": "robo_vac_sku"
      },
      "subscription": {
        "id": "4r15qAlZlyUoMprMNVpE"
      }
    }
  ],
  "usage_account_created": [
    {
      "id": "X8RqyywEwMU8XwLoK69A"
    }
  ],
  "usage_item_created": [
    {
      "id": "qZqRPPQowXfGbp8Xl0z9",
      "product_sale": {
        "id": "Nk5vOzGAGRfrmg8LZXVM"
      },
      "product": {
        "id": "6r8O5MLbw2t6n4v1lGqK",
        "name": "Usage Product 1",
        "internal_id": "usage_product_1",
        "sku": "usage_product_1"
      },
      "trial": null,
      "usage_account": {
        "id": "X8RqyywEwMU8XwLoK69A"
      }
    }
  ]
}

Pending Sale

Create a pending sale using the sale create API call by including "is_pending: true" in the request. This allows you to have RevCent store a sale, including any related payment information, without processing the payment. You can update the pending sale and process the payment at a later time.

Read more about pending sales and pending sale profiles on our Knowledge Base.

Pending Sale Create

The request body is the same as a Sale Create call, except you include "is_pending: true" in the request. You can also omit properties normally required in a Sale Create call. You can add and/or update a pending sale before or when processing the final payment.

Note: The example request JSON is a simplified example and does not include all properties available. Please refer to the Sale Create section for full request JSON example and all properties that can be included in a pending sale create request, ignoring the returned properties as an pending sale create request returns a different response.

Note: You can include your own unique_request_id when creating a pending sale in order to reference the same pending sale in future updates or when processing the final payment. If you do not provide a unique_request_id in the create request, you can use the unique_request_id or RevCent sale_id in the pending sale create response for future updates or when processing the final payment.

Required: You must include "is_pending: true" property in the request.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


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.


iso_currency

ISO 4217 currency code. If not provided default is 'USD'.


is_pending

You must include the is_pending property and set to true in order to create a pending sale.


unique_request_id

If you wish to attach a unique ID to the pending sale so you can reference the pending sale in future updates or when processing the final payment. Once a sale has been created with a unique request ID you cannot use the same ID to create another separate sale.

An example unique_request_id would be a specific order ID in your shopping cart, that you will want to use in order to update or complete payment in the future.


payment

The payment object is not required when creating a pending sale. However, if you do include the payment object, the payment information will be saved and attached to the pending sales' customer for future payment.


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.



customer

The customer object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details later.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


customer_id

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


bill_to

The bill_to object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details when processing a payment.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


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.


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, SKU, 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.



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


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.


name

Tax name.


rate

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



coupon

The coupon array. Can contain multiple coupon objects, each containing a coupon code.


coupon_code

The coupon code.



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.




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.


payment_type

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 for the pending sale. You can use this to reference the pending sale in future updates or to process the final payment.


unique_request_id

The unique request ID for the pending sale, either created by RevCent or supplied by you in the request. You can use this to reference the pending sale in future updates or to process the final payment.


Request JSON

{
  "request": {
    "type": "sale",
    "method": "create",
    "campaign": "Adwords Campaign",
    "iso_currency": "USD",
    "is_pending": true,
    "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5",
    "customer": {
      "first_name": "vqjh",
      "last_name": "slszhjru",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "ctnb@gmail.com",
      "phone": "1234567890"
    },
    "product": [
      {
        "id": "robo_vac",
        "quantity": 1
      }
    ]
  }
}

Response JSON

{
  "amount": 34.99,
  "api_call_id": "k6aGmwLkABi0822wnp67",
  "api_call_processed": true,
  "api_call_unix": 1613326956,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "6rKPj6nlXACJRKKd5nXa",
  "payment_type": "Credit Card",
  "request_method": "create",
  "request_type": "sale",
  "result": "Pending sale created.",
  "sale_id": "0pKnzNPq54U2yvvzJwVY",
  "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
}

Pending Sale Update

The request body will always be the same as a pending sale create call, except you include the unique_request_id, as well as "is_pending: true", to signify you are updating a previously created pending sale.

Note: The example request JSON is a simplified example and does not include all properties available. Please refer to the Sale Create section for full request JSON example and all properties that can be included in a pending sale update request, ignoring returned properties as an pending sale update request returns a different response.

Required: You must include "is_pending: true" property in the request.

Required: You must include the unique_request_id of the pending sales' initial response. If you omit the unique_request_id field, then RevCent will create a new pending sale, as there is no way to know which sale you are updating.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


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.


iso_currency

ISO 4217 currency code. If not provided default is 'USD'.


is_pending

You must include the is_pending property and set to true in order to update a pending sale.


unique_request_id

You must include the unique_request_id, or the RevCent sale_id, of the existing pending sale.


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, SKU, 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.



pending_options

When updating a pending sale you have options available that allow you to specify what actions occur given specific conditions.


exists_options

The options for each request entity, in which to update the pending sale for existing entities.


product

What to do for each individual product submitted, if the product already exists in the pending sale. RevCent matches each product based on the id value submitted in the original request and update request.
Accepted values:

replace
Will replace an existing product with the new product. Default

skip
Will skip if product exists.

merge_replace
Will add any new products to the pending sale, and replace any products which already exist.

merge_skip
Will add any new products to the pending sale, and skip any products which already exist.

merge_combine
Will add any new products to the pending sale, and combine the quantites of both existing and new products which already exist.


discount

What to do if discounts already exists in the pending sale.
Accepted values:

replace
Will replace existing discounts with new discounts. Default

skip
Will skip if discounts exist.


shipping

What to do if shipping already exists in the pending sale.
Accepted values:

replace
Will replace existing shipping with new shipping. Default

skip
Will skip if shipping exists.


tax

What to do if tax already exists in the pending sale.
Accepted values:

replace
Will replace existing tax with new tax. Default

skip
Will skip if tax exists.




payment

The payment object is not required when creating a pending sale. However, if you do include the payment object, the payment information will be saved and attached to the pending sales' customer for future payment.


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.



customer

The customer object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details later.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


customer_id

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


bill_to

The bill_to object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details when processing a payment.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


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.


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


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.


name

Tax name.


rate

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



coupon

The coupon array. Can contain multiple coupon objects, each containing a coupon code.


coupon_code

The coupon code.



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.




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.


payment_type

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 for the pending sale. You can use this to reference the pending sale in future updates or to process the final payment.


unique_request_id

The unique request ID for the pending sale, either created by RevCent or supplied by you in the request. You can use this to reference the pending sale in future updates or to process the final payment.


Request JSON

{
  "request": {
    "type": "sale",
    "method": "create",
    "campaign": "Adwords Campaign",
    "is_pending": true,
    "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5",
    "product": [
      {
        "id": "robo_vac",
        "quantity": 2
      },
      {
        "id": "av_2017",
        "quantity": 1
      }
    ],
    "pending_options": {
      "exists_options": {
        "product": "merge_combine",
        "discount": "replace",
        "shipping": "skip",
        "tax": "replace"
      }
    }
  }
}

Response JSON

{
  "amount": 75.7,
  "api_call_id": "X82JQZYRyqUqajGypN9l",
  "api_call_processed": true,
  "api_call_unix": 1613349181,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "6rKPj6nlXACJRKKd5nXa",
  "payment_type": "Credit Card",
  "request_method": "create",
  "request_type": "sale",
  "result": "Pending sale updated.",
  "sale_id": "0pKnzNPq54U2yvvzJwVY",
  "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
}

Pending Sale Cancel

Cancel a pending sale by using the sale void API call. This will cancel the pending sale, and if you already processed the sale it will refund any payments.

Required: You must include the unique_request_id of the pending sale.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


unique_request_id

You must include the unique_request_id, or the RevCent sale_id, of the existing pending sale.



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.


unique_request_id

The unique request ID for the pending sale.


Request JSON

{
  "request": {
    "type": "sale",
    "method": "void",
    "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
  }
}

Response JSON

{
  "amount": 0,
  "api_call_id": "ajYwEoMdL2i7g8VrZQNd",
  "api_call_processed": true,
  "api_call_unix": 1613398750,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "6rKPj6nlXACJRKKd5nXa",
  "pending_refund": [],
  "product_sale_refunded": [],
  "request_method": "void",
  "request_type": "sale",
  "result": "Sale successfully void.",
  "sale_id": "0pKnzNPq54U2yvvzJwVY",
  "subscription_cancelled": [],
  "trial_cancelled": [],
  "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5"
}

Pending Sale Process

Process a pending sale using the sale create API call without including the "is_pending" property in the request. By not including the "is_pending" property, RevCent assumes that the sale is to be processed. Any payment methods submitted in the process request, or submitted previously while the sale is pending, will be used to process the payment of the pending sale.

Note: The example request JSON is a simplified example and does not include all properties available. Please refer to the Sale Create section for full request JSON example and all properties that can be included in a pending sale process request. The response JSON for pending sale process is omitted as it is the same that will be returned in the sale create response.

Note: If using a credit card payment type, you must include either the payment_profile or gateway property.

Required: Do not include "is_pending", or set "is_pending: false", in the pending sale process request to ensure that RevCent processes the payment and does not simply update the pending sale.

Required: You must include the unique_request_id of the pending sales' initial response. If you omit the unique_request_id field, then RevCent will create a new sale, as there is no way to know which pending sale you are processing.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


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.


iso_currency

ISO 4217 currency code. If not provided default is 'USD'.


gateway

Use a specific gateway for processing the pending sale. This value can either be the RevCent gateway ID or the custom gateway name you created. You can also use a payment profile instead of a gateway.


payment_profile

Use a payment profile for processing the pending sale. This value can either be the RevCent payment profile ID or the custom payment profile name you created. You can also use a gateway instead of a payment profile.


is_pending

You must include the is_pending property and set to false in order to process a pending sale.


unique_request_id

You must include the unique_request_id, or the RevCent sale_id, of the existing pending sale.


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, SKU, 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.



pending_options

When updating a pending sale you have options available that allow you to specify what actions occur given specific conditions.


exists_options

The options for each request entity, in which to update the pending sale for existing entities.


product

What to do for each individual product submitted, if the product already exists in the pending sale. RevCent matches each product based on the id value submitted in the original request and update request.
Accepted values:

replace
Will replace an existing product with the new product. Default

skip
Will skip if product exists.

merge_replace
Will add any new products to the pending sale, and replace any products which already exist.

merge_skip
Will add any new products to the pending sale, and skip any products which already exist.

merge_combine
Will add any new products to the pending sale, and combine the quantites of both existing and new products which already exist.


discount

What to do if discounts already exists in the pending sale.
Accepted values:

replace
Will replace existing discounts with new discounts. Default

skip
Will skip if discounts exist.


shipping

What to do if shipping already exists in the pending sale.
Accepted values:

replace
Will replace existing shipping with new shipping. Default

skip
Will skip if shipping exists.


tax

What to do if tax already exists in the pending sale.
Accepted values:

replace
Will replace existing tax with new tax. Default

skip
Will skip if tax exists.




payment

The payment object is not required when creating a pending sale. However, if you do include the payment object, the payment information will be saved and attached to the pending sales' customer for future payment.


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.



customer

The customer object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details later.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


customer_id

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


bill_to

The bill_to object is not required when creating a pending sale. You have the ability to create a pending sale with an anonymous customer, and update the customer details when processing a payment.


address_line_1

address_line_2

city

company

country

email

first_name

last_name

phone

state

zip


third_party_shop

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


internal_customer_id

Your internal customer ID.


internal_sale_id

Your internal sale ID.


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


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.


name

Tax name.


rate

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



coupon

The coupon array. Can contain multiple coupon objects, each containing a coupon code.


coupon_code

The coupon code.



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.




Request JSON

{
  "request": {
    "type": "sale",
    "method": "create",
    "campaign": "Adwords Campaign",
    "payment_profile": "MyPaymentProfile",
    "is_pending": false,
    "unique_request_id": "257d00ed-3cb4-47f2-ad21-2f99ddca58b5",
    "payment": {
      "credit_card": {
        "card_number": "4242424242424242",
        "exp_month": 4,
        "exp_year": 22,
        "card_code": "000"
      },
      "payment_type": "credit_card"
    }
  }
}

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



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

{
  "request": {
    "type": "sale",
    "method": "void",
    "sale_id": "rm9EG1BjrXcqm64KKq6z"
  }
}

Response JSON

{
  "amount": 261.85,
  "api_call_id": "8rwvAzV97NU6aN4djRQo",
  "api_call_processed": true,
  "api_call_unix": 1565833758,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "ajOAl24bBXc5nXwagAOg",
  "pending_refund": [
    "EMwJaz1m76TElBwVOQl4",
    "0pwoAb5L1vfXyJ5dgQod",
    "LY5yMzq27wIJO5BJmPa5",
    "k6vn81AXpOfv8JlB8Xkn"
  ],
  "product_sale_refunded": [
    "8rwvAzd6dQU6kXkB2VQq",
    "Nk5vOzGAGRfrmg8LZXVM",
    "7rwyAzL5LXUa8QrGMoMR"
  ],
  "request_method": "void",
  "request_type": "sale",
  "result": "Sale successfully void.",
  "sale_id": "rm9EG1BjrXcqm64KKq6z",
  "shipping_refunded": [
    "Q45o8zGpGRu098B88npR"
  ],
  "subscription_cancelled": [
    "VPm9vVEoERc6Wy6Jg7Jg",
    "4r15qAlZlyUoMprMNVpE"
  ],
  "tax_refunded": [
    "2rdJNg4E4yUplpKWYnpo"
  ],
  "trial_cancelled": [
    "k6vn81lElqsvKEB4K2JA"
  ]
}

Sale Estimate

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

The request object is the same as the the sale create request object, except the request method is "estimate" and not "create".

The response object contains detailed information that can be useful for displaying information to a customer during checkout, including how much the customer will save due to discounts.

Request JSON Schema


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, SKU, 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.



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


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.


name

Tax name.


rate

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



coupon

The coupon array. Can contain multiple coupon objects, each containing a coupon code.


coupon_code

The coupon code.



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.




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


coupons

A breakdown of both valid and invalid coupons if one or more coupon codes are submitted in the request.


valid

An array of valid coupons if one or more coupon codes are submitted in the request.


uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


coupon_code

The coupon code submitted.


coupon_id

The ID of the coupon you created in RevCent.


coupon_profile_id

The ID of the related coupon profile you created in RevCent.


discount

uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


discount_amount

The discount amount.


discount_percent

The discount percentage (discount_multiplier * 100) rounded to max two decimal places.


discount_multiplier

The discount multiplier, i.e. the mathematical number to apply to the total amount.


discount_value

The discount value relative to the discount type.


discount_type

The discount type relative to the discount value.




invalid

An array of invalid coupons if one or more coupon codes are submitted in the request.


uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


coupon_code

The coupon code submitted.


errors

An array of error messages as to why the coupon code is invalid.



potential

Will list available coupons not submitted that can apply to the submitted estimate. Not yet implemented but coming in a future API update.



discounts

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


uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


discount_amount

The discount amount.


discount_percent

The discount percentage (discount_multiplier * 100) rounded to max two decimal places.


discount_multiplier

The discount multiplier, i.e. the mathematical number to apply to the total amount.


discount_value

The discount value relative to the discount type.


discount_type

The discount type relative to the discount value.


is_coupon

Whether the discount is a result of a coupon code or a static discount submitted.


coupon_id

If the discount is the result of a coupon, the coupon ID.


coupon_uuid

The unique ID of the coupon in the coupons array.


products

An array of product entries that the discount is being applied to if applicable.


id

The RevCent ID of the object item.


uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


discount_amount

The discount amount.


discount_percent

The discount percentage (discount_multiplier * 100) rounded to max two decimal places.


discount_multiplier

The discount multiplier, i.e. the mathematical number to apply to the total amount.


total_amount_with_discount

The total amount the customer will pay for the specific product after the discount has been applied.



shipping

An array of shipping entries that the discount is being applied to if applicable.


uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


discount_amount

The discount amount.


discount_percent

The discount percentage (discount_multiplier * 100) rounded to max two decimal places.


discount_multiplier

The discount multiplier, i.e. the mathematical number to apply to the total amount.




products

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


uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


id

The ID of the product.


name

The name of the product.


description

The description of the product.


quantity

The product quantity.


price

The product price.


total_amount

The total amount before any applicable discounts are applied.


is_trial

Whether the product will created a trial.


is_trial_ship_now

If the product is a trial product, whether the product will ship immediately upon sale completion.


is_free_product

Whether the product is a free product.


discount_uuid

An array of unique discount IDs that apply to the product.


discount_amount

The discount amount.


discount_percent

The discount percentage (discount_multiplier * 100) rounded to max two decimal places.


discount_multiplier

The discount multiplier, i.e. the mathematical number to apply to the total 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.


uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


amount

The individual shipping amount


products

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


id

The product ID.


uuid

A unique ID for the item. This is useful for identifying and matching this particular item with other related items in the response and vice versa.


quantity

The product quantity.



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 including any discounts applied.


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 before any applicable discounts are applied.


amount_bill_now_with_discount

The immediate amount the customer will pay for products after any applicable discounts are applied.



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 before any applicable discounts are applied.


amount_bill_now_with_discount

The immediate amount the customer will pay for shipping after any applicable discounts are applied.



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

{
  "request": {
    "type": "sale",
    "method": "estimate",
    "campaign": "Facebook Campaign",
    "coupon": [
      {
        "coupon_code": "10percent"
      },
      {
        "coupon_code": "invalidCode"
      }
    ],
    "discount": [
      {
        "discount_value": 5,
        "discount_type": "amount",
        "name": "$5 Off Coupon",
        "description": "$5 Off Coupon from facebook link."
      }
    ],
    "customer": {
      "first_name": "ffms",
      "last_name": "qtfgzzql",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "qqcg@gmail.com",
      "phone": "1234567890"
    },
    "bill_to": {
      "first_name": "ffms",
      "last_name": "qtfgzzql",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "qqcg@gmail.com",
      "phone": "1234567890"
    },
    "ship_to": {
      "first_name": "ffms",
      "last_name": "qtfgzzql",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "qqcg@gmail.com",
      "phone": "1234567890"
    },
    "product": [
      {
        "id": "usb_hdd",
        "quantity": 2
      }
    ],
    "shipping": [
      {
        "amount": 45.64,
        "name": "FedEx",
        "description": "",
        "provider": "ups",
        "provider_method": "ups ground"
      }
    ],
    "tax": [
      {
        "amount": 10.71,
        "rate": 7.3,
        "name": "State Sales",
        "description": "seven percent"
      }
    ]
  }
}

Response JSON

{
  "api_call_id": "O05VMKEmqZIRq77gP49O",
  "api_call_processed": true,
  "api_call_unix": 1570463562,
  "code": 1,
  "coupons": {
    "valid": [
      {
        "uuid": "133e489d-09fc-455b-ba7c-2d3e6f4d0372",
        "coupon_code": "10percent",
        "coupon_id": "VPmmrpbVl7cQ9JaXEanl",
        "coupon_profile_id": "k6vvXQwwNycvJM7yMwzL",
        "discount": {
          "uuid": "e5429d8a-588e-4ec2-ad09-f7ad36894ead",
          "discount_amount": 22.06,
          "discount_percent": 10,
          "discount_multiplier": 0.1,
          "discount_value": 10,
          "discount_type": "percent"
        }
      }
    ],
    "invalid": [
      {
        "uuid": "f3070b93-8042-43d6-a52b-4850e23ed5d4",
        "coupon_code": "invalidCode",
        "errors": [
          "Coupon code invalid."
        ]
      }
    ],
    "potential": []
  },
  "discounts": [
    {
      "uuid": "aeafd3b2-f724-45c9-83e3-f4e0f286fc45",
      "discount_amount": 5,
      "discount_percent": 2.22,
      "discount_multiplier": 0.022161155925893093,
      "discount_type": "amount",
      "discount_value": 5,
      "is_coupon": false,
      "coupon_id": null,
      "coupon_uuid": null,
      "products": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "uuid": "fef9b23e-2cc7-4e9d-90af-98d7117115e1",
          "discount_amount": 3.99,
          "discount_multiplier": 0.022169129903322593,
          "discount_percent": 2.22,
          "total_amount_with_discount": 175.99
        }
      ],
      "shipping": [
        {
          "uuid": "d57ed1cc-7914-4e3c-8954-d311e5194b84",
          "discount_amount": 0,
          "discount_multiplier": 0,
          "discount_percent": 0
        }
      ]
    },
    {
      "uuid": "e5429d8a-588e-4ec2-ad09-f7ad36894ead",
      "discount_amount": 22.06,
      "discount_percent": 10,
      "discount_multiplier": 0.1,
      "discount_type": "percent",
      "discount_value": 10,
      "is_coupon": true,
      "coupon_id": "VPmmrpbVl7cQ9JaXEanl",
      "coupon_uuid": "133e489d-09fc-455b-ba7c-2d3e6f4d0372",
      "products": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "uuid": "fef9b23e-2cc7-4e9d-90af-98d7117115e1",
          "discount_amount": 21.59,
          "discount_multiplier": 0.11995777308589843,
          "discount_percent": 12,
          "total_amount_with_discount": 158.39
        }
      ],
      "shipping": [
        {
          "uuid": "d57ed1cc-7914-4e3c-8954-d311e5194b84",
          "discount_amount": 1.01,
          "discount_multiplier": 0.02212971078001753,
          "discount_percent": 2.21,
          "total_amount_with_discount": 44.63
        }
      ]
    }
  ],
  "products": [
    {
      "uuid": "fef9b23e-2cc7-4e9d-90af-98d7117115e1",
      "id": "k6EXjKzd7PHOpgvdYjXG",
      "name": "USB HDD",
      "description": "",
      "quantity": 2,
      "price": 89.99,
      "total_amount": 179.98,
      "is_trial": false,
      "is_trial_ship_now": false,
      "is_free_product": false,
      "discount_uuid": [
        "aeafd3b2-f724-45c9-83e3-f4e0f286fc45",
        "e5429d8a-588e-4ec2-ad09-f7ad36894ead"
      ],
      "discount_amount": 21.59,
      "discount_multiplier": 0.11995777308589843,
      "discount_percent": 12,
      "total_amount_with_discount": 158.39,
      "max_quantity_allowed": 0
    }
  ],
  "request_method": "estimate",
  "request_type": "sale",
  "shipping": [
    {
      "uuid": "d57ed1cc-7914-4e3c-8954-d311e5194b84",
      "amount": 45.64,
      "products": [
        {
          "id": "k6EXjKzd7PHOpgvdYjXG",
          "uuid": "fef9b23e-2cc7-4e9d-90af-98d7117115e1",
          "quantity": 2
        }
      ],
      "provider": "ups",
      "provider_method": "ups_other",
      "total_amount_with_discount": 40.17
    }
  ],
  "tax": [
    {
      "rate": 0.05,
      "amount": 10.71
    }
  ],
  "totals": {
    "amount_total": 236.33,
    "amount_bill_now": 209.27,
    "products": {
      "amount_total": 158.39,
      "amount_bill_now_with_discount": 158.39,
      "amount_bill_now": 179.98
    },
    "shipping": {
      "amount_total": 40.17,
      "amount_bill_now_with_discount": 40.17,
      "amount_bill_now": 45.64
    },
    "discount": {
      "amount_total": 27.06
    },