RevCent API V1


You are viewing the Version 1 API Docs. If you are looking for the Version 2 API Docs, please click here.

The V1 API is a JSON based API. All calls are performed via http POST, with a JSON body, and application/json as the content type. This allows a coding language agnostic method of calling the V1 API without the need for an SDK. Simply call the V1 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".

V1 vs V2
The difference between the V1 API and V2 API is purely based on the need for an open standard interface. The V1 API does not follow an open standard for third parties to programatically integrate. The V2 API follows the OpenAPI 3.1 standard, allowing developers and third parties to programatically integrate using the specification file.

Which Should I Use?
If you are integrating with RevCent for the first time, we recommend using the V2 API and its specification. If you are currently using V1 API please continue to use it, as the V1 API will never be deprecated and any new API capabilities will be added to both V1 and V2 simultaneously.

Whitelist RevCent
All requests from RevCent will use the following IP addresses:
34.224.171.255
52.3.146.218
54.174.155.188

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

API Endpoint

https://api.revcent.com/v1

Authentication


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

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

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

Example

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

Request Body


Every request body is a JSON object, containing the request object. The request object contains both type and method properties. This determines the actions that the specific POST request is going to perform.

In the example, the type is 'sale' and the method is 'retrieve'. Depending on the type and method, certain properties are required. All schema examples in the docs specify required properties depending on request.

Example

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

Request Example


The example contains a request using CURL showing the POST method, content-type header, x-api-key header and JSON body.

Example

curl --location --request POST 'https://api.revcent.com/v1' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_REVCENT_API_KEY' \
--data-raw '{
    "request": {
        "type": "sale",
        "method": "retrieve",
        "id": "mJWJbKNQ4QI8XbwmyyW7"
    }
}'

Idempotent Requests


The RevCent API supports idempotency for safely retrying API requests without performing the same specific operation twice.

This is useful for retrying disrupted requests while avoiding the chance of double charging a customer. To perform an idempotent request, provide the idempotency_key property within the request object. RevCent will check existing idempotency keys submitted within the past 24 hours for the API account. If an idempotency key match is found, the API request is immediately rejected and not saved.

The idempotency key must be at least 10 characters in length and can be up to 255 characters in length. We recommended you use V4 UUIDs. Retrieve requests ignore idempotency keys.

Important: Only use idempotency keys if you know when and why to use them. Resubmitting the same idempotency key when purposely retrying a declined payment request will result in an error, and the retry payment will never be attempted.

Example

{ 
   "request": {
       "type": "sale",
       "method": "create",
       "idempotency_key": "2c74f520-2b7f-44ea-b547-96e3fcaf7462",
       ...
   }
}

Campaign


A campaign is a way to group, categorize and filter various items within your account.

Campaign Create


Create a new campaign.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


name

The campaign name.


description

The campaign description.


enabled

The campaign status.


organization

An array of one or more organization IDs.



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


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


request_method

The API request method.


request_type

The API request type.


result

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


organization

Request JSON

{
  "request": {
    "type": "campaign",
    "method": "create",
    "name": "New Name",
    "description": "Description.",
    "enabled": false,
    "organization": [
      "4rBAwPJzlPSg9lRwGVmX",
      "NkEzVWEdV7C9wvKn19Q8"
    ]
  }
}

Response JSON

{
  "api_call_date": "2023-02-02T19:51:40+00:00",
  "api_call_id": "KnBKryj7jOFPLW1pqkVM",
  "api_call_processed": true,
  "api_call_unix": 1675367500,
  "campaign_id": "rmNPb2opoyfdBV4v0m7P",
  "campaign_name": "New Name",
  "code": 1,
  "organization": [
    {
      "id": "4rBAwPJzlPSg9lRwGVmX",
      "name": "AdWords Org"
    },
    {
      "id": "NkEzVWEdV7C9wvKn19Q8",
      "name": "Acme Org"
    }
  ],
  "request_method": "create",
  "request_type": "campaign",
  "result": "Campaign created."
}

Campaign Edit


Modify a campaign. Only provide the fields you wish to modify.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


campaign_id

The campaign ID.


name

The campaign name.


description

The campaign description.


enabled

The campaign status.


organization

An array of one or more organization IDs.



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


campaign_id

The RevCent ID of the campaign.


campaign_name

The name of the campaign associated with the item.


request_method

The API request method.


request_type

The API request type.


result

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


organization

Request JSON

{
  "request": {
    "type": "campaign",
    "method": "edit",
    "name": "Updated Name",
    "description": "Description.",
    "enabled": true,
    "campaign_id": "rmNPb2opoyfdBV4v0m7P",
    "organization": [
      "NkEzVWEdV7C9wvKn19Q8"
    ]
  }
}

Response JSON

{
  "api_call_date": "2023-02-02T19:51:04+00:00",
  "api_call_id": "9rwkYO1v7XFEB6mGdM8p",
  "api_call_processed": true,
  "api_call_unix": 1675367464,
  "campaign_id": "rmNPb2opoyfdBV4v0m7P",
  "code": 1,
  "organization": [
    {
      "id": "NkEzVWEdV7C9wvKn19Q8",
      "name": "Acme Org"
    }
  ],
  "request_method": "edit",
  "request_type": "campaign",
  "result": "Campaign edited."
}

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.


organization

Any organizations associated with the campaign.


id

Organization ID.


name

Organization name.



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",
      "organization": [
        {
          "id": "NkEzVWEdV7C9wvKn19Q8",
          "name": "Acme Org"
        }
      ],
      "updated_date_unix": 1551406538
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Chargeback


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

Chargeback Create


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

It is recommended to distinguish the chargebacks by sub type(s), i.e. Verifi, RDR, etc., if applicable, using metadata. Only include metadata entries that are applicable to the chargeback. Examples recognized by RevCent below:

RDR
{ "name": "is_rdr", "value": "true" }
Verifi
{ "name": "is_verifi", "value": "true" }
Ethoca
{ "name": "is_ethoca", "value": "true" }
TC40
{ "name": "is_tc40", "value": "true" }

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.


void_transaction

You can choose to void the transaction, which will automatically issue a full refund. Default is false. Note: This cannot be undone.


representment

Representment details related to the chargeback, if a representment has taken place.


initiated

Whether a representment has been initiated. Read-only once set.


initiated_date

The date the representment was initiated. Read-only once set.


completed

Whether the representment has completed, with an outcome. The initiated property must be set, or have been previously set, to true. Read-only once set.


completed_date

The date the representment was completed, with an outcome. Read-only once set.


outcome

The outcome of the chargeback representment. Can be either "pending", "won" or "lost". The initiated and completed properties must be set, or have been previously set, to 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.


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.


void_transaction

Whether the transaction was simultaneously voided along with the chargeback creation.


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",
    "void_transaction": false,
    "representment": {
      "initiated": true,
      "initiated_date": "12/04/2020"
    },
    "metadata": [
      {
        "name": "is_verifi",
        "value": "true"
      }
    ]
  }
}

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",
  "void_transaction": false
}

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.


representment

Representment details related to the chargeback, if a representment has taken place.


initiated

Whether a representment has been initiated. Read-only once set.


initiated_date

The date the representment was initiated. Read-only once set.


completed

Whether the representment has completed, with an outcome. The initiated property must be set, or have been previously set, to true. Read-only once set.


completed_date

The date the representment was completed, with an outcome. Read-only once set.


outcome

The outcome of the chargeback representment. Can be either "pending", "won" or "lost". The initiated and completed properties must be set, or have been previously set, to true.




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",
    "representment": {
      "completed": true,
      "completed_date": "12/04/2020",
      "outcome": "won"
    },
    "metadata": [
      {
        "name": "is_rdr",
        "value": "true"
      }
    ]
  }
}

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.


representment

If a chargeback has an initiated representment, details on the representment will be provided.


initiated

Whether a representment has been initiated.


initiated_date

The date the representment was initiated.


completed

Whether the representment has completed.


completed_date

The date the representment was completed, with an outcome.


outcome

The outcome of the chargeback representment. Can be either "pending", "won" or "lost".



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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "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,
      "representment": {
        "initiated": true,
        "initiated_date": "2020-12-22T23:22:05+00:00",
        "completed": true,
        "completed_date": "2020-12-25T01:26:18+00:00",
        "outcome": "won"
      },
      "sales": [
        "y2wARbKL8PCPL46Xb7qA"
      ],
      "salvage_transactions": [],
      "shipping": [
        "y2Wrl6kwZoUdBWJjABp0"
      ],
      "status": "Created",
      "subscription_renewals": [
        "zGkXy5Qa0OH4qWAozq58"
      ],
      "tax": [
        "qZM1QVAqwRik6BJNq6vW"
      ],
      "third_party_chargeback_id": "",
      "third_party_integration": null,
      "third_party_order_id": "",
      "transaction": {
        "id": "pgPbQlGpr8fWQ72NbQrB",
        "created_date_unix": 1608679325,
        "created_date": "2020-12-22T23:22:05+00:00",
        "updated_date_unix": 1608859578,
        "updated_date": "2020-12-25T01:26:18+00:00",
        "amount": 42.36
      },
      "transactions": [
        "pgPbQlGpr8fWQ72NbQrB"
      ],
      "trials": [],
      "updated_date_unix": 1608738415,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_invoices": [],
      "usage_items": []
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Coupon


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

Coupon Validate


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

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

Request JSON Schema


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

Customer


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

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

Customer Create


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

AdWords Integration

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

Example

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

Request JSON Schema


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


Edit customer information.

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


Enabled a customer that was previously disabled.

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


Disable a customer, preventing future purchases.

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


Add a credit card to a customer, with the ability to set the card as default.

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 Add To Group


Add a customer to a customer group.

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_group

An array of one or more Customer Group IDs.



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_to_group",
    "customer_id": "LY9BAEgLymHObBR7GKdw",
    "customer_group": [
      "8rRGOVwwNLTaawApmQv8"
    ]
  }
}

Response JSON

{
  "api_call_id": "ZVEGoyPVA0fZJMPo8Kav",
  "api_call_processed": true,
  "api_call_unix": 1565814919,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "add_to_group",
  "request_type": "customer",
  "result": "Customer added to group(s)."
}

Customer Remove From Group


Remove a customer from a customer group.

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_group

An array of one or more Customer Group IDs.



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": "remove_from_group",
    "customer_id": "LY9BAEgLymHObBR7GKdw",
    "customer_group": [
      "8rRGOVwwNLTaawApmQv8"
    ]
  }
}

Response JSON

{
  "api_call_id": "ZVEGoyPVA0fZJMPo8Kav",
  "api_call_processed": true,
  "api_call_unix": 1565814919,
  "code": 1,
  "customer_id": "mJGAbQ0zAmU12rpngR1M",
  "request_method": "remove_from_group",
  "request_type": "customer",
  "result": "Customer removed from group(s)."
}

Customer Retrieve


Retrieve current information on a single customer or multiple customers. You can use either the RevCent ID or email address for retrieving a single customer.

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

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

Request JSON Schema


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the customer. Required if multiple property equals false and email property not present.


email

The email address of the customer. Required if multiple property equals false and id property 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 identifiable information.


api_calls

An array containing api call IDs related to the item.


blocked

Whether the customer has been marked as blocked, preventing the customer from making purchases.


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.


city

company

country

created_date_unix

The unix timestamp of when the item was created.


customer_card

An array of customer card objects, each being a customer 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, i.e. visa, mastercard, etc.


last_4

The last 4 digits of the customer credit card.


expiry_date

The credit card expiration date, formatted MM/YY.


expiry_month

The credit card expiration month, formatted MM.


expiry_year

The credit card expiration year, formatted YYYY.


is_default

Whether the credit card is the customers' default card.



customer_group

An array of customer group objects, each being a customer group the customer is associated with.


id

The RevCent ID of the object item.


name

The name of the item.



customer_group_blocked

An array of customer group objects, each being a customer group the customer is blocked from being associated with.


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

fraud_detection_requests

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


fraud_detections

An array containing fraud detection IDs related to the item.


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.


invoices

An array containing invoice IDs related to the item.


last_name

lat

Geocode latitude of customer if successfully geocoded.


license_keys

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


lifetime_value

Overall lifetime values for the customer.


all

The combined total of sale and subscription renewal value types.


amount_discounted

The sum amount discounted for all sales and renewals.


amount_gross

The sum amount gross for all sales and renewals.


amount_net

The sum amount net for all sales and renewals.


amount_refunded

The sum amount refunded for all sales and renewals.


amount_remaining

The sum amount remaining for all sales and renewals.


amount_to_salvage

The sum amount to salvage for all sales and renewals.


amount_total

The sum total volume for all sales and renewals.



sale

The sale value type, specific to the customers' sales.


amount_discounted

The sum amount discounted for all sales.


amount_gross

The sum amount gross for all sales.


amount_net

The sum amount net for all sales.


amount_refunded

The sum amount refunded for all sales.


