Introduction

API Reference

API Endpoints & Authentication

All requests to the Dispute Response API are sent via the HTTP POST method to one of our API endpoint URLs.

HTTP Request Method: POST

Production API Endpoint For CC:
https://crm.dispute-response.com/RestApi/doTransaction

All calls to the Dispute Response API require merchant authentication.

Hosted Checkout

Using only general HTML, Hosted checkout is the easiest way to add Credit Card Processing to a new or existing e-Commerce website.

Features

Hosted Checkout is designed specifically for merchants who typically have products. The ease of deployment, which is literally allows semi and non-technical merchants to add purchase links or buttons to their products online


Hosted Checkout is perfect for merchants:

  • Hosted Checkout only uses HTML forms; it's easy to integrate
  • Hosted Checkout allows the merchant to customize the checkout page's appearance, retaining the look and feel of their website.
  • Full Back Office access allowing merchants to manually key sales and voids, as well as view reporting via Dispute Response.

Transaction Flow

Get MID List

Before executing any transaction with Dispute Response, you must first retrieve the MID (Merchant ID) list from the server.
Transactions will not be processed unless a valid MID is provided.

Note:A valid API Key is required for all requests.

Production API Endpoint For MID:
https://crm.dispute-response.com/RestApi/mid_list

Field Name Type Required Example Description
apikey * string Yes ABXC5405046SAD Your API authentication key 


curl --location 'https://crm.dispute-response.com/RestApi/mid_list' \

--header 'Cookie: ci_session=2f47188816a406b7aeff0ee97f60925656a894dd' \

--form 'apikey=ABXC5405046SAD'
Get Country List

Before executing any transaction with Dispute response, you must retrieve the Country List from the server.

Production API Endpoint
https://crm.dispute-response.com/RestApi/country



curl --location --request POST \

'https://crm.dispute-response.com/RestApi/country'
Get State List

before exesuting any transaction with Dispute Response, you must retrive the State List from the server.
Transaction will not be processed unless a valid state is provided.

Note: A valid Country ID is requred for this request.

Production API Endpoint
https://crm.dispute-response.com/RestApi/state

Field Name Type Required Example Description
country_id * string Yes 201 Unique identifier of the selected country 


curl --location 'https://crm.dispute-response.com/RestApi/state' \

--header 'Cookie: ci_session=aa127a31522523f6b54cfd66c1b81e884e35f105' \

--form 'country_id=123'
Transaction Api

Prospects create and submit transactional information to Dispute Response System.

Name Example type Description
bill_fname Nicholas String First Name of Customer
bill_lname Townsend String Last Name of Customer
bill_email nicholasjtownsend@dayrep.com String Valid Email Address (Email Receipt and Order Confirmation is sent for this Email)
bill_mobile +1(504)552-4556 String Valid Phone
bill_add_1 1184 Lodgeville Road String Address
bill_add_2 Conaway Street String Address
bill_city Richfield String City
bill_state MN Char State (ISO-3166-2)
bill_zip 55423 Char Valid Zipcode
bill_country US Char Country (ISO-3166-2)
is_ship_same 1 (If Shipping address is same user 1 else 0) int If Shipping address is same user 1 else 0
ship_fname Nicholas String First Name of Customer
ship_lname Townsend String Last Name of Customer
ship_email nicholasjtownsend@dayrep.com String Valid Email Address (Email Receipt and Order Confirmation is sent for this Email)
ship_mobile +1(504)552-4556 String Valid Phone
ship_add_1 1184 Lodgeville Road String Address
ship_add_2 Conaway Street String Address
ship_city Richfield String City
ship_state MN Char State (ISO-3166-2)
ship_zip 55423 Char Valid Zipcode
ship_country US Char Country (ISO-3166-2)
apikey ABXC5405046SAD String API KEY
product_name Wireless Bluetooth Headphones String Product Name
amount 29.95 String Total Amount
product_id 201 String If you are fixed product merchant you have to pass product ID
card_number 4242424242424242 String Credit card number
exp_month 0822 char Credit card expiration (ie. 0711 = 7/2011)
exp_year 2021 String Credit card expiration Year
cvc 123 String Card security code
description High-fidelity over-ear headphones with 20 hours battery life String description
ip_address 12.15.15.10 String Current IP Address to Charge Customer
Website https://www.yourdomain.com String Website to Charge Product.
is_recurring 1 int Example: 0 = Not recurring, 1 = Recurring
recurring_days 30 String If you want to add recurring please pass Recurring days 


