API Release Notes
This section will provide additional details on Corpay’s recent API suite enhancements and feature deployments.
*Note: The endpoint URLs used throughout this section are of the Corpay Cross-Border v1.8 API Beta (Sandbox) Environment. These are shown for testing / illustration purposes only and are not representative of Production endpoints.
Postman Documentation Updates
In order to keep our existing and future integrated partners up to date with all the latest Corpay
Cross-Border API enhancements and features, we’ve now added a “What’s New?” section on our Postman documentation.
Our What’s New section will be frequently updated to inform our partners of any new and exciting features/enhancements that have been deployed to the Cross-Border API Suite v.18. It will also include links that take you directly to the corresponding technical specification, allowing you to begin reviewing and integrating any desired updates.
You can find our public facing Cross-Border API documentation v.18 here:
As always, if you would like to learn more about any of our recently deployed updates, then please don’t hesitate to reach out to your Corpay account manager or technicalsales@corpay.com.
“Cambridge Global Payments” and “AFEX” are trading names that may be used for the international payment solutions and risk management solutions provided by certain affiliated entities using the brand “Corpay”. International payment solutions are provided in Australia through Cambridge Mercantile (Australia) Pty. Ltd.; in Canada through Cambridge Mercantile Corp.; in Switzerland through Associated Foreign Exchange (Schweiz) AG; in the United Kingdom through Cambridge Mercantile Corp. (UK) Ltd.; in Ireland and the European Economic Area on a cross-border basis through Associated Foreign Exchange Ireland Ltd.; in Jersey and the Channel Islands through AFEX Offshore Ltd.; in Singapore through Associated Foreign Exchange (Singapore) Pte. Ltd. and in the United States through Cambridge Mercantile Corp. (U.S.A.). Risk management solutions are provided in in Australia through Cambridge Mercantile (Australia) Pty. Ltd.; in Canada through Cambridge Mercantile Corp.; in the United Kingdom through Cambridge Mercantile Risk Management (UK) Ltd.; in Ireland and the European Economic Area on a cross-border basis through AFEX Markets Europe Ltd.; in Jersey and the Channel Islands through AFEX Offshore Ltd.; in Singapore through Associated Foreign Exchange (Singapore) Pte Ltd. and in the United States through Cambridge Mercantile Corp. (U.S.A.). Please refer to http://cross-border.corpay.com/disclaimers for important terms and information.
Upcoming Product Launches
Contact and Feedback
Webhooks
We are nearing the completion of our Webhook capabilities in which we will be able to send push notifications for different events you subscribe to. This means partners will no longer have to keep polling the Corpay API endpoints for new information or status updates (such as the status of a payment). We are looking at launching the product over the upcoming weeks following a soft pilot testing phase.
The first iteration of our Webhook launch will include push notifications for Payments GPS tracking and client onboarding account approval. Both notification types have been sought after by our partners, so we look forward to seeing the positive effect these additions will have to your Corpay API integration!
*Want to be part of Corpay’s early release/pilot scheme to test new API features before their wider production launch? Then please share your interest with technicalsales@corpay.com.
Upcoming API Changes
Corpay’s POST Accept Terms API endpoint has now been made obsolete and is no longer required for the Forward API workflow. A reminder of the change has been provided below:
What is the Event?
Corpay’s Forwards creation workflow has been updated in the v1.8 API suite.
Who is Impacted?
Users of Corpay Cross-Border’s Forwards API functionality.
What are the details?
Corpay’s POST Accept Terms API endpoint was deprecated on August 26th, 2023.
To streamline our Forward workflow and reduce the number of endpoints that need to be called to successfully complete a Forward order, the POST Accept Terms API endpoint for the v1.8 suite was made obsolete as of the advised date.
Partner’s are no longer required to send an ‘Accept Terms’ API request and instead, will complete their Forward booking with the existing POST Complete Order API endpoint.
Scheduled Event Time?
Removed on August 26th, 2023.
Contact:
If you have any questions regarding this Production API update, please contact:
technicalsales@corpay.com
Forward ‘Accept Terms’ API Endpoint Deprecation
Authentication Retrieval API
As part of our continuous development of Corpay’s Onboarding API suite, we have now added an Authentication Retrieval API endpoint. Previously, when a partner onboarded a new client account via the API, the secret keys for authentication were sent via an encrypted email. However, our new GET AuthSecret Keys endpoint will now allow partners to retrieve the secret keys for a newly onboarded client account directly via the API (helping to automate the end-to-end flow).
This new endpoint helps to further streamline the client onboarding process for all our integrated partners. Retrieving the secret keys via the API significantly reduces the turnaround time of a client’s account being operational and ready for use with our wider services.
Payment Tracking (SWIFT GPI)
Following the release of Corpay Cross-Border’s Payment Tracking (SWIFT GPI) API feature, partners will be able to trace the status and details of their wire payments sent via the SWIFT network. This has been a much sought-after feature whereby it will provide partners greater visibility into the status of their wire payments and more accurately communicate/display payment network messaging to their own clients.
Whilst Corpay’s Payment Tracking API services will retain existing capabilities, such as being able to view the SWIFT MT103 messaging of processed payments, the new tracking capabilities will provide a greater level of SWIFT messaging and status overview for a payment at each leg of its journey from Corpay to beneficiary (recipient). This is made possible by the new Payment Tracker ID that is returned for wire payments made via the API and searchable in our new Payment Tracking endpoints.
Payments GPS Benefits for integrated partners
Actionable transparency — Partners receive raw real-time data on each payment providing complete transparency on where the payment is, the latest status of the payment, reasons for rejection or delay, deductions by different correspondent banks, and the final amount delivered to the beneficiary.
Enhanced customer experience — With real-time raw data, partners can easily and quickly investigate any inquiry from their clients; helping them meet their SLA commitments for their downstream clients and build trust with their clients and their beneficiaries.
Self-serve and scalability — Partners can trace payment on demand with zero dependencies on Corpay’s team. Thus, the product improves their self-serve capability and allows them to scale international payments offering quickly.
Customization and flexibility in UX design — The product provides all the relevant data for payments, providing the flexibility to customize the payment tracking experience. Partners can present a simple payment journey with just the latest status of a payment to a comprehensive payment journey with every minute detail.
*Future Update: In Corpay’s first iteration of its upcoming Webhook deployment (scheduled for Q3), a push notification subscription will be available for the Onboarding API. This will allow for a push notification to be sent to our partners whenever one of their onboarded client accounts has been approved by Corpay’s Compliance team.
You can find an example of the GET AuthSecret Keys below:
Trends in the New Economy
Through the lens of global market dynamics, Corpay is exploring what comes next, in terms of how our world, and the global economy, have changed, and how we navigate the associated uncertainty. Read our publication, updated regularly, to get an understanding of the trends shaping the future of global business and the payments business in particular.
Breaking Market News, Insights and Analyses
Be in the know, with our free and exclusive site delivering curated, FX-specific news, macroeconomic analysis, and market intelligence, on the world’s biggest economies
Subscribe to our market analysis program to gain insights into trends and developments in global currency markets, with market wires delivered right to your inbox
Downloadable Documents
Data Privacy & Security
Read more about the measures we take to protect the privacy and security of client data.
Fraud Awareness
Read more to learn about the best practices you can use to detect and mitigate fraud.
Master Currency Capabilities
Read more about our payment formatting guidelines and currency capabilities.
High Risk & Sanctioned Countries
Read more on the high risk and sanctioned countries list, as it applies to all transactions.
“Payment Tracking is the top-requested feature by Airbase’s customers. Questions like “Where is my money?”, “My vendor is yet to receive the money?”, etc. are very common from our customers and this feature goes a long way in helping address those concerns. We have been beta testing this feature from day 1 because of how important it is to our customer experience and the impact it has in reducing the support tickets we receive. We no longer have to rely on the principle of no-news-is-good-news to know if a payment succeeded and that’s a big relief.
Thanks to Sanjeev, Cheryl, and the team for being very helpful and accommodative of all of our requests and suggestions. We look forward to further iterations of this feature in helping us serve all currencies and payment methods. Thanks!”
Terry Larsen
Senior Product Manager, Airbase
*Important to note: This feature is only available for viable payment currencies processed as
wires via the SWIFT network. EFT, iACH and other local payment rails are currently not supported
for payment tracking.
You can find the supporting Postman API documentation to all the existing and new
Payment Tracking API endpoints hyperlinked below:
Onboarding API
What value does onboarding API provide to partners?
Automated APIs eliminate the manual process of submitting requests, increases efficiency, and expedites the process resulting in reduced time to revenue for partners.
Consistent and accurate onboarding requests from different partners ensure improved SLA between Corpay and our Partners as well as between Partners and their downstream clients.
The automated process increases the scalability of onboarding new clients for partners.
Partners will have access to up-to-date onboarding Terms and Conditions (T&C), thus ensuring their downstream clients comply and submit requests based on the most recent requirements.
With our onboarding APIs, partners will have access to a faster and more streamlined process to onboard their downstream clients thus improving their customer onboarding experience.
*Important to note: Corpay’s Compliance team and designated Technical Sales Consultant will work with each partner to validate what data points and supporting on-boarding documentation needs to be sent to Corpay via the onboarding API to ensure the successful approval and onboarding of a
new client submission.
You can find the supporting Postman API documentation to all the new Onboarding API endpoints below:
“With hundreds of downstream users and many more hundreds on the way, improving the onboarding flow is a big initiative for us at PayRecs. Corpay has responded by developing an API endpoint that meets our service model and continues to work towards a fully automated process. We're excited about getting our customers to market quicker and reducing the touch points.”
Steve Habegger
Co-founder & CTO, PayRecs
Check out an episode of our FX in Focus podcast! In Episode 55, A Study in Grays: Navigating global sanctions and compliance issues for NGOs, where we discuss how navigating complex and changeable sanctions and regulatory regimes across the globe can be a key consideration for NGOs.
A Study in Grays: Navigating global sanctions and compliance issues for NGOs
Beneficiary Validation Best Practices
Corpay is dedicated to STP (straight-through processing) and seamless payment delivery. As part of Best Practice methodology, we regularly review beneficiary validation rules and exception handling metrics to mitigate manual repairs and ensure an exceptional payment life cycle.
We respectfully draw your attention to the following:
SWIFT/BIC Codes¹ (Mandatory for all Currencies — coming soon)
SWIFT / BIC codes are used to identify specific banking institutions and are considered key validation fields for cross-border payments.
Corpay strongly recommends including SWIFT/BIC on all wire payments.
IBAN²
An IBAN (International Bank Account Number) is used to identify an individual account (the ultimate beneficiary) within banking institutions.
Corpay strongly recommends including IBAN for any currency directed to an IBAN country.
The Corpay team greatly values our partnership! Please reach out to your Corpay Representative for any questions related to our Currency Capabilities, Product and Technology offerings.
*Please note: Where SWIFT/BIC and IBAN are not currently mandatory, this is subject to change with a 90 day notice period.
¹ SWIFT codes, developed by Society for Worldwide Interbank Financial Telecommunication (SWIFT), form of international identification systems. BIC (Bank Identifier Code) refers to the institution .SWIFT and BIC are used to identify a specific bank during an international transaction.
² An IBAN is used to identify an individual account involved in an international transaction. The IBAN also acts as a method of verifying that transaction details are correct.
New IP Address Range
Corpay’s Web Application Firewall (WAF) provider has added new IP addresses to their range which our API partners may need to whitelist. Whilst we have had no reports of API connectivity issues following the IP address range additions, please find the new IP addresses for your reference below:
131.125.128.0/17 (131.125.128.1-131.125.255.254)
Upcoming API Changes
Mandatory SWIFT BIC Requirement
As detailed in the ‘Beneficiary Validation Best Practices’ section, Corpay will be enforcing SWIFT BIC as a mandatory field when creating beneficiaries as of December 4th 2023. This means that when creating beneficiary templates of any currency/country via the POST Create/Edit API endpoint, you will be required to populate the swiftBicCode parameter. This change will also be reflected in our GET Beneficiary Rules API endpoint in which the swiftBicCode parameter will always show as ‘IsRequired – True’ (meaning it is a required field).
Furthermore, we will soon be updating our Beta (sandbox) environment to enforce SWIFT BIC. This will allow our partners to test how this change may impact their current beneficiary workflow integrations with Corpay’s API ahead of the Production deployment date. We will send an additional communication once the Beta environment has been updated with the new SWIFT BIC requirement in which the regEx for SWIFT will be: ^[A-Z0-9]{8,11}$.
Mandatory SWIFT BIC Requirement
As detailed in the ‘Beneficiary Validation Best Practices’ section, Corpay will be enforcing SWIFT BIC as a mandatory field when creating beneficiaries — originally set for December 4th*. This means that when creating beneficiary templates of any currency/country via the POST Create/Edit API endpoint, you will be required to populate the swiftBicCode parameter. This change will also be reflected in our GET Beneficiary Rules API endpoint in which the swiftBicCode parameter will always show as ‘IsRequired – True’ (meaning it is a required field).
Furthermore, we will soon be updating our Beta (sandbox) environment to enforce SWIFT BIC. This will allow our partners to test how this change may impact their current beneficiary workflow integrations with Corpay’s API ahead of the Production deployment date. We will send an additional communication once the Beta environment has been updated with the new SWIFT BIC requirement in which the regEx for SWIFT will be: ^[A-Z0-9]{8,11}$.
*We are postponing the effective date to develop a beta environment and additional support mechanisms to lessen the impact of the transition on our partners and clients. We are committed to moving to mandatory SWIFT BIC fields in the near future.
Payments GPS
Track and manage your payments from the moment they are booked, to when the payment leaves Corpay, to when it reaches the beneficiary’s bank account. To learn more, click here.
Push Notifications
Get access to instant notifications for your critical data events! Receive updates almost immediately on your data events without manual data poll requests for status updates.
With this simple but convenient feature, our push notifications have you covered, providing you with instant alerts on a payment and alerting you to newly onboarded clients, in each case almost immediately after it happens.
Benefits to Push Notifications
With instant notifications and increased data visibility, you can improve your customer experience by being informed about the data that matters to you and your client.
1. Reduce manual resources
2. Real-time updates
3. Improved customer experience
4. Improved self-serve capability
5. Secure and scalable
Current status: Testing is in progress on Beta environment, with our partners. Full Rollout is expected in Jan 2024.
Events covered under push notifications via webhooks:
Payments GPS
— Payment Accepted
— Payment Processed
— Payment Tracking Info Received
— Payment Processed Non-Swift
Onboarding
— Account Approved
Testing is in progress on Beta environment, with our partners. Full Rollout is expected in Jan 2024.
"The availability of GPS from Corpay has empowered our customers with in-depth knowledge about their payment deliverability. While we previously relied on basic Swift confirmations, we can now offer our customers granular and accurate insights. This has significantly boosted their confidence in using our platform for cross-border payments.
Internally, we are able to analyze corridor efficiencies and provide more intelligence to our customers on better deliverability options."
Steve Habegger
Co-founder & CTO
PayRecs
Read the success stories of Payments GPS:
"I wanted to share my experience with the Corpay Cross-Border portal, which has proven to be a valuable tool in my daily tasks. It really took no time to catch on.
I can now easily track, in detail, when payments are entered and when they are completed. This has significantly simplified the reconciliation process on my end. It also allows me to spot any potential issues ahead of time.
Additionally having access to up to date funding balance and transaction details is another excellent feature.
Great job Corpay team!"
Jeffrey Boyko
CFA, P.Eng
President, Chief Currency Strategist
Castle Currency Exchange, Inc.
Current status: North America is live, other global jurisdictions currently in Beta.
Commercial Case:
Operational Case:
API Documentation Updates
Corpay Cross-Border has launched a new developer portal which contains a variety of guides and resources, as well as our API documentation. The purpose of the portal is to further support our partners who are integrated (or in the process of integrating) with our API suite.
You can access the new developer portal and API documentation via the direct links below:
Corpay’s Postman collection is still available for you to download all our API endpoints to your own instance of Postman. The Postman documentation link can be found within the developer portal.
*Have feedback or thoughts on what you would like to see on this new portal? Then please don’t hesitate to share your suggestions with technicalsales@corpay.com in which all feedback is welcome!
Corpay Cross-Border API Resources are now even easier to navigate. The API Documentation section hosts all the guides and updates developers will need. The Payments Tracking section provides information and documentation on Payments GPS, our proprietary tool which assigns a unique tracker ID to every payment so it can be traced from inception to delivery. The Accounts Receivable section provides information on Multi-Currency Accounts, our proprietary that tool allows you to receive, and pay out foreign currencies in a secure account in your business’s name.
You may access these resources via the links below:
Corpay Cross-Border Solutions
API Resources
The global markets change constantly and technology needs to adapt quickly.
Corpay Cross-Border has introduced a feedback form so you can easily share your experience with our services. We welcome your ideas, thoughts, and suggestions on new features and tools, and how we can make your experience better every day.
You may access the form via the link below.
We look forward to hearing from you!
Earlier this year, we introduced a new ‘Partner Feedback & Ideas’ portal to gather your suggestions on any enhancements or new ideas you would like to see from Corpay Cross-Border. We received an overwhelming number of responses, and we want to thank everyone who contributed!
Onboarding API
We’ve received positive feedback from many of our partners regarding the time savings our Onboarding API, which was released last year, has achieved during the onboarding process of new downstream clients. However, several enhancement requests were noted to further streamline and simplify the process. These include:
File Submission: Currently, when partners send an onboarding request to Corpay via the ‘POST Client Onboarding’ endpoint, they must wait 15–30 seconds before submitting supporting onboarding files via the ‘POST Submit Onboarding Files’ endpoint.
If a partner attempts to submit files before this waiting period, there is no clear message indicating to wait or whether the upload was successful. This issue has been escalated to our Product and Development teams, and we are working on a resolution.
Mandatory Onboarding Fields: After the launch of our Onboarding API, some partners have reported confusion when trying to understand Corpay’s mandatory versus optional fields for the ‘POST Client Onboarding’ endpoint.
While our API documentation states mandatory and optional fields, we are currently working with our Compliance team to update the documentation for clearer and more accurate information about mandatory fields in specific jurisdictions. We will update our documentation in due course.
Beneficiary Workflow
As Corpay’s beneficiary workflow/management APIs form one of the more extensive collections of services under our Product suite, it was expected that we would receive a large volume of feedback on this topic. The feedback included:
Validation API Endpoint: Many of you requested a dedicated beneficiary validation API endpoint where you can enter or test beneficiary details without creating a template on Corpay’s side if it passes all validation checks. Currently, partners can only use Corpay’s ‘POST Create/Edit Bene’ endpoint to validate beneficiary data.
We are pleased to confirm that we are currently developing a separate validation beneficiary endpoint. This will allow partners to validate a new beneficiary template submission without it being created if the validation is successful. This feature should be ready in September 2024, and we will confirm in our upcoming API release notes.
Auto-Population of Required Beneficiary Bank Fields: To further automate and enhance our beneficiary creation workflow, a common request over the last several months has been for our ‘POST Create/Edit Bene’ endpoint to auto-populate the required bank fields by utilizing either the beneficiary’s IBAN, SWIFT/BIC, or Routing Code.
We understand that auto-populating required bank fields (such as the bank address) will reduce manual effort or development requirements for our partners and clients, while also ensuring more accurate and complete beneficiary data submissions. We have submitted this idea to our Product team for review and will update you once we have more information.
Available Payment Methods: Another common area of feedback related to the beneficiary workflow was regarding payment methods. While Corpay’s ‘GET Beneficiary Rules’ endpoint specifies what payment methods are available for a currency/country, there are some instances where partners need to hardcode a payment method value, followed by manual configuration by Corpay to route via a particular channel.
This situation is often due to the specific template details Corpay needs to acquire for a beneficiary template in certain currencies/countries. However, we have raised this with our Product and Operations teams to investigate whether there is a simpler solution.
Reporting & Notifications
Finally, we received several partner feedback items related to enhancing Corpay’s reporting and notification capabilities, with the most common being:
Webhooks – Push Notification for Incoming Funds: With the launch of our webhook/push notification capabilities last year, many partners have seen improvements in how they are notified in near real-time of status updates (whether related to payment tracking or account onboarding).
However, your feedback highlights an increasing demand for a push notification that alerts partners and clients when incoming settlement funds have been received and applied to one of their Corpay-held Multi-Currency Accounts or an open order booking.
We are currently reviewing our webhook capabilities for 2025, with priority emphasis on the need for an incoming funds/settlement push notification.
General Reporting Enhancements: Among the various feedback items, there were general requests for API reporting enhancements. The most common requests include:
• A date range filter for the ‘GET Lookup Orders’ endpoint.
• A status field that shows whether an order has or hasn’t been settled.
We have relayed these reporting requests to our Product and Development teams to begin the scope analysis, with the aim of including these additions in an upcoming API release.
Finally, we want to reassure you that even if your specific feedback item wasn’t mentioned above, it has been carefully recorded and will be reviewed by our Product team. We value all the feedback we receive and are committed to continuously improving our services to better meet your needs. Thank you once again to all our partners who took the time to share their thoughts and suggestions with us.
Partner Product Feedback
Partner Integration Review
As we approach the end of the year, we would like to take this opportunity to arrange a call between our implementation teams to discuss your current integration with Corpay Cross-Border. The primary goal of this conversation is to review the API endpoints and functionalities you are already using, as well as explore recently launched features that could help enhance efficiency and accelerate your business growth.
Additionally, we would like to ensure that we fully understand your roadmap for the remainder of the year and any plans you have in place for 2025. Please contact your Partnership Manager to schedule a convenient time for this discussion.