amount_remaining

The sum amount remaining for all sales.


amount_to_salvage

The sum amount to salvage for all sales.


amount_total

The sum total volume for all sales.


num

The total number of sales.


avg

The average sale amount gross.



subscription_renewal

The subscription renewal value type, specific to the customers' subscription renewals.


amount_discounted

The sum amount discounted for all subscription renewals.


amount_gross

The sum amount gross for all subscription renewals.


amount_net

The sum amount net for all subscription renewals.


amount_refunded

The sum amount refunded for all subscription renewals.


amount_remaining

The sum amount remaining for all subscription renewals.


amount_to_salvage

The sum amount to salvage for all subscription renewals.


amount_total

The sum total volume for all subscription renewals.


num

The total number of subscription renewals regardless of status.


avg

The average subscription renewal amount gross.


num_overdue

The total number of subscription renewals with a status of Overdue.



fraud_detection

The fraud detection value type, specific to the customers' fraud detections.


amount

The total amount of all fraud detections.


num

The total number of fraud detections.


avg

The average fraud detection amount.



chargeback

The chargeback value type, specific to the customers' chargebacks.


amount

The total amount of all chargebacks.


num

The total number of chargebacks.


avg

The average chargeback amount.



pending_refund

The pending refund value type, specific to the customers' pending refunds.


num

The total number of refunds issued to the customer.



last_sale_date

The date of the last sale for the customer, if available.


last_subscription_renewal_date

The date of the last subscription renewal for the customer, if available.



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.


products_purchased

The products the customer has purchased over their lifetime.


id

The product ID.


name

The product name.


internal_id

The product internal ID.


sku

The product SKU.


quantity

The total quantity for all purchases of this product by the customer.


price

The average price for all purchases of this product by the customer.


amount_gross

The total amount gross specific to the product for the customer.


amount_refunded

The total amount refunded specific to the product for the customer.


purchase_count

The number of separate purchases of the product.


purchase_dates

The individual dates, as a unix timestamp, of each purchase.



quota_accounts

An array containing quota account 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

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.


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": "X8681XdaPpfrmYgyaVAp",
  "api_call_processed": true,
  "api_call_unix": 1641919241,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "customer",
  "results": [
    {
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "anonymous": false,
      "api_calls": [
        "vEP9QdWngpUrNGW6llkv"
      ],
      "blocked": false,
      "campaign_id": "JN0Zpj7RGJiwKqAnRoy6",
      "campaign_name": "AdWords Campaign",
      "chargebacks": [],
      "check_directs": [],
      "city": "Washington",
      "company": "",
      "country": "USA",
      "created_date_unix": 1641564098,
      "customer_card": [
        {
          "created_date_unix": 1641564098,
          "updated_date_unix": 1641746186,
          "id": "ALAGkvj0O7u5rdmVggQ7",
          "type": "visa",
          "last_4": "1111",
          "expiry_date": "11/23",
          "expiry_month": "11",
          "expiry_year": "2023",
          "is_default": true
        }
      ],
      "customer_group": [
        {
          "id": "2rRMqP5nojF6EgJqwQVL",
          "name": "My Customer Group"
        }
      ],
      "customer_group_blocked": [],
      "discounts": [],
      "email": "georgew@whitehouse.com",
      "enabled": true,
      "first_name": "George",
      "fraud_detection_requests": [],
      "fraud_detections": [],
      "full_address": "1600 Pennsylvania Ave, Washington, DC 20500, USA",
      "geocode_success": true,
      "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
      "id": "O0O0LON20nTaNQ6gg6Lm",
      "internal_id": "pres_0001",
      "invoices": [],
      "last_name": "Washington",
      "lat": "32.5614023",
      "license_keys": [],
      "lifetime_value": {
        "all": {
          "amount_discounted": 0,
          "amount_gross": 363.55,
          "amount_net": 355.55,
          "amount_refunded": 0,
          "amount_remaining": 23.75,
          "amount_to_salvage": 23.75,
          "amount_total": 387.3
        },
        "sale": {
          "amount_discounted": 0,
          "amount_gross": 363.55,
          "amount_net": 355.55,
          "amount_refunded": 0,
          "amount_remaining": 23.75,
          "amount_to_salvage": 23.75,
          "amount_total": 387.3,
          "num": 1,
          "avg": 363.55
        },
        "subscription_renewal": {
          "amount_discounted": 0,
          "amount_gross": 0,
          "amount_net": 0,
          "amount_refunded": 0,
          "amount_remaining": 0,
          "amount_to_salvage": 0,
          "amount_total": 0,
          "num": 0,
          "avg": 0,
          "num_overdue": 0
        },
        "fraud_detection": {
          "amount": 0,
          "num": 0,
          "avg": 0
        },
        "chargeback": {
          "amount": 0,
          "num": 0,
          "avg": 0
        },
        "pending_refund": {
          "num": 0
        },
        "last_sale_date": "2022-01-07T14:01:38.458Z",
        "last_subscription_renewal_date": null
      },
      "lon": "-90.19291299999999",
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [
        {
          "created_date": "2022-01-10T14:35:21+00:00",
          "created_date_unix": 1641825321,
          "updated_date": "2022-01-10T14:35:21+00:00",
          "updated_date_unix": 1641825321,
          "id": "9r0NrKQ864FaOrmOYmQn",
          "text": "Example customer note.",
          "username": "JohnDoe",
          "first_name": "John",
          "last_name": "Doe",
          "employee_id": "mWwZ8KyrOLNOOdbbdUbQ",
          "customer_note_related_type": "customer",
          "customer_note_related_id": "O0O0LON20nTaNQ6gg6Lm"
        }
      ],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "phone": "12345678901",
      "product_sales": [
        "LYG04QV82NHqzpQvLL8m"
      ],
      "products_purchased": [
        {
          "id": "6r8O5MLbw2t6n4v1lGqK",
          "name": "AV 2017",
          "internal_id": "av_2017",
          "sku": "av_2017_sku",
          "quantity": 1,
          "price": 29.99,
          "amount_gross": 28.74,
          "amount_refunded": 0,
          "purchase_count": 1,
          "purchase_dates": [
            1673880787
          ]
        }
      ],
      "quota_accounts": [],
      "sales": [
        "6rYKpkEgmyfBaGONMMVm"
      ],
      "salvage_transactions": [
        "8rkZpLd09Rf2wzVO77W5"
      ],
      "shipping": [
        "l4jWlR78X5cAvvvbnlWJ"
      ],
      "smtp_messages": [],
      "state": "DC",
      "state_long": "DC",
      "status": "Enabled",
      "subscription_renewals": [],
      "subscriptions": [
        "5rnXp2wYjRf9OzWdgg8M"
      ],
      "tax": [
        "rmYb7ro28XTvmmmVE2RA"
      ],
      "transactions": [
        "ZVJZkL6Kn4Cb555PnKP9"
      ],
      "trials": [
        "JNvWwanZLBi8RN1ynnQR"
      ],
      "updated_date_unix": 1641825321,
      "zip": "20500"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Customer Card


A customer card is specific to a customer, and is either created automatically during an initial sale, or manually added to a customer via web app or API.

Customer Card Add


To add a customer card, use the customer > add_card API method instead. This ensures a new card is assigned to the correct customer.

If the customer does not already exist, use the customer > create API method and include the credit card details in the request.

Customer Card Enable


Enable a customer card that was previously disabled.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer_card_id

The RevCent customer card 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_card_id

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_card",
    "method": "enable",
    "customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
  }
}

Response JSON

{
  "api_call_id": "9r0rPLQOPATL4zXVVXrZ",
  "api_call_processed": true,
  "api_call_unix": 1641910649,
  "code": 1,
  "customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
  "customer_id": "2rBrjB5arLtoVnPKKPMw",
  "request_method": "enable",
  "request_type": "customer_card",
  "result": "Customer card set to enabled."
}

Customer Card Disable


Disable a customer card, preventing its use.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer_card_id

The RevCent customer card 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_card_id

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_card",
    "method": "disable",
    "customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
  }
}

Response JSON

{
  "api_call_id": "LYGYa9Nv7kCzL4RPPRoa",
  "api_call_processed": true,
  "api_call_unix": 1641910714,
  "code": 1,
  "customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
  "customer_id": "2rBrjB5arLtoVnPKKPMw",
  "request_method": "disable",
  "request_type": "customer_card",
  "result": "Customer card set to disabled."
}

Customer Card Delete


Delete a customer card, removing it from the system. This is irreversible.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer_card_id

The RevCent customer card 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_card_id

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_card",
    "method": "delete",
    "customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
  }
}

Response JSON

{
  "api_call_id": "ll2nVEywp2M8Mbr2vXnf",
  "api_call_processed": true,
  "api_call_unix": 1641910772,
  "code": 1,
  "customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
  "customer_id": "2rBrjB5arLtoVnPKKPMw",
  "request_method": "delete",
  "request_type": "customer_card",
  "result": "Customer card deleted."
}

Customer Card Set Default


Set a customer card as the default card for the customer.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


customer_card_id

The RevCent customer card 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_card_id

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_card",
    "method": "set_default",
    "customer_card_id": "O0O0LON20nTaNQ6gg6Lm"
  }
}

Response JSON

{
  "api_call_id": "EM8Mbr2vXnfywp2ll2nV",
  "api_call_processed": true,
  "api_call_unix": 1641910772,
  "code": 1,
  "customer_card_id": "O0O0LON20nTaNQ6gg6Lm",
  "customer_id": "2rBrjB5arLtoVnPKKPMw",
  "request_method": "set_default",
  "request_type": "customer_card",
  "result": "Customer card set as default."
}

Customer Card Retrieve


Retrieve current information on a single customer card or multiple customer cards. To view all cards for a specific customer, simply use the customer > retrieve method, using the customer ID, which will contain the customers' cards in the response.

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

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

Request JSON Schema


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.


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.



enabled

Whether the item is enabled or disabled.


expiry

The expiration date of the customer card formatted M/YYYY.


expiry_date

The expiration date of the customer card formatted MM/YYYY.


expiry_month

The expiration date of the customer card formatted MM.


expiry_year

The expiration year of the customer card formatted YYYY.


first_6

The first 6 digits of the customer card number.


id

The RevCent ID of the object item.


is_default

Whether the card is the customers' default card.


last_4

The last 4 digits of the customer card number.


live_mode

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


type

The credit card type. I.e. visa, mastercard, etc.


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": "customer_card",
    "method": "retrieve",
    "id": "O0O0LON20nTaNQ6gg6Lm"
  }
}

Response JSON

