|
Step |
Task |
Notes/Resources |
|
1 |
Figure out which REST APIs to use. |
If you accessed reports and other data (like the Single Transaction Query) in the old platform, you will need to switch to our REST APIs. See All Reports and What will Happen to Them to look up your report and determine which REST API you need to use to programmatically download that report. |
|
2 |
Learn about the REST APIs in the Developer Center. |
Review API Specifications and API Developer Guides for the REST APIs that you will use. You can also try out the API using the live console. |
|
3 |
Create an API Key. |
Use the Key Management module in the Business Center to create and API key. See the Getting Started guide on the Developer Center for more information and instructions. Note You can use sample code from our Github repository to create an authentication signature. |
|
4 |
Build your client application. |
When you are ready to build your client application, you can use the sample code shown in the live console, or access our SDKs. |
The table below lists the functions of the old servlets and the REST APIs that will replace them.
|
Servlet Name |
Function |
REST API |
|
Download Servlet |
Downloads report or other files. |
Reporting API or Secure File Share API |
|
Acquiring Servlet |
Downloads reports. |
Reporting API |
|
Query Servlet |
Retrieve Transaction/Payment Status. |
Transaction Detail API |
|
Query Servlet |
Retrieve a single transaction (search by request ID). |
Transaction Detail API |
|
Query Servlet |
Search for transactions by merchant reference number. |
Transaction Search API |
|
Query Servlet |
Notification of Change (on demand). |
Reporting API |
|
Query Servlet |
Conversion Detail Report (on demand). |
Reporting API |
|
Query Servlet |
Order Detail Report (on demand) |
Reporting API |
|
Query Servlet |
User Listing Servlet |
User Management API |
|
Query Servlet |
Response File Write (Batch Upload status) |
Batch Status API |
|
|
For a mapping of legacy reports to new reports, see Reports Reference. |
These are the new REST APIs:
|
API Name |
Purpose |
|
Transaction Detail API |
Retrieves a single transaction based on Request ID. |
|
Search API |
Retrieves a set of transactions based on several available query parameters. |
|
Reporting API |
Downloads and manages downloadable detail reports. |
|
Secure File Share API |
Downloads third party files, reports from the old Business Center, Batch Upload Reply, and Account Updater Reply files. |
|
User Management API |
Retrieves a list of users. |
|
Batch Status API |
Retrieves the status of a batch upload. |
For information on using REST APIs, see CyberSource REST API Getting Started Guide. For full documentation on the REST APIs, see our Developer Center.