Skip to navigation

@ Work APIs

An overview of how @ Work APIs enable system-to-system communication between a Client’s Enterprise Resource Platform and American Express, using a suite of APIs, to fully automate common American Express @ Work functions.

American Express publishes an overview for this product but no API specification, so there is no endpoint reference to show.

The @ Work B2B APIs provide a suite of REST APIs that enables system-to-system communication between a corporate Client’s Enterprise Resource Platform (ERP) and American Express to automate common American Express @ Work functions. The communication between these systems, automates the changes made in the Client’s ERP, which triggers changes to the American Express Commercial Card program. The @ Work B2B APIs improve efficiency and security through automation, delivering increased program control, faster response time, and cost savings to a Client’s corporate Card program. Today, the available @ Work B2B APIs enable Clients to execute Cancellation requests as well as Apply for Card requests through their in-house ERP Systems. Apply for Card API is available in the following countries: The United States, Mexico, The United Kingdom, International Euro Card Countries, India, Australia, Japan and Singapore. Cancel Card API is available in more than 22 countries. A list of all countries can be found in the Guide tab.

Why it’s great

Controls

Improves governance through the automation of applications, cancellations, and secure transactions.

Efficiency

Eliminates the application process and shortens the cycle time for processing.

Security

Maintains accuracy and synchronisation for Card Member information and status.

Cost Effectiveness

Reduces the Client resources required to manage commercial Card programs.

How it works

1

Client Onboarding

Client Onboarding Onboard and adopt corporate products that support the automation of HR-related transactions.

2

Product Functionality

Product Functionality Once the REST API is consumed, the Client can automate their HR-related transactions.

3

Monitor Transactions

Monitor Transactions The Client monitors transaction status using the American Express @ Work B2B APIs.

API Summary

  • The following APIs are available today as part of @ Work B2B APIs:
  • Apply for Card API Initiate Card applications for corporate Cards.Plus: Corporate Purchasing Card (CPC) and Corporate Meeting Card (CMC) now available in Australia and India, with more countries coming soon!
  • Cancel Card APIInitiate Card cancellations for corporate Cards, Corporate Purchasing Cards, and Corporate Meeting Cards (CMC).

Integration Flow

  • Flexible implementations allow for rapid Onboarding and adoption of programmatic management of corporate Card products.
  • The API traffic is secured using 2-way TLS 1.2 and the data access is protected by a JSON Web Token(JWT).
  • The Client is provided with a Client ID and Secret Key once they have completed registration and have been given access to API Developers Portal.

Sample Apply For Card Flow

  • The Client sets up a trigger to initiate a Apply for Card request from their ERP, populating all the required fields.
  • The Client’s ERP sends the request to the @ Work B2B Apply for Card API endpoint.
  • The @ Work B2B Apply for Card API initiates a Card Application workflow assigned to the Client’s predetermined Basic Control Account (BCA) per their Company program hierarchy.
  • The Card Application workflow delivers two (2) emails to the Employee to open and complete their pre-filled application including uploading any necessary ID documents, respective to the country and Card type as associated to the BCA.
  • The @ Work B2B Apply for Card API provides a confirmation response to the Client ERP that the Card application has been submitted.

Sample Cancel Card Flow

  • The Client sets up a trigger to initiate a Cancel Card request from their ERP, populating all the required request fields.
  • The Client’s ERP sends the request to the @ Work B2B Cancel Card API endpoint.
  • The @ Work B2B Cancel Card API executes the cancellation request in the American Express system of record. Card cancellations will take effect immediately.
  • The @ Work B2B Cancel Card API provides a confirmation response to the Client’s ERP that the Card has been cancelled.

What You Need To Go Live

  • Review your use cases with American Express.
  • Demonstrate a PCI-compliant environment.