{
  "api_call_id": "Wm0m9Y2K5YuXrgdvmMAL",
  "api_call_processed": true,
  "api_call_unix": 1641910867,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "customer_card",
  "results": [
    {
      "created_date_unix": 1641910298,
      "customer": {
        "address_line_1": "1600 Pennsylvania Ave",
        "address_line_2": "",
        "blocked": false,
        "city": "Washington",
        "company": "",
        "country": "USA",
        "email": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "enabled": false,
      "expiry_date": "11/2023",
      "expiry_month": "11",
      "expiry_year": "2023",
      "first_6": "424242",
      "id": "O0O0LON20nTaNQ6gg6Lm",
      "is_default": true,
      "last_4": "4242",
      "live_mode": false,
      "type": "visa",
      "updated_date_unix": 1641910714
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Discount


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

Discount Retrieve


Retrieve current information on a single discount or multiple discounts.

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

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

Request JSON Schema


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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "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 alerts, fraud detections and fraud detection requests, using manual or third party integrations. Please read carefully about the difference between a fraud alert and a fraud detection.

Fraud Alert


A fraud alert is simply an indicator that a sale may or may not be fraud and needs manual review. An alert can be removed if the sale is determined to not be fraud.

Fraud Alert Add


Mark a sale with a fraud alert.

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 RevCent ID of the sale.



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.


fraud-alert_id

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.


sale_id

The RevCent ID of the sale.


Request JSON

{
  "request": {
    "type": "fraud_alert",
    "method": "add",
    "sale_id": "2rnYMVFGraRJBnPpgvQV"
  }
}

Response JSON

{
  "api_call_id": "y2WG1ApMMKhW6ZoBb72o",
  "api_call_processed": true,
  "api_call_unix": 1609086154,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer_id": "9rZ68zWWglFY8O26azRX",
  "request_method": "add",
  "request_type": "fraud_alert",
  "result": "Fraud alert added to sale.",
  "sale_id": "2rnYMVFGraRJBnPpgvQV"
}

Fraud Alert Remove


Remove an existing fraud alert from a sale.

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 RevCent ID of the sale.



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.


fraud-alert_id

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.


sale_id

The RevCent ID of the sale.


Request JSON

{
  "request": {
    "type": "fraud_alert",
    "method": "remove",
    "sale_id": "2rnYMVFGraRJBnPpgvQV"
  }
}

Response JSON

{
  "api_call_id": "qZM6vXNEVasgj0XVJO50",
  "api_call_processed": true,
  "api_call_unix": 1609118598,
  "code": 1,
  "customer_id": "9rZ68zWWglFY8O26azRX",
  "request_method": "remove",
  "request_type": "fraud_alert",
  "result": "Fraud alert removed from sale.",
  "sale_id": "2rnYMVFGraRJBnPpgvQV"
}

Fraud Detection


A fraud detection is confirmation that an item is indeed fraud. Once created it cannot be removed or un-done. You can create a fraud detection using either 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.
Sale ID
The RevCent ID for a sale.
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.
Customer ID
The RevCent ID for a customer. Only use when a customer is without a sale or payment attempt, i.e. prospect.

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.


void_sale

You can choose to automatically void the sale, by setting to true, if source_id is a RevCent sale ID. Default is false. Note: This will fully refund all entities of the sale and cannot be undone.


flag_similar_sale

You can choose to have RevCent add fraud alerts to similar sales. Default is false.


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


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_created

The RevCent IDs of each fraud detection created as a result of the API call.


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.


void_sale

Whether the sale was simultaneously voided along with the fraud detection creation.


Request JSON

{
  "request": {
    "type": "fraud_detection",
    "method": "create",
    "source_id": "2rnYMVFGraRJBnPpgvQV",
    "void_sale": false,
    "flag_similar_sale": false,
    "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

{
  "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_created": [
    "VPwOydX2ArHJy8gX2o98"
  ],
  "origin_api_call_id": "O04EbzqqdltXb7EOGQpz",
  "request_method": "create",
  "request_type": "fraud_detection",
  "result": "Fraud detection created.",
  "void_sale": false
}

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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "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
}

Gateway


RevCent has different gateway entities. The site gateway, user gateway and gateway group. Each play a different role in the credit card processing system in RevCent.

We highly recommend that you read the documentation carefully to distinguish the difference between each one.

Site Gateway


A site gateway is where RevCent will ultimately send transactions. You create a user gateway based on a site gateway.

Site Gateway Retrieve


Retrieve current information on a single site gateway or multiple site gateways. This is the list of available gateways within the RevCent system. The most important part is the fields array, which is what each gateway requires for authentication.

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.


description

The description of the item.


fields

id

The RevCent ID of the object item.


name

The name of the item.


description

The description of the item.



id

The RevCent ID of the object item.


name

The name of 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": "site_gateway",
    "method": "retrieve",
    "id": "dXAmybdWwYHrLyWRAAZV",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1
    }
  }
}

Response JSON

{
  "api_call_id": "8ry1n98aGMIvjrlKrKQo",
  "api_call_processed": true,
  "api_call_unix": 1676475629,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "site_gateway",
  "results": [
    {
      "description": "Authorize.net Merchant Gateway",
      "fields": [
        {
          "id": "1",
          "name": "API Login ID",
          "description": "Authorize.net API Login ID"
        },
        {
          "id": "2",
          "name": "Transaction Key",
          "description": "Authorize.net Transaction Key"
        }
      ],
      "id": "dXAmybdWwYHrLyWRAAZV",
      "name": "Authorize.net"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

User Gateway


A user gateway is essentially a MID, where you provide your credentials (fields) according to the site gateway. You create a user gateway based on a site gateway. For example, if you are creating a user gateway (MID) for Authorize.net, you would need to supply the correct number of fields, including each fields' corresponding id and value when creating the user gateway. Read more about User Gateways .

User Gateway Create


Create a user gateway within RevCent via the user gateway create method.

Important: A site gateway is required, along with the correct required fields when creating a user gateway.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


name

The name of the item.


description

The description of the item.


enabled

Whether the gateway should be enabled or disabled.


transaction_success_fee

The transaction success fee for the user gateway. Default is 0.


transaction_fail_fee

The transaction fail fee for the user gateway. Default is 0.


discount_rate

The discount rate for the user gateway. Default is 0.


site_gateway_id

The site gateway ID that the user gateway will communicate with.


merchant_account_id

The merchant account ID for the user gateway.


custom_descriptor

The custom descriptor for the user gateway. Will be provided to supported gateways as well as provided as shortcodes in email templates.


enabled

Whether to enable the custom descriptor.


name

The custom descriptor name.


email

The custom descriptor email.


url

The custom descriptor URL.


phone

The custom descriptor phone.


address

The custom descriptor address.


city

The custom descriptor city.


state

The custom descriptor state.


postal_code

The custom descriptor postal code.



global_cascade_rules

Whether to enable global cascade rules, which will overwrite individual profile cascade rules across all payment profiles for this gateway. More info about how a cascade works within a payment profile at our Knowledge Base.


enabled

Whether to enable global cascade rules for the user gateway.


revenue_rules

Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. Read More


enabled

Whether revenue rules are enabled.


options

An array of individual revenue rules.


enabled

Whether the specific revenue rule is enabled.


bound

The rule bounds to declare if a rule passes or fails.

  • min: The final calculation value must be greater than the Rule Value.
  • max: The final calculation value must be less than the Rule Value.


rule_value

The rule value is compared with the calculation value and bound.


source

The source, in combination with the source value and calculation, is what is used to form the calculation value.

  • gateway: Transactions only from the specific gateway the rule is within.
  • global: All transactions regardless of gateway.
  • step: The active step being processed during the payment flow.


source_value

The source value is specific to the source selected.

  • captured: Only transactions which were captured.
  • declined: Only transactions which were declined.
  • chargeback: Only transactions which were marked as charged back.
  • total: All transactions regardless of outcome or status.
  • amount: Applicable only when source is 'Active Step'. The amount for the active step being processed during the payment flow.


calculation

The calculation to perform based on the source value.

  • count: The total number of source value items.
  • percent: The percentage of source value items.
  • sum: The sum of all source value items.


time_value

The total amount of time the rule applies in a past time range.


time_unit

The time unit. Used in conjunction with the time value.

  • hour: Time value as hours.
  • day: Time value as days.
  • week: Time value as weeks.
  • month: Time value as months.




time_rules

Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). Read More


enabled

Whether time rules are enabled.


options

An array of individual time rules.


enabled

Whether the specific time rule is enabled.


start_time

The start time, formatted as hh:mm:a


end_time

The end time, formatted as hh:mm:a


name

The specific weekday that the time rule applies.

  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday


option

Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges.

  • allow: Allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.
  • deny: Do not allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.





fields

The fields required for the user gateway based on the id of the site gateway fields.


id

The id for the individual field according to the site gateway fields required.


value

The value for the individual field according to the site gateway fields required.




Response JSON Schema


api_call_date

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


created_date

created_date_unix

The unix timestamp of when the item was created.


custom_descriptor

enabled

Whether the item is enabled or disabled.


name

The name of the item.


email

url

phone

address

city

state

postal_code


description

The description of the item.


discount_rate

enabled

Whether the item is enabled or disabled.


gateway_group

global_cascade_rules

revenue_rules

enabled

Whether the item is enabled or disabled.


options

enabled

Whether the item is enabled or disabled.


bound

rule_value

calculation

source

source_value

time_unit

time_value



time_rules

enabled

Whether the item is enabled or disabled.


options

start_time

end_time

name

The name of the item.


option

enabled

Whether the item is enabled or disabled.




enabled

Whether the item is enabled or disabled.



id

The RevCent ID of the object item.


merchant_account_id

The merchant account ID associated with the merchant gateway.


name

The name of the item.


request_method

The API request method.


request_type

The API request type.


result

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


site_gateway

id

The RevCent ID of the object item.


name

The name of the item.



transaction_fail_fee

transaction_success_fee

updated_date

updated_date_unix

The unix timestamp of when the item was updated.


Request JSON

{
  "request": {
    "type": "user_gateway",
    "method": "create",
    "name": "Authorize.net",
    "user_gateway_id": "LYE26MW8Rlh5VbJmlp2l",
    "description": "My awesome gateway.",
    "enabled": true,
    "merchant_account_id": "845678",
    "transaction_success_fee": 0.55,
    "transaction_fail_fee": 0.65,
    "discount_rate": 2.71,
    "site_gateway_id": "dXAmybdWwYHrLyWRAAZV",
    "custom_descriptor": {
      "enabled": true,
      "name": "Acme Org",
      "email": "email@acme.org",
      "url": "https://www.acme.org",
      "phone": "867-5399",
      "address": "1600 Pennsylvania Ave",
      "city": "Washington",
      "state": "DC",
      "postal_code": "20500"
    },
    "global_cascade_rules": {
      "enabled": true,
      "revenue_rules": {
        "enabled": true,
        "options": [
          {
            "enabled": true,
            "bound": "max",
            "rule_value": 5,
            "calculation": "count",
            "source": "gateway",
            "source_value": "chargeback",
            "time_value": 1,
            "time_unit": "month"
          }
        ]
      },
      "time_rules": {
        "enabled": true,
        "options": [
          {
            "start_time": "12:00am",
            "end_time": "11:59pm",
            "name": "sunday",
            "option": "deny",
            "enabled": true
          }
        ]
      }
    },
    "fields": [
      {
        "id": "1",
        "value": "ABCD123"
      },
      {
        "id": "2",
        "value": "456efG789"
      }
    ]
  }
}

Response JSON

{
  "api_call_date": "2023-02-15T15:38:07+00:00",
  "api_call_id": "qZ90JMnBEBSOzznaldPj",
  "api_call_processed": true,
  "api_call_unix": 1676475487,
  "code": 1,
  "created_date": "2017-11-10T13:29:38+00:00",
  "created_date_unix": 1510320578,
  "custom_descriptor": {
    "enabled": true,
    "name": "Acme Org",
    "email": "email@acme.org",
    "url": "https://www.acme.org",
    "phone": "867-5399",
    "address": "1600 Pennsylvania Ave",
    "city": "Washington",
    "state": "DC",
    "postal_code": "20500"
  },
  "description": "Auth.net",
  "discount_rate": 2.5,
  "enabled": true,
  "gateway_group": [],
  "global_cascade_rules": {
    "revenue_rules": {
      "enabled": true,
      "options": [
        {
          "enabled": true,
          "bound": "max",
          "rule_value": 5,
          "calculation": "count",
          "source": "gateway",
          "source_value": "chargeback",
          "time_unit": "month",
          "time_value": 1
        }
      ]
    },
    "time_rules": {
      "enabled": true,
      "options": [
        {
          "start_time": "12:00am",
          "end_time": "11:59pm",
          "name": "sunday",
          "option": "deny",
          "enabled": true
        }
      ]
    },
    "enabled": true
  },
  "id": "LYE26MW8Rlh5VbJmlp2l",
  "merchant_account_id": "845678",
  "name": "Authorize.net",
  "request_method": "create",
  "request_type": "user_gateway",
  "result": "Gateway created.",
  "site_gateway": {
    "id": "dXAmybdWwYHrLyWRAAZV",
    "name": "Authorize.net"
  },
  "transaction_fail_fee": 0.15,
  "transaction_success_fee": 0.25,
  "updated_date": "2023-02-15T15:38:07+00:00",
  "updated_date_unix": 1676475487
}

User Gateway Edit


Edit an existing user gateway within RevCent via the user gateway edit method.
Note: Only provide the properties you wish to modify. Properties not provided will remain unchanged.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


name

The name of the item.


user_gateway_id

The user gateway ID


description

The description of the item.


enabled

Whether the gateway should be enabled or disabled.


transaction_success_fee

The transaction success fee for the user gateway. Default is 0.


transaction_fail_fee

The transaction fail fee for the user gateway. Default is 0.


discount_rate

The discount rate for the user gateway. Default is 0.


site_gateway_id

The site gateway ID that the user gateway will communicate with.


merchant_account_id

The merchant account ID for the user gateway.


custom_descriptor

The custom descriptor for the user gateway. Will be provided to supported gateways as well as provided as shortcodes in email templates.


enabled

Whether to enable the custom descriptor.


name

The custom descriptor name.


email

The custom descriptor email.


url

The custom descriptor URL.


phone

The custom descriptor phone.


address

The custom descriptor address.


city

The custom descriptor city.


state

The custom descriptor state.


postal_code

The custom descriptor postal code.



global_cascade_rules

Whether to enable global cascade rules, which will overwrite individual profile cascade rules across all payment profiles for this gateway. More info about how a cascade works within a payment profile at our Knowledge Base.


enabled

Whether to enable global cascade rules for the user gateway.


revenue_rules

Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. Read More


enabled

Whether revenue rules are enabled.


options

An array of individual revenue rules.


enabled

Whether the specific revenue rule is enabled.


bound

The rule bounds to declare if a rule passes or fails.

  • min: The final calculation value must be greater than the Rule Value.
  • max: The final calculation value must be less than the Rule Value.


rule_value

The rule value is compared with the calculation value and bound.


source

The source, in combination with the source value and calculation, is what is used to form the calculation value.

  • gateway: Transactions only from the specific gateway the rule is within.
  • global: All transactions regardless of gateway.
  • step: The active step being processed during the payment flow.


source_value

The source value is specific to the source selected.

  • captured: Only transactions which were captured.
  • declined: Only transactions which were declined.
  • chargeback: Only transactions which were marked as charged back.
  • total: All transactions regardless of outcome or status.
  • amount: Applicable only when source is 'Active Step'. The amount for the active step being processed during the payment flow.


calculation

The calculation to perform based on the source value.

  • count: The total number of source value items.
  • percent: The percentage of source value items.
  • sum: The sum of all source value items.


time_value

The total amount of time the rule applies in a past time range.


time_unit

The time unit. Used in conjunction with the time value.

  • hour: Time value as hours.
  • day: Time value as days.
  • week: Time value as weeks.
  • month: Time value as months.




time_rules

Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). Read More


enabled

Whether time rules are enabled.


options

An array of individual time rules.


enabled

Whether the specific time rule is enabled.


start_time

The start time, formatted as hh:mm:a


end_time

The end time, formatted as hh:mm:a


name

The specific weekday that the time rule applies.

  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday


option

Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges.

  • allow: Allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.
  • deny: Do not allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.





fields

The fields required for the user gateway based on the id of the site gateway fields.


id

The id for the individual field according to the site gateway fields required.


value

The value for the individual field according to the site gateway fields required.




Response JSON Schema


api_call_date

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


created_date

created_date_unix

The unix timestamp of when the item was created.


custom_descriptor

enabled

Whether the item is enabled or disabled.


name

The name of the item.


email

url

phone

address

city

state

postal_code


description

The description of the item.


discount_rate

enabled

Whether the item is enabled or disabled.


gateway_group

id

The RevCent ID of the object item.


name

The name of the item.



global_cascade_rules

revenue_rules

enabled

Whether the item is enabled or disabled.


options

enabled

Whether the item is enabled or disabled.


bound

rule_value

calculation

source

source_value

time_unit

time_value



time_rules

enabled

Whether the item is enabled or disabled.


options

start_time

end_time

name

The name of the item.


option

enabled

Whether the item is enabled or disabled.




enabled

Whether the item is enabled or disabled.



id

The RevCent ID of the object item.


merchant_account_id

The merchant account ID associated with the merchant gateway.


name

The name of the item.


request_method

The API request method.


request_type

The API request type.


result

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


site_gateway

id

The RevCent ID of the object item.


name

The name of the item.



transaction_fail_fee

transaction_success_fee

updated_date

updated_date_unix

The unix timestamp of when the item was updated.


Request JSON

{
  "request": {
    "type": "user_gateway",
    "method": "edit",
    "name": "Authorize.net",
    "user_gateway_id": "LYE26MW8Rlh5VbJmlp2l",
    "description": "My awesome gateway.",
    "enabled": true,
    "merchant_account_id": "845678",
    "transaction_success_fee": 0.55,
    "transaction_fail_fee": 0.65,
    "discount_rate": 2.71,
    "site_gateway_id": "dXAmybdWwYHrLyWRAAZV",
    "custom_descriptor": {
      "enabled": true,
      "name": "Acme Org",
      "email": "email@acme.org",
      "url": "https://www.acme.org",
      "phone": "867-5399",
      "address": "1600 Pennsylvania Ave",
      "city": "Washington",
      "state": "DC",
      "postal_code": "20500"
    },
    "global_cascade_rules": {
      "enabled": true,
      "revenue_rules": {
        "enabled": true,
        "options": [
          {
            "enabled": true,
            "bound": "max",
            "rule_value": 5,
            "calculation": "count",
            "source": "gateway",
            "source_value": "chargeback",
            "time_value": 1,
            "time_unit": "month"
          }
        ]
      },
      "time_rules": {
        "enabled": true,
        "options": [
          {
            "start_time": "12:00am",
            "end_time": "11:59pm",
            "name": "sunday",
            "option": "deny",
            "enabled": true
          }
        ]
      }
    },
    "fields": [
      {
        "id": "1",
        "value": "ABCD123"
      },
      {
        "id": "2",
        "value": "456efG789"
      }
    ]
  }
}

Response JSON

{
  "api_call_date": "2023-02-15T15:38:07+00:00",
  "api_call_id": "qZ90JMnBEBSOzznaldPj",
  "api_call_processed": true,
  "api_call_unix": 1676475487,
  "code": 1,
  "created_date": "2017-11-10T13:29:38+00:00",
  "created_date_unix": 1510320578,
  "custom_descriptor": {
    "enabled": true,
    "name": "Acme Org",
    "email": "email@acme.org",
    "url": "https://www.acme.org",
    "phone": "867-5399",
    "address": "1600 Pennsylvania Ave",
    "city": "Washington",
    "state": "DC",
    "postal_code": "20500"
  },
  "description": "Auth.net",
  "discount_rate": 2.5,
  "enabled": true,
  "gateway_group": [
    {
      "id": "GOGaPRql9oUAAkrm5Ll9",
      "name": "New Group"
    }
  ],
  "global_cascade_rules": {
    "revenue_rules": {
      "enabled": true,
      "options": [
        {
          "enabled": true,
          "bound": "max",
          "rule_value": 5,
          "calculation": "count",
          "source": "gateway",
          "source_value": "chargeback",
          "time_unit": "month",
          "time_value": 1
        }
      ]
    },
    "time_rules": {
      "enabled": true,
      "options": [
        {
          "start_time": "12:00am",
          "end_time": "11:59pm",
          "name": "sunday",
          "option": "deny",
          "enabled": true
        }
      ]
    },
    "enabled": true
  },
  "id": "LYE26MW8Rlh5VbJmlp2l",
  "merchant_account_id": "845678",
  "name": "Authorize.net",
  "request_method": "edit",
  "request_type": "user_gateway",
  "result": "Gateway edited.",
  "site_gateway": {
    "id": "dXAmybdWwYHrLyWRAAZV",
    "name": "Authorize.net"
  },
  "transaction_fail_fee": 0.15,
  "transaction_success_fee": 0.25,
  "updated_date": "2023-02-15T15:38:07+00:00",
  "updated_date_unix": 1676475487
}

User Gateway Retrieve


Retrieve current information on a single user gateway or multiple user gateways.

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.


custom_descriptor

enabled

Whether the item is enabled or disabled.


name

The name of the item.


email

url

phone

address

city

state

postal_code


description

The description of the item.


discount_rate

enabled

Whether the item is enabled or disabled.


gateway_group

id

The RevCent ID of the object item.


name

The name of the item.



global_cascade_rules

revenue_rules

enabled

Whether the item is enabled or disabled.


options

enabled

Whether the item is enabled or disabled.


bound

rule_value

calculation

source

source_value

time_unit

time_value



time_rules

enabled

Whether the item is enabled or disabled.


options

start_time

end_time

name

The name of the item.


option

enabled

Whether the item is enabled or disabled.




enabled

Whether the item is enabled or disabled.



id

The RevCent ID of the object item.


merchant_account_id

The merchant account ID associated with the merchant gateway.


name

The name of the item.


site_gateway

id

The RevCent ID of the object item.


name

The name of the item.



transaction_fail_fee

transaction_success_fee

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": "user_gateway",
    "method": "retrieve",
    "id": "LYE26MW8Rlh5VbJmlp2l",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1,
      "status_filter": [
        "enabled"
      ]
    }
  }
}