$postdata = array(

    'apikey' => 'ABXC5405046SAD',

    'bill_mobile' => '+1(504)552-4556',

    'amount' => '29.95',

    'bill_fname' => 'Nicholas',

    'bill_lname' => 'Townsend',

    'bill_email' => 'nicholasjtownsend@dayrep.com',

    'bill_add_1' => '1184 Lodgeville Road',

    'bill_add_2' => 'Conaway Street',

    'bill_country' => 'US',

    'bill_state' => 'MN',

    'bill_city' => 'Richfield',

    'bill_zip' => '55423',

    'card_number' => '4242424242424242',

    'exp_month' => '0822',

    'exp_year' => '2021',

    'cvc' => '123',

    'description' => 'High-fidelity over-ear headphones with 20 hours battery life',

    'is_ship_same' => '1',

    'product_name' => 'Wireless Bluetooth Headphones',

    'productqty' => '1',

    'productprice' => '	29.95',

    'ip_address' => '12.15.15.10',

    'is_recurring' => '1',

    'recurring_days' => '30',

    'currency' => 'USD',

    'current_url_dynamic' => https://www.yourdomain.com',

    'referrerurl' => 'https://www.yourdomain.com'

);
Hosted Checkout Examples

The demos on this page are slightly enhanced beyond what's outlined in their respective Detail & Code areas. Mainly, the code examples are a great foundation to build and customize upon.

The Javascript in this example is used to:

image

In this example file are included getcountry.php, getstate.php and getproduct.php,api.php all this information are coming via our api. Please mention your api credentials in this variable.

$api = 'YOUR API KEY HERE';



$postdata = array(

    'product_name' => 'Wireless Bluetooth Headphones',

    'total_amount' => '29.95',

    'card_number' => '4242424242424242',

    'exp_month' => '0822',

    'exp_year' => '2021',

    'cvv' => '123',

    'desp' => 'High-fidelity over-ear headphones with 20 hours battery life',

    'submit' => '',

    'mid_id' => '164',

    'bill_fname' => 'Nicholas',

    'bill_lname' => 'Townsend',

    'bill_mobile' => '+1(504)552-4556',

    'bill_email' => 'nicholasjtownsend@dayrep.com',

    'bill_add_1' => '1184 Lodgeville Road',

    'bill_add_2' => 'Conaway Street',

    'bill_country' => 'US',

    'bill_state' => 'MN',

    'bill_city' => 'Richfield',

    'bill_zip' => '55423',

    'is_ship_change' => '1',

    'ship_fname' => 'Nicholas',

    'ship_lname' => 'Townsend',

    'ship_mobile' => '+1(504)552-4556',

    'ship_email' => 'nicholasjtownsend@dayrep.com',

    'ship_add_1' => '1184 Lodgeville Road',

    'ship_add_2' => 'Conaway Street',

    'ship_country' => 'US',

    'ship_state' => 'MN',

    'ship_city' => 'Richfield',

    'ship_zip' => '55423',

    'api_key' => 'ABXC5405046SAD',

    'ip_address' => '12.15.15.10'

);
Woo Plugin Installation
Go to WordPress Admin > Plugins > Add New.
  1. Log in to your WordPress admin panel (usually at www.yoursite.com/wp-admin).
  2. Navigate to the left sidebar and click on the Plugins menu.
  3. Select Add New from the dropdown menu. The plugin installation page will appear.
  4. You can search for a specific plugin or browse through the available ones.
image
Activate the Plugin
  1. If the plugin is listed, click the Install Now button next to the plugin name.
  2. Once installed, the button will change to Activate. Click Activate to enable the plugin on your site.
  3. If uploading a plugin manually, click the Upload Plugin button, choose the .zip file, and click Install Now, then Activate.
image
Upload Plugin File (If Applicable)
  1. On the Add Plugins page, click on Upload Plugin.
  2. Click Choose File, select the .zip file for the plugin, and click Install Now.
  3. Click Activate Plugin after installation to enable it on your WordPress site.
image
Configure Plugin Settings with API Credentials
  1. After activation, most plugins will add a new menu item to your WordPress dashboard.
  2. Find the plugin's settings page, which is typically under the Settings menu or as a separate section labeled with the plugin name.
  3. Look for fields like API Key, API Secret, or Merchant ID to input your credentials from the external service you're connecting to.
  4. Enter the credentials and any additional configuration settings required by the plugin (currency, payment options, etc.).
  5. Click Save Changes.
image