DeepShield Fraud Protection AI Quick Start Guide


Contact us directly at contact@tradespotlabs.com to get access to find out how you can get started with DeepShield Fraud Protection AI.


DeepShield Wallet Quick Start Guide


Introduction

Welcome to DeepShield! DeepShield provides a sandboxed cloud-based wallet and fraud protection AI that can be accessed with simple REST APIs and TEST KEYS. Continue on to get started or simply dive into the API Reference.

Before You Start

If you haven’t signed up yet, then please first Sign up for DeepShield. Within 24 hours, we will contact you with your access credentials.

Once you sign up and follow the steps in this guide, you will have a fully functional wallet in the sandbox environment.

Access Credentials

Your credentials allow you to access the REST APIs. Both the application_id and secret must be sent with all API requests. Your access credentials should not be shared or hard-coded directly into an app or site.

application_id - Identifies you with DeepShield

secret - Authenticates you with DeepShield

Plaid public key - d65368c599356966ca6168e15bd3e8

Step 1 : Integrate with Plaid

We have partnered with Plaid to securely link customers with their bank accounts. You can find out more about Plaid here. Before proceeding, please check out the Plaid Quickstart guide and copy the appropriate drop-in HTML snippet for simple integration or custom integration.

Use our public key (d65368c599356966ca6168e15bd3e8) during Plaid Link integration to link bank accounts with customers created in DeepShield.

Step 2 : Create a Customer

If you already have customers in your existing app or website, then you can create customers in DeepShield ahead of time and associate bank accounts using Plaid when they visit.

After customers enter their bank credentials using Plaid Link, the public_token and account_id will be generated by Plaid. The public_token and account_id should then be sent to DeepShield through your servers.

Any customers that you create will not be appear in production.

Example Request

curl -X POST https://sandbox.deepshield.co/api/v1/buyer \
-d application_id=4c6dd5dee0e6bf6abf9ef06d \
-d secret=07c9af3653c3defbbdc2299d981cf1 \
-d request_type=create_buyer_profile \
-d email="jane.doe@gmail.com" \
-d first_name=Jane \
-d last_name=Doe

Example Response

{
 "id": 32,
 "merchant_profile_id": 4,
 "email": "jane.doe@gmail.com",
 "first_name": "Jane",
 "last_name": "Doe",
 "unique_id": "@JaneDoe",
 "created_at": "2016-10-14T15:55:03.228Z",
 "updated_at": "2016-10-14T15:55:03.228Z"
}

Remember that the access credentials should not be shared or hard-coded directly into an app or site.

Step 3 - Fund a Customer Wallet

Send the customer id (buyer_profile_id) and the amount to DeepShield using your servers.

The specified amount will then be transferred from the previously linked customer bank account into the wallet.

Any funds added to customer wallets will not appear in production.

Example Request

curl -X POST https://sandbox.deepshield.co/api/v1/pay \
-d request_type=add_funds_to_wallet \
-d application_id=4c6dd5dee0e6bf6abf9ef06d \
-d secret=07c9af3653c3defbbdc2299d981cf1 \
-d buyer_profile_id=32 \
-d amount="10.00"

Example Response

{
 "id": 32,
 "merchant_profile_id": 4,
 "email": "jane.doe@gmail.com",
 "first_name": "Jane",
 "last_name": "Doe",
 "unique_id": "@JaneDoe",
 "created_at": "2016-10-14T15:55:03.228Z",
 "updated_at": "2016-10-14T15:55:03.228Z",
 "wallet": {
     "id": 47,
     "buyer_profile_id": 32,
     "merchant_profile_id": 4,
     "amount_available": "0.00",
     "amount_pending": "10.00",
     "negative_balance": false,
     "pending_available_date": "2016-10-19T16:00:16.367Z",
     "transaction_type": "credit",
     "suspended": false,
     "bank_account_connected": true,
     "created_at": "2016-10-14T15:55:03.232Z",
     "updated_at": "2016-10-14T16:00:17.166Z"
 }
}

Step 4 - Make Payment

Send the buyer_profile_id and the total_price to DeepShield using your servers.

The specified amount will then be transferred from the customer’s wallet to your wallet.

Any payments made by customers will not appear in production.

Example Request

curl -X POST https://sandbox.deepshield.co/api/v1/pay \
-d request_type=pay \
-d application_id=4c6dd5dee0e6bf6abf9ef06d \
-d secret=07c9af3653c3defbbdc2299d981cf1 \
-d buyer_profile_id=32 \
-d total_price="10.00"

Example Response

{
 "id": 494,
 "buyer_profile_id": 32,
 "merchant_profile_id": 4,
 "total_price": "10.00",
 "currency": "USD",
 "payment_source": "cus_9NIcr60BJk0Q2t",
 "status": "paid",
 "qrcode_id": "cfcX2NVDGnXc_xx8oO53Mg",
 "order_id": 494,
 "sales_tax": "0.00",
 "gratuity": "0.00",
 "convenience_fee": "0.00",
 "created_at": "2016-10-14T16:21:20.951Z",
 "updated_at": "2016-10-14T16:21:20.951Z",
 "buyer_profile": {
     "id": 32,
     "merchant_profile_id": 4,
     "email": "jane.doe@gmail.com",
     "first_name": "Jane",
     "last_name": "Doe",
     "unique_id": "@JaneDoe",
     "created_at": "2016-10-14T15:55:03.228Z",
     "updated_at": "2016-10-14T15:55:03.228Z"
 }
}

Step 5 - Deploy to Production

When it is time to deploy to production, please contact support@tradespotlabs.com. Within 24 hours, we will send your production access credentials.

Using the production access credentials, update your application or website to point to the DeepShield production servers.

Update Plaid Link by changing the environment variable (data-env for simple integration, env for custom integration) to connect to the Plaid production environment.

You are ready to go!


Support and Questions

Review the API Reference for more information on how to communicate with DeepShield through the REST APIs.

Contact support@tradespotlabs.com with any questions or if you are experiencing issues and we will get back to you as soon as we can.