Response JSON

{
  "api_call_id": "8ry1nRVXMaHvjrlKrKvl",
  "api_call_processed": true,
  "api_call_unix": 1676475737,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "user_gateway",
  "results": [
    {
      "created_date_unix": 1510320578,
      "custom_descriptor": {
        "enabled": true,
        "name": "Acme Org",
        "email": "email@acme.org",
        "url": "https://www.acme.org",
        "phone": "867-5399",
        "address": "1600 Pennsylvania Ave",
        "city": "Washington",
        "state": "DC",
        "postal_code": "20500"
      },
      "description": "Auth.net",
      "discount_rate": 2.5,
      "enabled": true,
      "gateway_group": [
        {
          "id": "GOGaPRql9oUAAkrm5Ll9",
          "name": "New Group"
        }
      ],
      "global_cascade_rules": {
        "revenue_rules": {
          "enabled": true,
          "options": [
            {
              "enabled": true,
              "bound": "max",
              "rule_value": 5,
              "calculation": "count",
              "source": "gateway",
              "source_value": "chargeback",
              "time_unit": "month",
              "time_value": 1
            }
          ]
        },
        "time_rules": {
          "enabled": true,
          "options": [
            {
              "start_time": "12:00am",
              "end_time": "11:59pm",
              "name": "sunday",
              "option": "deny",
              "enabled": true
            }
          ]
        },
        "enabled": true
      },
      "id": "LYE26MW8Rlh5VbJmlp2l",
      "merchant_account_id": "845678",
      "name": "Authorize.net",
      "site_gateway": {
        "id": "dXAmybdWwYHrLyWRAAZV",
        "name": "Authorize.net"
      },
      "transaction_fail_fee": 0,
      "transaction_success_fee": 0,
      "updated_date_unix": 1676475487
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Gateway Group


A gateway group is a group of gateways that can be used within a payment profile cascade. You can then add or remove a user gateway(s) from gateway groups as needed, without needing to modify the payment profile. Read more about Gateway Groups .

Gateway Group Create


Create a gateway group within RevCent via the gateway group create method.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


name

The name of the item.


description

The description of the item.


enabled

Whether the item is enabled or disabled.


choice_method

The method in which the gateway group will select an individual gateway.


user_gateway

An array of user gateway IDs to have in the gateway group.



Response JSON Schema


api_call_date

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


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.


request_method

The API request method.


request_type

The API request type.


result

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


updated_date_unix

The unix timestamp of when the item was updated.


user_gateway

id

The RevCent ID of the object item.


name

The name of the item.


enabled

Whether the item is enabled or disabled.



Request JSON

{
  "request": {
    "type": "gateway_group",
    "method": "create",
    "name": "New Group",
    "description": "Group description.",
    "choice_method": "evenly_distribute",
    "enabled": true,
    "user_gateway": [
      "LYE26MW8Rlh5VbJmlp2l",
      "8rNnkY45R4Hw1ZBg1yYB"
    ]
  }
}

Response JSON

{
  "api_call_date": "2023-02-15T15:31:56+00:00",
  "api_call_id": "ajzVv1LMXPc0l6pQ4wLv",
  "api_call_processed": true,
  "api_call_unix": 1676475116,
  "code": 1,
  "created_date_unix": 1676475116,
  "description": "Group description",
  "enabled": true,
  "id": "2r1kMjvz2YC6bWGdjOYB",
  "name": "New Group",
  "request_method": "create",
  "request_type": "gateway_group",
  "result": "Gateway group created.",
  "updated_date_unix": 1676475116,
  "user_gateway": [
    {
      "id": "LYE26MW8Rlh5VbJmlp2l",
      "name": "Authorize.net",
      "enabled": true
    },
    {
      "id": "8rNnkY45R4Hw1ZBg1yYB",
      "name": "NMI",
      "enabled": true
    }
  ]
}

Gateway Group Edit


Edit an existing gateway group within RevCent via the gateway group edit method.
Note: Only provide the properties you wish to modify. Properties not provided will remain unchanged.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


gateway_group_id

The gateway group ID


name

The name of the item.


description

The description of the item.


enabled

Whether the item is enabled or disabled.


choice_method

The method in which the gateway group will select an individual gateway.


user_gateway

An array of user gateway IDs to have in the gateway group. Important: This array will replace the gateways within a gateway group. Use the add_user_gateway or remove_user_gateway methods for adding or removing specific gateway(s) within a group while leaving the remaining user gateways.



Response JSON Schema


api_call_date

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


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.


request_method

The API request method.


request_type

The API request type.


result

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


updated_date_unix

The unix timestamp of when the item was updated.


user_gateway

id

The RevCent ID of the object item.


name

The name of the item.


enabled

Whether the item is enabled or disabled.



Request JSON

{
  "request": {
    "type": "gateway_group",
    "method": "edit",
    "gateway_group_id": "GOGaPRql9oUAAkrm5Ll9",
    "name": "New Group",
    "description": "Group description.",
    "choice_method": "round_robin",
    "enabled": true,
    "user_gateway": [
      "8rNnkY45R4Hw1ZBg1yYB"
    ]
  }
}

Response JSON

{
  "api_call_date": "2023-02-15T15:31:56+00:00",
  "api_call_id": "ajzVv1LMXPc0l6pQ4wLv",
  "api_call_processed": true,
  "api_call_unix": 1676475116,
  "code": 1,
  "created_date_unix": 1676475116,
  "description": "Group description",
  "enabled": true,
  "id": "2r1kMjvz2YC6bWGdjOYB",
  "name": "New Group 2",
  "request_method": "edit",
  "request_type": "gateway_group",
  "result": "Gateway group edited.",
  "updated_date_unix": 1676475116,
  "user_gateway": [
    {
      "id": "8rNnkY45R4Hw1ZBg1yYB",
      "name": "NMI",
      "enabled": true
    }
  ]
}

Gateway Group Add User Gateway


Add a user gateway to a gateway group. Use this method to add a user gateway(s) without modifying existing user gateways in the gateway group.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


gateway_group_id

The gateway group ID


user_gateway

An array of user gateway IDs to add to the gateway group.



Response JSON Schema


api_call_date

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


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.


request_method

The API request method.


request_type

The API request type.


result

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


updated_date_unix

The unix timestamp of when the item was updated.


user_gateway

id

The RevCent ID of the object item.


name

The name of the item.


enabled

Whether the item is enabled or disabled.



Request JSON

{
  "request": {
    "type": "gateway_group",
    "method": "add_user_gateway",
    "gateway_group_id": "GOGaPRql9oUAAkrm5Ll9",
    "user_gateway": [
      "GOJankNpkpsPzw6No1OP"
    ]
  }
}

Response JSON

{
  "api_call_date": "2023-02-15T02:51:25+00:00",
  "api_call_id": "ZVAlyYEgnOSR2wEYZbZg",
  "api_call_processed": true,
  "api_call_unix": 1676429485,
  "code": 1,
  "created_date_unix": 1675884443,
  "description": "",
  "enabled": true,
  "id": "GOGaPRql9oUAAkrm5Ll9",
  "name": "New Group",
  "request_method": "add_user_gateway",
  "request_type": "gateway_group",
  "result": "Gateway added to group.",
  "updated_date_unix": 1676429485,
  "user_gateway": [
    {
      "id": "GOJankNpkpsPzw6No1OP",
      "name": "Stripe",
      "enabled": true
    },
    {
      "id": "8rNnkY45R4Hw1ZBg1yYB",
      "name": "NMI",
      "enabled": true
    }
  ]
}

Gateway Group Remove User Gateway


Remove a user gateway to a gateway group. Use this method to remove a user gateway(s) without modifying existing user gateways in the gateway group.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


gateway_group_id

The gateway group ID


user_gateway

An array of user gateway IDs to remove from the gateway group.



Response JSON Schema


api_call_date

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


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.


request_method

The API request method.


request_type

The API request type.


result

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


updated_date_unix

The unix timestamp of when the item was updated.


user_gateway

id

The RevCent ID of the object item.


name

The name of the item.


enabled

Whether the item is enabled or disabled.



Request JSON

{
  "request": {
    "type": "gateway_group",
    "method": "remove_user_gateway",
    "gateway_group_id": "GOGaPRql9oUAAkrm5Ll9",
    "user_gateway": [
      "GOJankNpkpsPzw6No1OP"
    ]
  }
}

Response JSON

{
  "api_call_date": "2023-02-15T02:51:01+00:00",
  "api_call_id": "Q4kdYEAqPkt8lO14XNXL",
  "api_call_processed": true,
  "api_call_unix": 1676429461,
  "code": 1,
  "created_date_unix": 1675884443,
  "description": "",
  "enabled": true,
  "id": "GOGaPRql9oUAAkrm5Ll9",
  "name": "New Group",
  "request_method": "remove_user_gateway",
  "request_type": "gateway_group",
  "result": "Gateway removed from group.",
  "updated_date_unix": 1676429461,
  "user_gateway": [
    {
      "id": "8rNnkY45R4Hw1ZBg1yYB",
      "name": "NMI",
      "enabled": true
    }
  ]
}

Gateway Group Retrieve


Retrieve current information on a single gateway group or multiple gateway 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.


user_gateway

id

The RevCent ID of the object item.


name

The name of the item.


enabled

Whether the item is enabled or disabled.




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": "gateway_group",
    "method": "retrieve",
    "id": "GOGaPRql9oUAAkrm5Ll9",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1,
      "status_filter": [
        "enabled"
      ]
    }
  }
}

