Memo Manager
Number of APIs: 20
Home
ARC’s Memo Manager API enables the user to submit a query on airline-issued debit memos, credit memos and recall commission memos. The current phase of the Memo Manager API allows the user to [search] for a list of memo numbers, retrieve [memo details] for specified memos, and download [attachments] and [pay] memos.
To assist you with set up and testing of API functionality, a mocking service is available. To access data in either the sandbox environment or production, authentication is required. Request access online or contact your designated ARC Sales Representative for more information.
Subscribe to ARC’s Status Dashboard to be informed of the status of any ARC service including APIs.
For technical or product support, please contact ARC at apihelp@arccorp.com.
Getting Started
Learning About ARC's APIs
Information about ARC’s APIs can be found here on the ARC API Portal.
To access sandbox or production data, you must first request access.
Requesting Access
In an email request to apihelp@arccorp.com, please supply the following:
Your Agency/HOL or Airline Number or GDS Identification
Email address to securely send the API credentials.
Requested Environment: UAT or PROD
Source (your outbound) internet addresses in CIDR Notation e.g. 150.5.0.0/16
Authentication Requirements
Authentication is required to access ARC’s APIs in sandbox and production environments. ARC uses OAuth2.0, an industry-standard protocol, to authenticate users. Once ARC has granted you access to an API and you have received an approval email, you must obtain an OAuth2.0 bearer token.
To receive your bearer token:
Acquire your client ID and client secret from My Applications
Post: https://myarc.okta.com/oauth2/ause2fx17D7uPsznb356/v1/token
Provide the following in your request to receive your bearer token. Then use your bearer token in the “Authorization” header to submit requests to the API.
granttype = clientcredentials
scope = memos_api
Accessing ARC's APIs
Once ARC has granted API access, you will have full access to the selected API instance. To use the API, enter your client ID and client secret to programmatically obtain a bearer token, which can then be sent to make API client calls.
Release Notes
2023-10-29
Migrating API away from Mulesoft Platform.
Enhanced security to restrict to customer only provided IP addresss ranges.
2019-12-12
New Features
- Memo Pay API
Bug Fixes
- Addressed last modified date ranges searches for the prior year.
2019-04-23
The initial release of Memo Search, Detail and Attachment API.
API Specification Summary
With ARC's Memo Manager API, users can perform the following functions using the endpoints listed below: Search Memos (/memos), Get Memo Details (/memos/details), Get Attachments (/memos/attachments/{attachmentId}), Pay Memos (/memos/pay), and Dispute Memos (/memos/dispute). Providing these functions within the API eliminates the need to manually perform these actions within the Memo Manager tool.
The Search Memos (/memos) function enables users to retrieve a list of memo numbers and high-level information on those memos.
The Get Memo Details (/memos/details) function allows users to retrieve all memo details for specific memo numbers.
The Get Attachments (/memos/attachments/{attachmentId}) function enables the user to quickly download memo attachment files.
The Pay Memo (/memos/pay) function allows the agency to pay one or more memos.
The Dispute Memo (/memos/dispute) function allows the agency to open a dispute on one or more memos. Additionally, as part of the dispute process, the Accept Dispute (/memos/accept) function enables the carrier to accept/resolve an open dispute, and the Reject Dispute (/memos/reject) function allows the carrier to reject it.
The Add Correspondence (/memos/correspondence) function allows the agency to add a Correspondence for non-closed (Open or Inactive) Memos.
The Add Non IAR Payment (/memos/noniarpayment) function allows the agency or carrier to add a Non IAR Payment for non-closed (Open or Inactive) Memos.
The Memo Resolution (/memos/memoresoluton) function allows airline to update the Resolution Type of non-closed (Open or Inactive) memos.
The Memo Reason (/memos/memoreason) function allows agencies to submit a Reason Catagory and Memo Reason 'change request' for non-closed (Open or Inactive) memos.
The Agency Reason (/memos/agencyreason) function allows agencies to submit a Agency Reason for non-closed (Open or Inactive) memos.
The GDS Assignment (/memos/gdsassignment) function allows airlines and agencies to grant or remove access to a GDS for non-closed (Open or Inactive) memos. GDS's can also remove it's own assignment from the memo.
The Carrier Contact (/memos/carriercontact) function allows an airline to update the contact information for non-closed (Open or Inactive) memos.
The Flex Field (/memos/flexfields) function allows airlines, agencies and GDSs to update the flex fields for their own memos. (Add new values, update existing values, and remove existing values)
The memo attachment (/memos/saveattachments) function allows airlines, agencies and GDSs to add attachments for their own memos. Airlines, agencies and GDSs can also remove an attachment (/memos/deleteattachment) that they had previously uploaded. Multiple attachments for a the same memo can also be included in a single API request.
Airlines, agencies and GDSs can also add multiple attachments for multiple memos (/memos/correspondattach) in a single API request. Along with this request, the user can also include a 'public' and/or 'private' correspondence to be included in the memos.
Terms and Conditions
These API Terms form a binding Contract
between you and us. Us
or “our” refers to ARC and you,
and your,
refers to the individual, company or legal entity that you represent.
Access to Our APIs
Your Applications
Subject to the restrictions below, we grant you a non-exclusive, worldwide, non-transferable (subject to the section titled Assignment
), limited license to access our APIs and documentation only as necessary to develop, test and support an integration of your application (an Application
or App
) with the Services. You may charge for your Application; however, you may not sell, rent, lease, sublicense, redistribute, or syndicate access to any of our APIs.
Terms
Your license to access our APIs and documentation is limited and subject to compliance with Appendix A Developer Guidelines. Further, you will not: (A) access our APIs or documentation in violation of any law or regulation; (B) access our APIs in any manner that (i) compromises, breaks or circumvents any of our technical processes or security measures associated with the Services, (ii) poses a security vulnerability to customers or users of the Services, or (iii) tests the vulnerability of our systems or networks; (C) access our APIs or documentation in order to replicate or compete with the Services; (D) attempt to reverse engineer or otherwise derive source code, trade secrets, or know-how of our APIs or Services; or (E) attempt to use our APIs in a manner that exceeds rate limits, or constitutes excessive or abusive usage.
Our Right to Suspend Access and Audit
If we believe that there is a violation of the Contract that can simply be remedied by your modification or update of your Application, we will, in most cases, ask you to take direct action rather than intervene. In such instance, we may use your name, address and other contact details to contact you or provide this contact information to any third party that reasonably, in ARC's sole determination, claims that you do not possess all of the necessary intellectual property rights. In some instances, we may directly step in and take what we determine to be appropriate action if you are not responsive, or if we believe there is a credible risk of harm to us, the Services, our customers or users or any third parties. ARC also reserves a right to audit your application to ensure it does not violate our terms and policies. You agree that you will cooperate with inquiries related to such an audit and provide us with proof that your application complies with our terms and policies.
Fees
Fees are subject to specific terms based on the API being leveraged. Please refer to the API Order Form for specific pricing.
Ownership and Proprietary Rights
Your Property and Our Property
You retain your ownership rights in your Application and we own and will continue to own our APIs, documentation and Services, including all related intellectual property rights therein. All of our rights not expressly granted by the Contract are hereby retained.
Please Provide Us Your Feedback
The more suggestions our developers make, the better our APIs become. If you send us any feedback or suggestions regarding the APIs or documentation, there is a chance we will use it, so you grant us an unlimited, irrevocable, perpetual, sublicensable, transferable, royalty-free license to use any such feedback or suggestions for any purpose without any obligation or compensation
to you. If we choose not to implement the suggestion, please don’t take it personally. We appreciate it nonetheless.
Termination
You may terminate the Contract by discontinuing use of our APIs. We may terminate the Contract with or without cause, and without notice to you. Upon termination of the Contract, all rights and licenses granted to you will terminate immediately. You understand that any APIs or documentation that are not made generally available but that are otherwise made available to you are the
confidential information of ARC. Upon termination of the Contract, you will promptly destroy copies of any documentation and any other ARC information in your possession or control that was received under the Contract.
Representations; Disclaimer of Warranties
You represent and warrant that you have validly entered into the Contract and have
the legal power to do so.
EXCEPT AS EXPRESSLY PROVIDED FOR HEREIN, THE APIS, DOCUMENTATION AND ALL RELATED
COMPONENTS AND INFORMATION ARE PROVIDED BY US ON AN AS IS
AND
AS AVAILABLE
BASIS WITHOUT ANY WARRANTIES OF ANY KIND, AND WE
EXPRESSLY DISCLAIM ANY AND ALL WARRANTIES, WHETHER EXPRESS OR IMPLIED,
INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, TITLE, FITNESS FOR A
PARTICULAR PURPOSE, AND NON-INFRINGEMENT. YOU ACKNOWLEDGE THAT WE DO NOT
WARRANT THAT THE APIS WILL BE UNINTERRUPTED, TIMELY, SECURE, OR ERROR-FREE.
Limitation of Liability
IN NO EVENT WILL OUR OR THE ARC EXTENDED FAMILY’S AGGREGATE LIABILITY ARISING OUT OF
OR RELATED TO THE CONTRACT (WHETHER IN CONTRACT OR TORT OR UNDER ANY OTHER
THEORY OF LIABILITY) EXCEED US $100.
IN NO EVENT WILL WE OR THE ARC EXTENDED FAMILY HAVE ANY LIABILITY TO YOU OR TO ANY
THIRD PARTY FOR ANY LOST PROFITS OR REVENUES OR FOR ANY INDIRECT, SPECIAL,
INCIDENTAL, CONSEQUENTIAL, COVER OR PUNITIVE DAMAGES HOWEVER CAUSED, WHETHER IN
CONTRACT, TORT OR UNDER ANY OTHER THEORY OF LIABILITY, AND WHETHER OR NOT YOU
OR THE THIRD PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THE
FOREGOING DISCLAIMER WILL NOT APPLY TO THE EXTENT PROHIBITED BY APPLICABLE LAW.
The limitations under this Limitation of Liability
section apply with
respect to all legal theories, whether in contract, tort or otherwise, and to
the extent permitted by law. The provisions of this Limitation of
Liability
section allocate the risks under the Contract between the
parties, and the parties have relied on these limitations in determining
whether to enter into the Contract.
Our APIs and documentation are intended for use by businesses and organizations and
not for consumer purposes.
Your Indemnification of Us
You will defend us and our owners, subsidiaries and affiliates, and all officers,
directors, employees and agents (collectively, the "ARCIndemnified Parties") from and against any and all third***party claims, actions, suits, proceedings, and demands arising from or relatedto your violation of the Contract [or your violation of your user agreement orprivacy policy] (a *Claim Against Us
**), and will indemnify the ARC Indemnified Parties for all reasonable attorney’s fees incurred and damages and other costs finally awarded against a ARC Indemnified Party in connection with or as a result of, and for amounts paid by a ARC Indemnified Party under a settlement you approve of in connection with, a Claim Against Us. We must provide you with prompt written notice of any Claim Against Us and allow you the right to assume the exclusive defense and control, and cooperate with any reasonable requests assisting your defense and settlement of such matter. This section states your sole liability with respect to, and the ARC Indemnified Parties’ exclusive remedy against you for, any Claim Against Us.
Limitations on Indemnifications
Notwithstanding anything contained in the preceding section, (a) we will always be free to choose our own counsel if we pay for the cost of such counsel; and (b) no settlement may be entered into by you, without our express written consent (such consent not to be unreasonably withheld), if: (i) the third party asserting the claim is a government agency, (ii) the settlement arguably involves the making of admissions, (iii) the settlement does not include a full release of liability, or (iv) the settlement includes terms other than a full release of liability and the payment of money.
Survival
The sections titled Our Rights to Suspend Access and Audit,
Ownership & Proprietary Rights,
Termination,
Representations; Disclaimer of Warranties,
Limitation of Liability,
Your Indemnification of Us,
Limitations on Indemnifications,
and Survival,
as well as all of the provisions under the general heading General Provisions,
will survive any termination or expiration of the Contract.
General Provisions
Publicity
You grant us the right to use your company name and logo as a reference for marketing or promotional purposes on our website and in other public or private communications with our existing or potential developers and customers, subject to your standard trademark usage guidelines as provided to us from time-to-time.
Force Majeure
Neither we nor you will be liable by reason of any failure or delay in the performance of its obligations on account of events beyond the reasonable control of a party, which may include denial-of-service attacks, a failure by a third party hosting provider or utility provider, strikes, shortages, riots, fires, acts of God, war, terrorism, and governmental action.
Relationship of the Parties; No Third Party Beneficiaries
The parties are independent contractors. The Contract does not create a partnership, franchise, joint venture, agency, fiduciary or employment relationship between the parties. There are no third party beneficiaries to the Contract.
Email and ARC Messages
Except as otherwise set forth herein, all notices under the Contract will be by
email. Notices to ARC will be sent to law2@arccorp.com, except for legal
notices, such as notices of termination, which must be sent to
law2@arccorp.com. Notices will be deemed to have been duly given (a) the day
after they are sent, in the case of notices through email; and (b) the same
day, in the case of notices through the Services.
Modifications to our APIs and Documentation
ARC is still evolving, and so we need the flexibility to occasionally make
changes to our APIs, including backwards incompatible changes. We will try to
give notice of these changes. Also, parts of our API are undocumented,
including certain methods, events, and properties. Given that these
undocumented aspects of our APIs may change at any time, you should not rely on
their behaviors.
Modifications to the Contract
As our business evolves, we may change these API Terms and the other components
of the Contract. If we make a material change to the Contract, we will provide
you with reasonable notice prior to the change taking effect. You can review
the most current version of the API Terms at any time by visiting this page and
by visiting the most current versions of the other pages that are referenced in
the Contract. The materially revised Contract will become effective on the date
set forth in our notice, and all other changes will become effective upon
posting of the change. If you access our APIs after the effective date, that
access will constitute your acceptance of any revised terms and conditions.
Waiver
No failure or delay by either party in exercising any right under the Contract
will constitute a waiver of that right. No waiver under the Contract will be
effective unless made in writing and signed by an authorized representative of
the party being deemed to have granted the waiver.
Severability
The Contract will be enforced to the fullest extent permitted under applicable
law. If any provision of the Contract is held by a court of competent
jurisdiction to be contrary to law, the provision will be modified by the court
and interpreted so as best to accomplish the objectives of the original
provision to the fullest extent permitted by law, and the remaining provisions
of the Contract will remain in effect.
Assignment
Neither party may assign or delegate any of its rights or obligations
hereunder, whether by operation of law or otherwise, without the prior written
consent of the other party (not to be unreasonably withheld). Notwithstanding
the foregoing, either party may assign the Contract in its entirety, without
consent of the other party, to a corporate affiliate or in connection with a
merger, acquisition, corporate reorganization, or sale of all or substantially
all of its assets. Any purported assignment in violation of this section is
void. A party’s sole remedy for any purported assignment by the other party in
breach of this section will be, at the non-assigning party’s election,
termination of the Contract upon written notice to the assigning party. Subject
to the foregoing, the Contract will bind and inure to the benefit of the
parties, their respective successors and permitted assigns.
Choice of Law; Jurisdiction; Venue
The Contract, and any disputes arising out of or related hereto, will be
governed exclusively by the laws of Commonwealth of Virginia, without regard to
conflicts of laws rules or the United Nations Convention on the International
Sale of Goods. The State or Federal courts located in the Commonwealth of
Virginia will have exclusive jurisdiction to adjudicate any dispute arising out
of or relating to the Contract or its formation, interpretation or enforcement.
Each party hereby consents and submits to the exclusive jurisdiction of such
courts. Each party also hereby waives any right to jury trial in connection
with any action or litigation in any way arising out of or related to the
Contract. In any action or proceeding to enforce rights under the Contract, the
prevailing party will be entitled to recover its reasonable costs and
attorney’s fees.
Entire Agreement
The Contract, including these API Terms constitutes the entire agreement
between the parties and supersedes all prior and contemporaneous agreements,
proposals or representations, written or oral, concerning its subject matter.
To the extent of any conflict or inconsistency between the provisions in these
API Terms and any other documents or pages referenced in these API Terms, the
following order of precedence will apply: (A) the API Terms, (B) Appendix A and
(C) any other documents or pages referenced in the Contract.
Appendix
A Developer Guidelines
Effective Date: June 20, 2019
Our goal is for ARC to be the premier driver of air travel intelligence and
commerce with leading business solutions, travel agency accreditation services,
process and financial management tools, and high-quality data. We welcome
Application developers that are interested in connecting to our Services and
are excited to see the amazing experiences you are building within ARC. By
“Application,” we mean any software application, functionality, website,
product or service that you create that uses the ARC APIs. Developers are
required to comply with this Policy and our related API terms and other
obligations. When we use the term “Services” we are referring to ARC’s services
and related systems and technology, as well as ARC’s websites and all of the
information and content made available by or on behalf of ARC through any of
those services.
Privacy, safety and a high-quality User experience are very important, and this Policy
is designed with those goals in mind. We can’t cover every type of Application
in this Policy, but we aim to give guidance to developers so that you
understand what Applications will be included in ARC’s app directory and what
Applications will not. To protect Users and our Services, we reserve the right
to take any action we deem necessary if an Application violates the letter or
spirit of this Policy. By “User” we mean any “Authorized User” as defined in
our Customer Terms of Service, including anyone who interacts with the
Application directly or indirectly or anyone whose Data is exposed to or used
by the Application. By “Data” we mean data, information or content uploaded,
posted, transmitted or otherwise made available by Users via the Services,
including messages, files, comments, profile information, metadata and token
data.
Security:
We take the security of Data very seriously, and you must as well. Your network
and the operating system and software of your web servers, databases, and
computer systems must be properly configured to securely operate your
Application and store Data. Data must be stored and served using strong
encryption. In addition, Applications and developers are prohibited from:
• Degrading or compromising security in any way
• Providing access to ARC in any fraudulent or unauthorized way, including
bypassing or circumventing ARC protocols and access controls
• Using unpublished APIs
• Including misleading and/or deceptive statements about Application
functionality, performance, origin or Data use
• Transmitting any viruses or other code that may damage, detrimentally
interfere with, surreptitiously intercept or expropriate any system or Data
• Attempting to reverse engineer or otherwise derive source code, trade
secrets, or know-how in the ARC API or any portion thereof
User Experience:
Every Application must be useful, appropriate, respect User privacy, and provide a
generally good User experience. In keeping with this, Applications and
developers are prohibited from:
• Degrading or compromising performance of the Services
• Using vulgar or obscene language or images.
• Creating poor User experiences that do not add value to Users in a work
setting or that detract from the overall utility of ARC and the overall
Application ecosystem
• Displaying inappropriate communications through your Application. The purpose
of the Application and User expectations must be clear and transparent and
match ARC requirements and expectations
• Neglecting appropriate customer assistance. Every Application must include a
link to installation instructions and customer support information, including a
contact for customer support. You must keep your Application updated and
provide timely and accurate User support
Business:
In using ARC APIs, developers must agree to respect our business as we respect
yours. Every Application must behave in accordance with appropriate and
accepted business conduct. As part of good business practices, Applications and
developers are prohibited from:
• Circumventing ARC’s intended limitations (including pricing, features and
access structures). You may not use the ARC API to replicate or compete with
core products or services offered by ARC
• Advertising, including display ads, within the Application experience or ARC
platform. In addition, Applications may not use Data or content from ARC in any
advertisements or for purposes of targeting advertisements or contacting Users,
including in that Application, your other Applications, or elsewhere
• Implying a ARC endorsement, certification, affiliation or partnership unless
you have explicit permission from ARC to do so
• Sub-licensing, distributing or allowing access to the ARC APIs to anyone else
Use of Data:
Protecting Data is paramount at ARC, and must be for you. You are responsible
for good Data stewardship practices. First and foremost, you have no
independent rights to any Data. In accordance with this, Applications and
developers are prohibited from:
• Collecting, storing, and using Data without obtaining proper consent of the
User
• Using Data to contact Users. If you would like to contact Users outside of
ARC, you must gain permission through a clear and separate permissions process.
You may only contact Users for emergencies in which the safety and security of
the User is otherwise at risk and in compliance with the law
• Asking Users to provide sensitive, private, and confidential personal
information, such as credit card numbers or passwords unless specifically
necessary as part of the Application’s legitimate function and purpose
• Renting, selling or sharing Data with third parties under any circumstances
• Creating Applications that encourage installers to circumvent or interfere
with their own workplace and employer data, privacy and security policies
• Exploiting Data to create User profiles other than that which is necessary
for the Application to function
• Ignoring a User’s request for deletion. When a User deletes your Application
or if you discontinue your Application you must delete all associated Data
within 14 business days
• Combining Data with data gathered from other sources for any purposes
unrelated to the use of the Application
• Requesting and using scopes not required for your Application’s functioning.
Use only the appropriate and necessary scopes and clearly define the need for
scopes within your Application’s description
• Failing to notify Users about privacy and their Data. Your Application must
include a publicly-available and easily accessible privacy policy that explains
how the Application collects, uses, processes and stores Data, and what control
Users have over their Data
• Accessing Data for surveillance purposes. You may not allow or assist any
entity to conduct surveillance or obtain Data using your access to the ARC API
• Otherwise exploiting Data in a way not approved by ARC and not disclosed to
and permitted by Users. You may, however, use Data that is both aggregated and
anonymized for purposes of analytics and development related to the Application
Law and Safety:
Applications should not create unsafe environments or hardships for Users. Each
Application must comply with all applicable laws and legal requirements in all
locations where it is made available to Users. In addition, Applications and
developers are prohibited from:
• Permitting use by children under the age of 16
• Spamming, harassing, stalking, intimidating or threatening Users
• Allowing impersonation of Users or otherwise allowing for false
representations within the Application
• Facilitating violations of the law
• Infringing on anyone else's intellectual property rights (including ARC’s)
• Representing that your Application is authorized by or produced by another
company or organization
• Allowing or facilitating financial transactions conducted in an insecure and
unapproved manner
In addition, Applications and developers must:
• Exercise good judgement
• Submit Applications with reasonable work-related or team-building purposes
• Be a good fit for ARC workspaces
• Notify us immediately if you change the function of, or discontinue your
Application
Data Incident:
If Data is breached, exposed, exploited, or otherwise compromised through your
Application or company, you must inform all affected Users and ARC immediately.
You can reach ARC at law2@arccorp.com.
Violations of these terms and conditions may result in the revocation of your ability to access theApplications, legal action or any other action deemed necessary by ARC. Pleasenote that we may periodically audit Applications.
-
memos-details - Get Memo Details POST {{baseUrl}}/memos/details
-
memos-attachments-{attachmentId} - Get Attachments GET {{baseUrl}}/memos/attachments/:attachmentId
-
memos-pay - Pay Memo POST {{baseUrl}}/memos/pay
-
memos-dispute - Dispute Memo POST {{baseUrl}}/memos/dispute
-
memos-accept - Accept Dispute Memo POST {{baseUrl}}/memos/accept
-
memos-reject - Reject Dispute Memo POST {{baseUrl}}/memos/reject
-
memos-correspondence - Add Correspondence POST {{baseUrl}}/memos/correspondence
-
memos-noniarpayment - Add Non IAR Payment POST {{baseUrl}}/memos/noniarpayment
-
memos-memoresolution - Memo Resolution POST {{baseUrl}}/memos/memoresolution
-
memos-memoreason - Memo Reason POST {{baseUrl}}/memos/memoreason