RaaS API 2.0 Overview and Best Practices
-
Upload
tango-card -
Category
Technology
-
view
428 -
download
2
Transcript of RaaS API 2.0 Overview and Best Practices
RaaS API Overview and Best Practices
ToCIntro →- What is RaaS? →- Why e-gift cards? →- Why the RaaS API? →
API Methods →- 1 to 1 Account Structure →- 1 to Many Account Structure →- Customer Methods →- Account Methods →- Fund Methods →- Catalog Methods →- Order Methods →
Best Practices →- Catalog Setup →- Reward Checkout →- Reward Delivery – Standard Email →- Reward Delivery – In app →- Reward Delivery – Customer Email →- Funding →- Reporting →- Handling Responses →- Behind the Scenes Best Practices →
Getting Started & Brand Approvals →
Intro
What is RaaS?
Rewards as a Service includes:
- Reward Delivery Platform (RDP)- Results Oriented Reward Catalog- Expert Program Support
Use the RaaS API to create a modern and engaging reward program in your app or platform.
Earns Reward
Enjoys Reward
Engages with
Program
Recipient Reward Cycle
Why e-gift cards? They’re the best.
1) Branded currency. They give the flexibility of currency with the power and excitement of a beloved brand.
2) Impact - The power of brand affinity. When someone receives a gift card they are excited, they remember how they spend it, and they tell people about it!
3) Relieve headaches. Instant delivery, tracking, and no need for inventory make e-gift cards operational gold.
Why RaaS API? Boost your program results.
Automate the best incentive, e-gift cards, with our trusted delivery methods, and rely on our expert customer support teams: Your
Program
Your
Recipient
APIMethods
[see Test Console for details]
RaaS API Platform Structure – 1 to 1One account for your program:
RaaS API Platform Structure – 1 to ManyMultiple customers with separate accounts:
Customer MethodsWith the Customer Methods of the RaaS API you can:
- Create new Customers on your Platform- Create Accounts for Customers on your Platform- Get a list of all Customers on your Platform- Get details for a specific customer on your Platform- Get a list of all Accounts for a Customer on your
Platform
Account MethodsWith the Account Methods of the RaaS API you can:
- Get a list of Accounts on your Platform- Get details for a specific Account on your Platform
Fund MethodsWith the Fund Methods of the RaaS API you can:
- Register a new credit card* on an Account- Unregister a credit card from an Account- Get a list of registered credit cards on your Platform- Get details for a specific credit card on your
Platform- Create a deposit from a registered credit card
*Credit Cards come with a 3.5% fee – discuss with your BD/CSM team
Catalog MethodWith the Catalog Method of the RaaS API you can:
- Get all of the reward items in your Platform's catalog
Reward items contain:- Brand Name, Images, Descriptions, and Disclaimers- Available denominations- Countries and Currency- Item ID (UTID) for ordering
Order MethodsWith the Order Methods of the RaaS API you can:
- Place an Order from an Account- Resend an Order previously placed from an Account- Get a list of Orders placed on your Platform- Get details for a specific Order on your Platform
Best Practices
Best Practices for Catalog SetupAvailable Balance
Reward category options
Crisp, current brand images
Progress to earning rewards
Best Practices for Reward Checkout (1/3)
Display:- Brand name- Image- Description- Available denoms- Disclaimer
Employ cart functionality if enabling multiple reward redemptions in one transaction
Best Practices for Reward Checkout (2/3)
Provide a clear order review step. Include:- Card(s) chosen- Total value to be redeemed- Name of intended recipient- Email of intended recipient- Acknowledgment of next steps
Best Practices for Reward Checkout (3/3)
Provide a clear order confirmation step. Include:- Returned Reference Order #- Clear next steps- If applicable: contact info for Tango Card Customer Service
Best Practices for Standard Reward DeliveryIn most cases best practice will be to have Tango Card deliver the reward.
RDP delivers rewards on a branded email template as soon as an Order call is placed.
Best Practices for In App Reward Delivery – Details (1/2)
Reward Image, name, and amount
Reward number or URL
Links and instructions to spend reward
Contact info for assistanceProper brand disclaimers
Best Practices for In App Reward Delivery – History (2/2)
Total Redeemed
Reward image and amountReward ID, Date and link to details
General disclaimers
Best Practices for Reward Delivery – Customer Emails
Brand the template to maintain user experience
Reward image, amount and number
Links and instructions to spend reward
Contact info for assistanceProper brand disclaimers
From: Your BrandSubject: Your [reward brand] card from [your brand] has arrived
Notes on Funding with Credit Card (1/3)Credit Card Funding costs a 3.5% convenience fee.
Best Practice is ACH and we have simple methods outside of the API for adding funds.
[Link to/share funding document]
Best Practices for Fund Method – Register Card (2/3)
Include:- Language of what to expect- Specific Account selected- 24 hour registration notice
Best Practices for Funding – Fund Account (3/3)
Include:- Current balance- Specific Account selected- List of available credit cards
Best Practices for Reporting - Simple
Include:- Date select- Choose or give permission for Platform, Customer, Account level reporting- Spreadsheet download
Handling RaaS API Response Status Codes
Response Handling recommendations:
2xx - Successful3xx - Log response, report To Tango Card4xx errors - Log response, fix the request and manually retry5xx errors - Log response, implement an automated retry mechanism that is capped at 5 requests.Note that error class responses will also include descriptive text further explaining the nature of the error.
Refer to our documentation for additional info on response.
Protect your platform keys – NEVER transmit your platform keys via email or any other unsecured method. Design your system to allow for routine key changes. Change your keys immediately when employees who had access to the keys leave. If you suspect any suspicious activity on your platform, change your keys.
Incremental retry - Network vagaries, infrastructure and supplier factors mean occasional network errors are inevitable and must be planned for. For this reason, we strongly recommend that you build an “exponential back off” or similar retry algorithm in which the timeout value for retry increases after each unsuccessful attempt. Exponential retries are well-documented elsewhere and beyond the scope of this document. FIND A LINK
Balance Alerts - The RaaS API allows you to check an account balance at any time with the Get ACCOUNT resource, but it does not have low balance alerts at this time. We recommend building in a balance check and alert system if you anticipate the need to re-fund accounts on a regular basis.
Parsing – Please take note of our Versioning and build your implementation accordingly. When possible, we will add additional functionality to the current version of the API in order to better serve existing customers.
Recommended Behind the Scenes Best Practices
Getting Started with the RaaS APIComponents to Launching with the RaaS API:
- Meet and Discuss Integration Plan (Both)- Receive Sandbox Credentials (Tango Card sends)- API integration (You complete)- *Brand Approval/UI review/Email Templates Creation (Tango Card completes)- Sandbox Testing (Both)- Receive Production Credentials (Tango Card sends)- Production Testing (Both)- Customer support planning – who is first tier, proper contact info (Discuss)- Finance planning – account funding/invoicing/reporting – funding in app/platform?
(Discuss)
*Brand Approval is very important:- Our brand partners are very protective of their brands (Amazon.com, iTunes, The
Home Depot, etc.)- There are certain brands that will need extra approval of:
- Your use case- Your UI/UX
- Your CSM will facilitate all approvals.