Response JSON

{
  "api_call_id": "JNOdrkg91lh4LWlZWAVv",
  "api_call_processed": true,
  "api_call_unix": 1676476618,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "gateway_group",
  "results": [
    {
      "created_date_unix": 1675884443,
      "description": "",
      "enabled": true,
      "id": "GOGaPRql9oUAAkrm5Ll9",
      "name": "New Group",
      "updated_date_unix": 1676429485,
      "user_gateway": [
        {
          "id": "8rNnkY45R4Hw1ZBg1yYB",
          "name": "NMI",
          "enabled": true
        }
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Payment Profile


A payment profile allows payments to flow through your processors based on specific rules, as well as process lost revenue from fully declined or partially declined payments. Read more about Payment Profiles .

Payment Profile Create


Create a payment profile within RevCent via the payment profile create method.

Important: Payment profiles are a powerful feature, with settings and orders that require detailed precision. A misconfigured payment profile can prevent payments from processing entirely. Please read more about Payment Profiles before proceeding.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


name

The name of the item.


description

The description of the item.


enabled

Whether the item is enabled or disabled.


steps

The steps for the payment flow. The payment flow is the core part of a payment profile and dictates what processor to use for a payment and what to do if a payment is declined. The payment flow consists of steps, each step being a payment attempt. Read More


declined_options

The options to take if the step transaction is declined.


declined_setting

The value in which to modify according to declined_modify.


declined_modify

  • nothing: Do nothing simply ends the payment profile process at the step. The transaction is returned as declined.
  • nomodify: Don't Modify Amount allows you to simply proceed to another step. For example, if you wish to try another gateway without modifying the initial amount, you would choose this.
  • modifypct: Modify the original transaction amount by a percentage decrease.
  • modifyspf: Modify the original transaction amount by a fixed dollar amount decrease.


declined_action

  • next: If you wish to proceed to the next step in the flow.
  • repeat: If you wish to repeat to the current step one more time.
  • nothing: If you wish to end the payment flow.



order

The order of the step within the array of steps.


source

  • gateway: Process step transaction using a specific gateway.
  • cascade: Process step transaction using the cascade.


cascade_order

  • sort_order: Process valid gateways in the sort order within the cascade, beginning with gateway 1 in the cascade. I.e. if gateway 1 is valid, then it will be used, else gateway 2 if valid, and so on.
  • round_robin: Process cascade gateways in the sort order within the cascade, beginning with the next gateway after the last transaction gateway used in the cascade sort order. I.e. if gateway 1 was last used, then gateway 2 will be used if valid. If gateway 3 is last used, and is the last gateway in the rotation, then the rotation resets and gateway 1 will be used if valid.
  • evenly_distribute: Process valid gateways by even distribution of total captured payment volume within the past 24 hours. Sort order in the cascade is ignored. Instead, least captured payment volume is what determines which gateway will be used. I.e. If gateway X has total captured payment volume of $210, gateway Y has total captured payment volume of $200 and gateway Z has total captured payment volume of $230, then gateway Y will be used as it has the least total captured payment volume.


gateway

The ID of the gateway, if source is gateway.


swap_card

Whether to try a different card if a preceeding step is declined.



cascade

A payment profile cascade allows you to process transactions at specific gateways using a specific order and set rules for each gateway. Read More


cascade_source

The source of items for the cascade.

  • gateways: Use the list of gateway(s) as the cascade source.
  • gateway_groups: Use the list of gateway group(s) as the cascade source.


gateways

A list of one or more gateways to use as the source within the cascade. Read More


revenue_rules

Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. Read More


enabled

Whether revenue rules are enabled.


options

An array of individual revenue rules.


enabled

Whether the specific revenue rule is enabled.


bound

The rule bounds to declare if a rule passes or fails.

  • min: The final calculation value must be greater than the Rule Value.
  • max: The final calculation value must be less than the Rule Value.


rule_value

The rule value is compared with the calculation value and bound.


source

The source, in combination with the source value and calculation, is what is used to form the calculation value.

  • gateway: Transactions only from the specific gateway the rule is within.
  • global: All transactions regardless of gateway.
  • step: The active step being processed during the payment flow.


source_value

The source value is specific to the source selected.

  • captured: Only transactions which were captured.
  • declined: Only transactions which were declined.
  • chargeback: Only transactions which were marked as charged back.
  • total: All transactions regardless of outcome or status.
  • amount: Applicable only when source is 'Active Step'. The amount for the active step being processed during the payment flow.


calculation

The calculation to perform based on the source value.

  • count: The total number of source value items.
  • percent: The percentage of source value items.
  • sum: The sum of all source value items.


time_value

The total amount of time the rule applies in a past time range.


time_unit

The time unit. Used in conjunction with the time value.

  • hour: Time value as hours.
  • day: Time value as days.
  • week: Time value as weeks.
  • month: Time value as months.




time_rules

Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). Read More


enabled

Whether time rules are enabled.


options

An array of individual time rules.


enabled

Whether the specific time rule is enabled.


start_time

The start time, formatted as hh:mm:a


end_time

The end time, formatted as hh:mm:a


name

The specific weekday that the time rule applies.

  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday


option

Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges.

  • allow: Allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.
  • deny: Do not allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.




enabled

Whether the gateway is enabled within the cascade.


order

The order in which the gateway resides in the cascade.


id

The ID of the gateway.



gateway_groups

A list of one or more gateway groups to use as the source within the cascade. Read More


enabled

Whether the gateway group is enabled within the cascade.


order

The order in which the gateway group resides in the cascade.


id

The ID of the gateway group.




kill_terms

You have the ability to cancel the payment profile flow if a declined transaction has specific terms/phrases/words in a step gateways' decline response. Read More


enabled

Whether to enable kill terms.


terms

An array of one or more kill terms. Kill terms are case-insensitive. This will also cancel/void the related sale being attempted. Only applies to initial sale attempts, not renewals or trial expirations.



max_attempts

You have the ability to cancel/void a sale if the number of declined payment profile attempts reaches a certain number. Read More


enabled

Whether to enable max attempts.


num

The number of failed payment profile attempts, where once reached, the sale being processed will automatically be cancelled/voided.




Response JSON Schema


api_call_date

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.


cascade

cascade_source

gateways

enabled

Whether the item is enabled or disabled.


order

id

The RevCent ID of the object item.


global_cascade_rules_enabled

revenue_rules

enabled

Whether the item is enabled or disabled.


options

enabled

Whether the item is enabled or disabled.


bound

rule_value

calculation

source

source_value

time_unit

time_value



time_rules

enabled

Whether the item is enabled or disabled.


options

start_time

end_time

name

The name of the item.


option

enabled

Whether the item is enabled or disabled.




name

The name of the item.



gateway_groups

enabled

Whether the item is enabled or disabled.


order

id

The RevCent ID of the object item.


name

The name of the item.




code

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


created_date

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.


kill_terms

enabled

Whether the item is enabled or disabled.


terms


max_attempts

enabled

Whether the item is enabled or disabled.


num


name

The name of the item.


request_method

The API request method.


request_type

The API request type.


result

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


steps

declined_options

declined_action

declined_modify

declined_setting


cascade_order

source

gateway

Gateway related to the item.


swap_card

order


updated_date

updated_date_unix

The unix timestamp of when the item was updated.


Request JSON

{
  "request": {
    "type": "payment_profile",
    "method": "create",
    "name": "My Payment Profile",
    "description": "",
    "enabled": true,
    "steps": [
      {
        "declined_options": {
          "declined_setting": "modifypct",
          "declined_modify": "10",
          "declined_action": "next"
        },
        "order": 1,
        "source": "cascade",
        "cascade_order": "round_robin",
        "gateway": "LYE26MW8Rlh5VbJmlp2l",
        "swap_card": false
      },
      {
        "declined_options": {
          "declined_setting": "nothing",
          "declined_modify": "0",
          "declined_action": "nothing"
        },
        "order": 2,
        "source": "gateway",
        "cascade_order": "round_robin",
        "gateway": "8rNnkY45R4Hw1ZBg1yYB",
        "swap_card": true
      }
    ],
    "cascade": {
      "cascade_source": "gateway_groups",
      "gateways": [
        {
          "revenue_rules": {
            "enabled": true,
            "options": [
              {
                "enabled": true,
                "bound": "max",
                "rule_value": 5,
                "calculation": "count",
                "source": "gateway",
                "source_value": "chargeback",
                "time_value": 1,
                "time_unit": "month"
              }
            ]
          },
          "time_rules": {
            "enabled": true,
            "options": [
              {
                "start_time": "12:00am",
                "end_time": "11:59pm",
                "name": "sunday",
                "option": "deny",
                "enabled": true
              }
            ]
          },
          "enabled": true,
          "order": 1,
          "id": "LYE26MW8Rlh5VbJmlp2l"
        }
      ],
      "gateway_groups": [
        {
          "enabled": false,
          "order": 1,
          "id": "GOGaPRql9oUAAkrm5Ll9"
        }
      ]
    },
    "kill_terms": {
      "enabled": true,
      "terms": [
        "NSF"
      ]
    },
    "max_attempts": {
      "enabled": true,
      "num": 1
    }
  }
}

Response JSON

{
  "api_call_date": "2023-02-17T20:01:46+00:00",
  "api_call_id": "zGJbyZPNQkILyN9Z6L4a",
  "api_call_processed": true,
  "api_call_unix": 1676664106,
  "cascade": {
    "cascade_source": "gateway_groups",
    "gateways": [
      {
        "enabled": true,
        "order": 1,
        "id": "LYE26MW8Rlh5VbJmlp2l",
        "global_cascade_rules_enabled": true,
        "revenue_rules": {
          "enabled": true,
          "options": [
            {
              "enabled": true,
              "bound": "max",
              "rule_value": 5,
              "calculation": "count",
              "source": "gateway",
              "source_value": "chargeback",
              "time_unit": "month",
              "time_value": 1
            }
          ]
        },
        "time_rules": {
          "enabled": true,
          "options": [
            {
              "start_time": "12:00am",
              "end_time": "11:59pm",
              "name": "sunday",
              "option": "deny",
              "enabled": true
            }
          ]
        },
        "name": "Authorize.net"
      }
    ],
    "gateway_groups": [
      {
        "enabled": false,
        "order": 1,
        "id": "GOGaPRql9oUAAkrm5Ll9",
        "name": "New Group"
      }
    ]
  },
  "code": 1,
  "created_date": "2023-02-17T20:01:46+00:00",
  "created_date_unix": 1676664106,
  "description": "",
  "enabled": true,
  "id": "RJ0YXwdGzbFpXO9ENpqw",
  "kill_terms": {
    "enabled": true,
    "terms": [
      "NSF"
    ]
  },
  "max_attempts": {
    "enabled": true,
    "num": 1
  },
  "name": "My Payment Profile",
  "request_method": "create",
  "request_type": "payment_profile",
  "result": "Payment profile created.",
  "steps": [
    {
      "declined_options": {
        "declined_action": "next",
        "declined_modify": "10",
        "declined_setting": "modifypct"
      },
      "cascade_order": "round_robin",
      "source": "cascade",
      "gateway": null,
      "swap_card": false,
      "order": 1
    },
    {
      "declined_options": {
        "declined_action": "nothing",
        "declined_modify": "0",
        "declined_setting": "nothing"
      },
      "cascade_order": "round_robin",
      "source": "gateway",
      "gateway": "8rNnkY45R4Hw1ZBg1yYB",
      "swap_card": true,
      "order": 2
    }
  ],
  "updated_date": "2023-02-17T20:01:46+00:00",
  "updated_date_unix": 1676664106
}

Payment Profile Edit


Edit an existing payment profile within RevCent via the payment profile edit method.
Note: Only provide the properties you wish to modify. Properties not provided will remain unchanged.

Important: Payment profiles are a powerful feature, with settings and orders that require detailed precision. A misconfigured payment profile can prevent payments from processing entirely. Please read more about Payment Profiles before proceeding.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


payment_profile_id

The ID of the payment profile you are modifying.


name

The name of the item.


description

The description of the item.


enabled

Whether the item is enabled or disabled.


steps

The steps for the payment flow. The payment flow is the core part of a payment profile and dictates what processor to use for a payment and what to do if a payment is declined. The payment flow consists of steps, each step being a payment attempt. Read More


declined_options

The options to take if the step transaction is declined.


declined_setting

The value in which to modify according to declined_modify.


declined_modify

  • nothing: Do nothing simply ends the payment profile process at the step. The transaction is returned as declined.
  • nomodify: Don't Modify Amount allows you to simply proceed to another step. For example, if you wish to try another gateway without modifying the initial amount, you would choose this.
  • modifypct: Modify the original transaction amount by a percentage decrease.
  • modifyspf: Modify the original transaction amount by a fixed dollar amount decrease.


declined_action

  • next: If you wish to proceed to the next step in the flow.
  • repeat: If you wish to repeat to the current step one more time.
  • nothing: If you wish to end the payment flow.



order

The order of the step within the array of steps.


source

  • gateway: Process step transaction using a specific gateway.
  • cascade: Process step transaction using the cascade.


cascade_order

  • sort_order: Process valid gateways in the sort order within the cascade, beginning with gateway 1 in the cascade. I.e. if gateway 1 is valid, then it will be used, else gateway 2 if valid, and so on.
  • round_robin: Process cascade gateways in the sort order within the cascade, beginning with the next gateway after the last transaction gateway used in the cascade sort order. I.e. if gateway 1 was last used, then gateway 2 will be used if valid. If gateway 3 is last used, and is the last gateway in the rotation, then the rotation resets and gateway 1 will be used if valid.
  • evenly_distribute: Process valid gateways by even distribution of total captured payment volume within the past 24 hours. Sort order in the cascade is ignored. Instead, least captured payment volume is what determines which gateway will be used. I.e. If gateway X has total captured payment volume of $210, gateway Y has total captured payment volume of $200 and gateway Z has total captured payment volume of $230, then gateway Y will be used as it has the least total captured payment volume.


gateway

The ID of the gateway, if source is gateway.


swap_card

Whether to try a different card if a preceeding step is declined.



cascade

A payment profile cascade allows you to process transactions at specific gateways using a specific order and set rules for each gateway. Read More


cascade_source

The source of items for the cascade.

  • gateways: Use the list of gateway(s) as the cascade source.
  • gateway_groups: Use the list of gateway group(s) as the cascade source.


gateways

A list of one or more gateways to use as the source within the cascade. Read More


revenue_rules

Revenue rules are specific to the gateway, and allow or disallow the use of the gateway based on payment volume, occurrences and more. You can add multiple revenue rules to a gateway within the cascade. Read More


enabled

Whether revenue rules are enabled.


options

An array of individual revenue rules.


enabled

Whether the specific revenue rule is enabled.


bound

The rule bounds to declare if a rule passes or fails.

  • min: The final calculation value must be greater than the Rule Value.
  • max: The final calculation value must be less than the Rule Value.


rule_value

The rule value is compared with the calculation value and bound.


source

The source, in combination with the source value and calculation, is what is used to form the calculation value.

  • gateway: Transactions only from the specific gateway the rule is within.
  • global: All transactions regardless of gateway.
  • step: The active step being processed during the payment flow.


source_value

The source value is specific to the source selected.

  • captured: Only transactions which were captured.
  • declined: Only transactions which were declined.
  • chargeback: Only transactions which were marked as charged back.
  • total: All transactions regardless of outcome or status.
  • amount: Applicable only when source is 'Active Step'. The amount for the active step being processed during the payment flow.


calculation

The calculation to perform based on the source value.

  • count: The total number of source value items.
  • percent: The percentage of source value items.
  • sum: The sum of all source value items.


time_value

The total amount of time the rule applies in a past time range.


time_unit

The time unit. Used in conjunction with the time value.

  • hour: Time value as hours.
  • day: Time value as days.
  • week: Time value as weeks.
  • month: Time value as months.




time_rules

Time rules are specific to the gateway, and allow or disallow the use of the gateway based on time settings. All time rules are GMT (UTC+0). Read More


enabled

Whether time rules are enabled.


options

An array of individual time rules.


enabled

Whether the specific time rule is enabled.


start_time

The start time, formatted as hh:mm:a


end_time

The end time, formatted as hh:mm:a


name

The specific weekday that the time rule applies.

  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday


option

Whether to allow or deny the gateway from processing the step transaction based on the current GMT time and the rule day and time ranges.

  • allow: Allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.
  • deny: Do not allow the gateway to process the step transaction if current GMT time and day are within the day and time ranges.




enabled

Whether the gateway is enabled within the cascade.


order

The order in which the gateway resides in the cascade.


id

The ID of the gateway.



gateway_groups

A list of one or more gateway groups to use as the source within the cascade. Read More


enabled

Whether the gateway group is enabled within the cascade.


order

The order in which the gateway group resides in the cascade.


id

The ID of the gateway group.




kill_terms

You have the ability to cancel the payment profile flow if a declined transaction has specific terms/phrases/words in a step gateways' decline response. Read More


enabled

Whether to enable kill terms.


terms

An array of one or more kill terms. Kill terms are case-insensitive. This will also cancel/void the related sale being attempted. Only applies to initial sale attempts, not renewals or trial expirations.



max_attempts

You have the ability to cancel/void a sale if the number of declined payment profile attempts reaches a certain number. Read More


enabled

Whether to enable max attempts.


num

The number of failed payment profile attempts, where once reached, the sale being processed will automatically be cancelled/voided.




Response JSON Schema


api_call_date

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.


cascade

cascade_source

gateways

enabled

Whether the item is enabled or disabled.


order

id

The RevCent ID of the object item.


global_cascade_rules_enabled

revenue_rules

enabled

Whether the item is enabled or disabled.


options

enabled

Whether the item is enabled or disabled.


bound

rule_value

calculation

source

source_value

time_unit

time_value



time_rules

enabled

Whether the item is enabled or disabled.


options

start_time

end_time

name

The name of the item.


option

enabled

Whether the item is enabled or disabled.




name

The name of the item.



gateway_groups

enabled

Whether the item is enabled or disabled.


order

id

The RevCent ID of the object item.


name

The name of the item.




code

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


created_date

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.


kill_terms

enabled

Whether the item is enabled or disabled.


terms


max_attempts

enabled

Whether the item is enabled or disabled.


num


name

The name of the item.


request_method

The API request method.


request_type

The API request type.


result

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


steps

declined_options

declined_setting

declined_modify

declined_action


source

cascade_order

gateway

Gateway related to the item.


swap_card

order


updated_date

updated_date_unix

The unix timestamp of when the item was updated.


Request JSON

{
  "request": {
    "type": "payment_profile",
    "method": "edit",
    "payment_profile_id": "RJ0YXwdGzbFpXO9ENpqw",
    "name": "My Payment Profile",
    "description": "",
    "enabled": true,
    "steps": [
      {
        "declined_options": {
          "declined_setting": "modifypct",
          "declined_modify": "10",
          "declined_action": "next"
        },
        "order": 1,
        "source": "cascade",
        "cascade_order": "round_robin",
        "gateway": "LYE26MW8Rlh5VbJmlp2l",
        "swap_card": false
      },
      {
        "declined_options": {
          "declined_setting": "nothing",
          "declined_modify": "0",
          "declined_action": "nothing"
        },
        "order": 2,
        "source": "gateway",
        "cascade_order": "round_robin",
        "gateway": "8rNnkY45R4Hw1ZBg1yYB",
        "swap_card": true
      }
    ],
    "cascade": {
      "cascade_source": "gateways",
      "gateways": [
        {
          "revenue_rules": {
            "enabled": true,
            "options": [
              {
                "enabled": true,
                "bound": "max",
                "rule_value": 5,
                "calculation": "count",
                "source": "gateway",
                "source_value": "chargeback",
                "time_value": 1,
                "time_unit": "month"
              }
            ]
          },
          "time_rules": {
            "enabled": false,
            "options": [
              {
                "start_time": "12:00am",
                "end_time": "11:59pm",
                "name": "sunday",
                "option": "deny",
                "enabled": true
              }
            ]
          },
          "enabled": true,
          "order": 1,
          "id": "LYE26MW8Rlh5VbJmlp2l"
        }
      ],
      "gateway_groups": [
        {
          "enabled": false,
          "order": 1,
          "id": "GOGaPRql9oUAAkrm5Ll9"
        }
      ]
    },
    "kill_terms": {
      "enabled": true,
      "terms": [
        "NSF"
      ]
    },
    "max_attempts": {
      "enabled": true,
      "num": 1
    }
  }
}

Response JSON

{
  "api_call_date": "2023-02-17T20:04:23+00:00",
  "api_call_id": "6rQPpKLzmnhmLOpQ5JlL",
  "api_call_processed": true,
  "api_call_unix": 1676664263,
  "cascade": {
    "cascade_source": "gateways",
    "gateways": [
      {
        "enabled": true,
        "order": 1,
        "id": "LYE26MW8Rlh5VbJmlp2l",
        "global_cascade_rules_enabled": true,
        "revenue_rules": {
          "enabled": true,
          "options": [
            {
              "enabled": true,
              "bound": "max",
              "rule_value": 5,
              "calculation": "count",
              "source": "gateway",
              "source_value": "chargeback",
              "time_unit": "month",
              "time_value": 1
            }
          ]
        },
        "time_rules": {
          "enabled": true,
          "options": [
            {
              "start_time": "12:00am",
              "end_time": "11:59pm",
              "name": "sunday",
              "option": "deny",
              "enabled": true
            }
          ]
        },
        "name": "Authorize.net"
      }
    ],
    "gateway_groups": [
      {
        "enabled": false,
        "order": 1,
        "id": "GOGaPRql9oUAAkrm5Ll9",
        "name": "New Group"
      }
    ]
  },
  "code": 1,
  "created_date": "2023-02-17T20:01:46+00:00",
  "created_date_unix": 1676664106,
  "description": "",
  "enabled": true,
  "id": "RJ0YXwdGzbFpXO9ENpqw",
  "kill_terms": {
    "enabled": true,
    "terms": [
      "NSF"
    ]
  },
  "max_attempts": {
    "enabled": true,
    "num": 1
  },
  "name": "My Payment Profile",
  "request_method": "edit",
  "request_type": "payment_profile",
  "result": "Payment profile edited.",
  "steps": [
    {
      "declined_options": {
        "declined_setting": "modifypct",
        "declined_modify": "10",
        "declined_action": "next"
      },
      "source": "cascade",
      "cascade_order": "round_robin",
      "gateway": null,
      "swap_card": false,
      "order": 1
    },
    {
      "declined_options": {
        "declined_setting": "nothing",
        "declined_modify": "0",
        "declined_action": "nothing"
      },
      "source": "gateway",
      "cascade_order": "round_robin",
      "gateway": "8rNnkY45R4Hw1ZBg1yYB",
      "swap_card": true,
      "order": 2
    }
  ],
  "updated_date": "2023-02-17T20:04:23+00:00",
  "updated_date_unix": 1676664263
}

Payment Profile Retrieve


Retrieve current information on a single payment profile or multiple payment profiles.

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.


cascade

cascade_source

gateways

enabled

Whether the item is enabled or disabled.


order

id

The RevCent ID of the object item.


global_cascade_rules_enabled

revenue_rules

enabled

Whether the item is enabled or disabled.


options

enabled

Whether the item is enabled or disabled.


bound

rule_value

calculation

source

source_value

time_unit

time_value



time_rules

enabled

Whether the item is enabled or disabled.


options

start_time

end_time

name

The name of the item.


option

enabled

Whether the item is enabled or disabled.




name

The name of the item.



gateway_groups

enabled

Whether the item is enabled or disabled.


order

id

The RevCent ID of the object item.


name

The name of the 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.


kill_terms

enabled

Whether the item is enabled or disabled.


terms


max_attempts

enabled

Whether the item is enabled or disabled.


num


name

The name of the item.


steps

declined_options

declined_setting

declined_modify

declined_action


source

cascade_order

gateway

Gateway related to the item.


swap_card

order


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": "payment_profile",
    "method": "retrieve",
    "id": "2r1Wo7KvJ6slWE99XK5y",
    "multiple": false,
    "filters": {
      "limit": 100,
      "page": 1,
      "status_filter": [
        "enabled"
      ]
    }
  }
}

Response JSON

{
  "api_call_id": "ZVA1wj2YoRCqY0a8Mz8m",
  "api_call_processed": true,
  "api_call_unix": 1676663664,
  "code": 1,
  "current_count": 1,
  "current_page": 1,
  "request_method": "retrieve",
  "request_type": "payment_profile",
  "results": [
    {
      "cascade": {
        "cascade_source": "gateways",
        "gateways": [
          {
            "enabled": true,
            "order": 1,
            "id": "LYE26MW8Rlh5VbJmlp2l",
            "global_cascade_rules_enabled": true,
            "revenue_rules": {
              "enabled": true,
              "options": [
                {
                  "enabled": true,
                  "bound": "max",
                  "rule_value": 5,
                  "calculation": "count",
                  "source": "gateway",
                  "source_value": "chargeback",
                  "time_unit": "month",
                  "time_value": 1
                }
              ]
            },
            "time_rules": {
              "enabled": true,
              "options": [
                {
                  "start_time": "12:00am",
                  "end_time": "11:59pm",
                  "name": "sunday",
                  "option": "deny",
                  "enabled": true
                }
              ]
            },
            "name": "Authorize.net"
          }
        ],
        "gateway_groups": [
          {
            "enabled": false,
            "order": 1,
            "id": "GOGaPRql9oUAAkrm5Ll9",
            "name": "My Gatewway Group"
          }
        ]
      },
      "created_date_unix": 1676657587,
      "description": "",
      "enabled": false,
      "id": "2r1Wo7KvJ6slWE99XK5y",
      "kill_terms": {
        "enabled": true,
        "terms": [
          "pick up card"
        ]
      },
      "max_attempts": {
        "enabled": true,
        "num": 2
      },
      "name": "My Payment Profile",
      "steps": [
        {
          "declined_options": {
            "declined_setting": "modifypct",
            "declined_modify": "15",
            "declined_action": "next"
          },
          "source": "cascade",
          "cascade_order": "evenly_distribute",
          "gateway": null,
          "swap_card": false,
          "order": 1
        },
        {
          "declined_options": {
            "declined_setting": "nothing",
            "declined_modify": "0",
            "declined_action": "nothing"
          },
          "source": "gateway",
          "cascade_order": "round_robin",
          "gateway": "8rNnkY45R4Hw1ZBg1yYB",
          "swap_card": true,
          "order": 2
        }
      ],
      "updated_date_unix": 1676661655
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Invoice


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

Invoice Create


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

AdWords Integration

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

Example

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

Request JSON Schema


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": "George",
      "last_name": "Washington",
      "address_line_1": "1600 Pennsylvania Ave",
      "address_line_2": "",
      "city": "Washington",
      "state": "DC",
      "zip": "20500",
      "country": "USA",
      "company": "",
      "email": "george@whitehouse.gov",
      "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": "georgew@whitehouse.com",
    "enabled": true,
    "first_name": "George",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "pres_0001",
    "last_name": "Washington",
    "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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "date_paid": null,
      "discounts": [],
      "download_url": "",
      "hosted_url": "https://securehost.revcent.com/MyCompanyName/invoice?invoice_id=bOqOV2gJ6nca1aKq1Ezb",
      "id": "bOqOV2gJ6nca1aKq1Ezb",
      "invoice_profile": {
        "id": "gYo0YVd24Qf7QvdBYM2O",
        "name": "tqawqtq"
      },
      "is_sale": true,
      "is_subscription_renewal": false,
      "iso_currency": "USD",
      "license_keys": [],
      "metadata": [
        {
          "entry_date": "2020-10-17",
          "name": "invoice_create",
          "value": "test"
        }
      ],
      "notes": [],
      "offline_payments": [],
      "paid": false,
      "payment_type": null,
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [],
      "quota_accounts": [],
      "revcent_shop": null,
      "sales": [
        "4ryrgOZkvAtKNK9wNv8l"
      ],
      "salvage_transactions": [],
      "shipping": [],
      "smtp_messages": [],
      "status": "Unpaid",
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [],
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1602978433,
      "usage_account_invoices": [],
      "usage_accounts": [],
      "usage_item_invoices": [],
      "usage_items": [],
      "void": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

License Key


A license key is created via web app import, remote request or auto generated by RevCent. A license key is issued when a product is purchased that has an attached license key profile. We highly recommend you read more about license key management at our Knowledge Base

License Key Retrieve


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

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

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

Request JSON Schema


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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "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
}

Request JSON

{
  "request": {
    "type": "metadata",
    "method": "insert",
    "item_type": "sale",
    "item_id": "pgm1q7yjKjF7qyAM7EXK",
    "cascade": false,
    "metadata": [
      {
        "name": "new_name",
        "value": "new value"
      }
    ]
  }
}

Response JSON

{
  "api_call_date": "2022-06-02T15:16:15+00:00",
  "api_call_id": "JNGoAdZ7v8iRooaArOOy",
  "api_call_processed": true,
  "api_call_unix": 1654182975,
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "georgew@whitehouse.com",
    "enabled": true,
    "first_name": "George",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "pres_0001",
    "last_name": "Washington",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "item_id": "pgm1q7yjKjF7qyAM7EXK",
  "item_type": "sale",
  "metadata": [
    {
      "name": "new_name",
      "value": "new value"
    }
  ],
  "request_method": "insert",
  "request_type": "metadata",
  "result": "Metadata inserted."
}

Note


You can create a note for an entity within RevCent that will simultaneously attach the note to the customer related to the entity. This allows you to view all notes for a customer and related entities.

Note Create


Create a note for a specific entity such as a customer, sale, shipping, etc. Indicate the entity using the item_type and item_id properties, the item_type being either sale, customer, shipping, etc., and item_id being the RevCent ID for the item. For example, if you want to leave a note for a sale, set item_type = "sale" and item_id="REVCENT_SALE_ID".

Accepted Item Types

customer
A customer within RevCent.
sale
A sale within RevCent.
product_sale
A product sale within RevCent.
shipping
A shipping within RevCent.
subscription
A subscription within RevCent.
subscription_renewal
A subscription renewal within RevCent.
chargeback
A chargeback within RevCent.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


item_type

The item type the note is to be created for. Example: sale, customer, shipping, etc.


item_id

The RevCent ID for the item the note is to be created for. If item_type = sale, then the RevCent sale ID.


text

The note text.



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


item_id

The RevCent ID for the item the note was created for.


item_type

The item type the note was created for.


note_id

The RevCent ID for the note created.


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": "note",
    "method": "create",
    "item_type": "sale",
    "item_id": "pgm1q7yjKjF7qyAM7EXK",
    "text": "Making a note for a sale with RevCent ID pgm1q7yjKjF7qyAM7EXK."
  }
}

Response JSON

{
  "api_call_id": "WmEZRkNmKRhmWBrkNP9B",
  "api_call_processed": true,
  "api_call_unix": 1638047347,
  "code": 1,
  "item_id": "pgm1q7yjKjF7qyAM7EXK",
  "item_type": "sale",
  "note_id": "4rAmyMargyuMaXrkQLyK",
  "request_method": "create",
  "request_type": "note",
  "result": "Note created."
}

Payments


RevCent supports multiple payment types including check, credit card, offline and PayPal. Depending on the payment type, different methods are supported.

Additional payment types will be added in the future including Amazon Pay, Apply Pay and Google Pay.

Check Direct


A check direct is considered a physical check, not ACH or electronic check. The physicality is what separates a check direct from electronic forms of check payments, along with the accounts receivable and mailing aspects. ACH and electronic check methods will be supported in the near future as a separate entity.

Check Direct Refund


To refund a check direct you instead refund the entity that the refund is associated with, i.e. sale, product_sale, tax, shipping, etc.

Check Direct Retrieve


Retrieve current information on a single check direct or multiple check directs.

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

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

Request JSON Schema


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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "GO51EXbbAPS6pP1Ov9kK",
      "notes": [],
      "offline_payments": [],
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "5r1MyL99VouMNRl9Pnkd",
        "d9ZolGRRwnu6lZb2Jo64",
        "WmPn2q99GzSKXWmbJjVd"
      ],
      "received": true,
      "sales": [
        "1rQAp8MM46uzN4Rw0Kgk"
      ],
      "salvage_transactions": [],
      "shipping": [
        "X8anGkNN5XfZK5mK06VX"
      ],
      "smtp_messages": [],
      "status": "Received",
      "subscription_renewals": [],
      "subscriptions": [
        "nbM1P5aa2VfNvVJvWjb1",
        "WmPn2q99GzSKRnQjZmkz"
      ],
      "tax": [
        "k6vn8JZZAmUv8G5z6klR"
      ],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop",
        "shop_url": "myshop.com"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1565832519
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Credit Card


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

Transaction


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

Transaction Create Refund


Refund a credit card transaction directly. This is not the recommended method if you wish to run detailed metrics reports. Use either Product Sale Refund, Shipping Refund, or Subscription Renewal Refund instead.

Request JSON Schema


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.


refunded_offsite

You have the option to refund a credit card transaction within RevCent, without refunding the transaction at the gateway level. If set to true, RevCent will mark all entities as having a refund, but will not contact the gateway to return the money to the customer. This is useful for reporting within RevCent when a transaction was refunded outside of RevCent, i.e. Rapid Dispute Resolution, mailed a check, etc. Default is false.



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.


refunded_offsite

Indicates whether the transaction was refunded using the refunded_offsite = true flag.


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",
    "refunded_offsite": false,
    "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"
  ],
  "refunded_offsite": false,
  "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. You can use the RevCent ID or gateway transaction id as the id value when retrieving a single transaction.

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

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

Request JSON Schema


request

The main request object.


type

The request type.


method

The request method.


id

The RevCent ID of the transaction or the gateway transaction ID of the transaction. Required if multiple property equals false and email property 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.


expiry_date


expiry_month


expiry_year



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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "customer_card": {
        "type": "visa",
        "id": "1rQA58w6XXcMNRApYLPn",
        "last_4": "4242",
        "created_date_unix": 1565814899,
        "updated_date_unix": 1565814901,
        "expiry_date": "11/2023",
        "expiry_month": "11",
        "expiry_year": "2023"
      },
      "declined": false,
      "details_last_updated_unix": null,
      "details_response": "",
      "discounts": [],
      "error": false,
      "gateway_id": "NkAMJOzpB5iEAOrdloV0",
      "gateway_name": "Braintree",
      "has_salvage": true,
      "held": false,
      "id": "ALRjyqRE27fjMonyKLny",
      "is_payment_profile": false,
      "is_refund": false,
      "is_salvage": false,
      "is_subscription": false,
      "is_subscription_renewal": false,
      "live_mode": false,
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "payment_profile": {
        "id": "ajyXm76OpjSL4p5oO2By",
        "name": "AuthBrainStripe",
        "results": null
      },
      "paypal_transactions": [],
      "pending_refunds": [],
      "product_sales": [
        "9rdEMadyZ7uYgnbKWwX5",
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "result": "Approved",
      "sale_initial": true,
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "settled": false,
      "shipping": [
        "gYamRbaGZphKn8zJVow1"
      ],
      "smtp_messages": [],
      "status": "Fully Captured",
      "subscription_profile": null,
      "subscription_renewals": [],
      "subscriptions": [
        "o1jGw5jY2RILLl4dBMwa"
      ],
      "tax": [
        "ALRjyqRE27fjjpmRzBRd"
      ],
      "third_party_shop": null,
      "trials": [],
      "updated_date_unix": 1565814901,
      "void": false
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Offline Payment


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

Offline Payment Refund


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

Offline Payment Retrieve


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

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

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

Request JSON Schema


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_integration

Will contain details if the offline payment is related to a third party integration, such as Sezzle, Afterpay, etc.


id

The ID of the user third party integration.


name

The name of the user third party integration.


third_party

Will contain details of the actual third party responsible for the offline payment.


id

The ID of the third party.


name

The name of the third party.




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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "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_integration": {
        "id": "Q4l9bmQvLVCW72AmEZEg",
        "name": "My Sezzle Integration",
        "third_party": {
          "id": "6rlY0B40mVfzVXmL1yyP",
          "name": "Sezzle"
        }
      },
      "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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "id": "k6omOdKbrRTZnpP6d7Ng",
      "metadata": [
        {
          "name": "adwords_click",
          "value": "Cjat0KwhCQjdTq..."
        }
      ],
      "notes": [],
      "offline_payments": [],
      "paypal_account": {
        "id": "mJVWkmzVz0i42j0GEVK4",
        "name": "My PayPal Account",
        "paypal_account_email": "myemail@gmail.com"
      },
      "paypal_customer_id": null,
      "paypal_transaction_amount": 0.01,
      "paypal_transaction_date": "2019-07-02T15:46:58+00:00",
      "paypal_transaction_date_unix": 1562082418,
      "paypal_transaction_id": "XXXXXXXXXXXX",
      "pending_refunds": [
        "vEn8K4MKavIRAyw0NVbR"
      ],
      "product_sales": [
        "7rgo91jKVmtYk8NBnnNm"
      ],
      "sales": [
        "MWymZv5d6bSpQLl1ARMm"
      ],
      "salvage_transactions": [],
      "shipping": [
        "qZ4vKalGg5tv298VvO8V"
      ],
      "smtp_messages": [],
      "subscription_renewals": [],
      "subscriptions": [],
      "tax": [],
      "third_party_shop": {
        "id": "Q48aAbVv21fJRvNKWrvP",
        "name": "My Shop"
      },
      "transactions": [],
      "trials": [],
      "updated_date_unix": 1562082510
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Pending Refund


All credit card transactions, paypal transactions, checks and offline payments create a pending refund when refunded. RevCent automatically processes a pending refund once a credit card transaction has settled with the merchant gateway.

Pending Refund Process


Manually process a pending refund. This is not recommended, as RevCent will process pending refunds automatically. The response JSON is useful for notification events sent to endpoints.

Request JSON Schema


request

The main request object


type

The type of request being made.


method

The method for the request type.


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


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.



gateway_raw_response

The raw response of the gateway request as a result of the refund if original payment was via Credit Card.


origin_transaction_id

The ID of the transaction being refunded if original payment was via Credit Card.


paypal_response

The raw response of the PayPal request as a result of the refund if original payment was via PayPal.


paypal_transaction_id

The ID of the PayPal transaction the refunded if original payment was via PayPal.


pending_refund_id

The ID of the pending refund being 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.


transaction_id

The ID of the transaction created as a result of the refund if original payment was via Credit Card.


Request JSON

{
  "request": {
    "type": "pending_refund",
    "method": "process",
    "id": "8rRNgQd0NGUv6Ggn7og0"
  }
}

Response JSON

{
  "amount": 9.35,
  "api_call_id": "wLRrX7jbJrI8R89jg8Bq",
  "api_call_unix": 1631302671,
  "campaign_id": "mJ1zZoOobEuP8pnWKXd1",
  "campaign_name": "Adwords Campaign",
  "code": 1,
  "customer": {
    "address_line_1": "1600 Pennsylvania Ave",
    "address_line_2": "",
    "blocked": false,
    "city": "Washington",
    "company": "",
    "country": "USA",
    "email": "georgew@whitehouse.com",
    "enabled": true,
    "first_name": "George",
    "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
    "geocode_success": true,
    "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
    "id": "4r158EzJmmcVM69dNLkg",
    "internal_id": "pres_0001",
    "last_name": "Washington",
    "lat": "38.8976633",
    "lon": "-77.0365739",
    "metadata": [],
    "phone": "1234567890",
    "state": "DC",
    "state_long": "DC",
    "zip": "20500"
  },
  "customer_id": "4r158EzJmmcVM69dNLkg",
  "gateway_raw_response": "",
  "origin_transaction_id": "2rRG9OBOjmf7pO8LV6Mq",
  "pending_refund_id": "8rRNgQd0NGUv6Ggn7og0",
  "request_method": "process",
  "request_type": "pending_refund",
  "result": "Pending refund processed successfully. Origin transaction refunded.",
  "transaction_id": "BvEPbYWrNBH9R9W1B95W"
}

Pending Refund Retrieve


Retrieve current information on a single pending refund or multiple pending refunds.

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

Request JSON Schema


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": "georgew@whitehouse.com",
        "enabled": true,
        "first_name": "George",
        "full_address": "1600 Pennsylvania Ave NW, Washington, DC 20500, USA",
        "geocode_success": true,
        "google_place_id": "ChIJGVtI4by3t4kRr51d_Qm_x58",
        "id": "4r158EzJmmcVM69dNLkg",
        "internal_id": "pres_0001",
        "last_name": "Washington",
        "lat": "38.8976633",
        "lon": "-77.0365739",
        "metadata": [],
        "phone": "1234567890",
        "state": "DC",
        "state_long": "DC",
        "zip": "20500"
      },
      "discounts": [],
      "gateway_id": "NkAMJOzpB5iEAOrdloV0",
      "gateway_name": "Braintree",
      "id": "MW5LoAVymnHww96XllEr",
      "is_check_direct": false,
      "is_offline_payment": false,
      "live_mode": false,
      "notes": [],
      "offline_payments": [],
      "payment_type": {
        "id": "KnQ0KlNE6kf5mobyV0pN",
        "name": "Credit Card"
      },
      "paypal_transactions": [],
      "processed": false,
      "product_sales": [
        "LY5yop5nk7hbPzpBn8aY"
      ],
      "refund_transaction_id": "ALRjyqRE27fjMonyKLny",
      "sales": [
        "k6vnbJom00Ug89mpRj78"
      ],
      "salvage_transactions": [
        "VPm9Mqmgw7UJJLldojJY"
      ],
      "shipping": [],
      "smtp_messages": [],
      "status": "Processing",
      "subscription_renewals": [],
      "subscriptions": [],
      "success_transaction_id": null,
      "tax": [],
      "trials": [],
      "updated_date_unix": 1565814903
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Product


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

Product Create


Create a product via the product create method.

Important: RevCent will always create a new product. RevCent will not match sku, internal_id or other identifier to check for existing products in order to prevent duplicates. If you wish to modify a product that already exists in RevCent, use the Product > Edit method below.

Request JSON Schema


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_bundle_product

Whether the product is a bundle consisting of individual bundled products. Read More


bundle_settings

The bundle settings, specifying the bundled products and unbundle method. Bundled products total must equal product price. Read More


products

An array of individual products within the main bundle product.


id

The RevCent ID of the bundled product.


quantity

The quantity of the bundled product.


price

The price of the bundled product.



unbundle_method

The unbundle method. Read More

  • unbundle_at_fulfillment: When a sale request is received, the bundle product is not unbundled yet, and is instead processed as a single product.
  • unbundle_at_sale: When a sale request is received, the bundle product is unbundled and replaced by each product contained in the bundle.



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


url

Product URL.


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": {
      "name": "New Product",
      "description": "New product description.",
      "enabled": true,
      "sku": "new_product_sku",
      "url": "https://mystore.com/new-product-1",
      "internal_id": "new_product_internal_id",
      "price": 199.99,
      "price_trial": 199.99,
      "price_subscription": 199.99,
      "trial_shipping_setting": "both_trial_expiration_creation",
      "trial_days": 5,
      "is_shippable": true,
      "shipping_attributes": {
        "rate": "",
        "weight": "",
        "length": "",
        "width": "",
        "height": "",
        "fulfillment_account": "j0o25b2YJRFdJb8EEXE1"
      },
      "additional_id": [
        {
          "name": "another_id",
          "value": "id_123"
        }
      ],
      "subscription_profile": "d9NXVR62vGfYMw6VEZOl",
      "product_group": [
        "EMYlAaXA1yfkWWora9rG"
      ],
      "third_party_shop": "2rgA7J9AN8CMEpaQGPqN",
      "is_bundle_product": true,
      "bundle_settings": {
        "products": [
          {
            "id": "k6EXjKzd7PHOpgvdYjXG",
            "quantity": 1,
            "price": 100
          },
          {
            "id": "6r8O5MLbw2t6n4v1lGqK",
            "quantity": 1,
            "price": 99.99
          }
        ],
        "unbundle_method": "unbundle_at_sale"
      }
    }
  }
}

Response JSON

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

Product Edit


Edit an existing product in RevCent by providing the RevCent ID of the product via the product_id property. The product object is the same as in the Product > Create request.

Note: Only properties included in the edit request will be modified for the product within RevCent. For instance, if you only wanted to modify the price, simply include only the price property in the edit request product object.

Request JSON Schema


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_bundle_product

Whether the product is a bundle consisting of individual bundled products. Read More


bundle_settings

The bundle settings, specifying the bundled products and unbundle method. Bundled products total must equal product price. Read More


products

An array of individual products within the main bundle product.


id

The RevCent ID of the bundled product.


quantity

The quantity of the bundled product.


price

The price of the bundled product.



unbundle_method

The unbundle method. Read More

  • unbundle_at_fulfillment: When a sale request is received, the bundle product is not unbundled yet, and is instead processed as a single product.
  • unbundle_at_sale: When a sale request is received, the bundle product is unbundled and replaced by each product contained in the bundle.



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 is 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 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": "My Awesome Product",
      "description": "My awesome product description",
      "url": "https://mystore.com/my-awesome-product",
      "price": 199.99,
      "price_trial": 199.99,
      "price_subscription": 199.99,
      "trial_shipping_setting": "both_trial_expiration_creation",
      "trial_days": 3,
      "enabled": true,
      "is_shippable": true,
      "is_bundle_product": true,
      "bundle_settings": {
        "products": [
          {
            "id": "k6EXjKzd7PHOpgvdYjXG",
            "quantity": 1,
            "price": 100
          },
          {
            "id": "6r8O5MLbw2t6n4v1lGqK",
            "quantity": 1,
            "price": 99.99
          }
        ],
        "unbundle_method": "unbundle_at_sale"
      }
    }
  }
}

Response JSON

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

Product Enable


Enable a product which has been previously disabled.

Request JSON Schema


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


Disable a product, not allowing it to be included in a sale.

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


Delete a product from RevCent. We highly recommend you do not use this method if the product has existing sales, subscriptions, etc. associate with it.

Request JSON Schema


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.


bundle_settings

The bundle settings, specifying the bundled products and unbundle method.


products

An array of individual products within the main bundle product.


id

The RevCent ID of the bundled product.


quantity

The quantity of the bundled product.


price

The price of the bundled product.



unbundle_method

The unbundle method.



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_bundle_product

Whether the product is a bundle consisting of individual bundled products.


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


url

Product URL.


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": "",
      "bundle_settings": {
        "products": [
          {
            "id": "k6EXjKzd7PHOpgvdYjXG",
            "name": "USB HDD",
            "quantity": 1,
            "price": 100
          },
          {
            "id": "6r8O5MLbw2t6n4v1lGqK",
            "name": "AV 2017",
            "quantity": 1,
            "price": 99.99
          }
        ],
        "unbundle_method": "unbundle_at_sale"
      },
      "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_bundle_product": true,
      "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": 199.99,
      "price_sale": null,
      "price_subscription": 199.99,
      "price_trial": 199.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": "",
      "url": "https://mystore.com/new-product-1",
      "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.