{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e8252741-7ce3-4212-878a-f77a4c4a35dd","name":"Corpay Cross-Border API Documentation v1.8","description":"Corpay Cross-Border API uses HATEOAS (Hypertext As The Engine Of Application State) framework. This means every response not only provides the requested data but also includes relevant links. This provides a link on the current resource as well as all actions that can be taken from there.\n\nResponse to APIs, once authenticated, are displayed in the following model where content and errors are provided in the appropriate lists. Links always contain a `SELF` link to the current endpoint, and any additional links, depending on the state of the resource. For example, a beneficiary object can be viewed and modified.\n\n``` json\n {\n \"content\": {},\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/{endpoint}\",\n \"method\": {POST GET or PUT}\n }\n ]\n }\n\n ```\n\n# Upcoming Updates\n\nStay informed about our upcoming API changes and enhancements. We’ll announce these updates as they become available. If you have any questions, please contact your **Corpay Account Manager**.\n\n- For a more detailed preview of what’s coming, please visit the [Upcoming Updates](https://cb.corpay.com/api-resources-documentation/#coming-change) page.\n \n- For full details on enhancements and sample responses, please visit the [API Release Notes](https://cb.corpay.com/api-resources-documentation/#API-release) page.\n \n\n**Estimated release timelines shared here are subject to change**. We’ll keep you informed as we progress.\n\n### IP Whitelisting\n\n**ETA: Q1 2026**\n\nWe are enhancing IP Whitelisting to improve security, flexibility, and performance across our API services.\n\n**Key updates include**:\n\n- Whitelisting at both **client** and **partner** levels\n \n- Support for **IPv4**, **IPv6**, and **valid CIDR** **ranges** (for example, 192.0.2.0/24)\n \n- Removal of SQL LIKE syntax (wildcards such as % will no longer be supported)\n \n- **Improved access control** with cached authentication for faster performance\n \n\n### Confirmation of Payee (CoP) and Verification of Payee (VoP)\n\n**ETA: Q1 2026**\n\nUK and EU payment regulatory bodies have introduced new name-checking protocols requiring banks, financial institutions, and payment service providers like Corpay to validate that payee details are correct and exactly match the associated bank account information. On **Corpay's internal workflow**, we have now enabled:\n\n- **UK’s Confirmation of Payee (CoP) protocol** for all incoming and outgoing GBP payments made via FPS, Bacs, and CHAPS.\n \n- **EU’s Verification of Payee (VoP) protocol** for all incoming and outgoing EUR payments made via SEPA Credit Transfer (CT) or SEPA Instant eligible BICs (for clients whose payment accounts are governed under our Ireland entity and its branches).\n \n\nWe are now **integrating CoP and VoP protocols into our REST API workflows.** Key updates include:\n\n- Migration to updated versions of our existing beneficiary creation endpoints.\n \n- Introduce new verification endpoints.\n \n\nWe'll keep you informed about the new endpoints and sample responses as we roll out the updates.\n\n**Note**: **CoP** and **VoP** **are regulatory mandates, not optional services**. These checks are enforced at the regulatory level, and **no exceptions are permitted**. Please direct any questions to your Corpay representative.\n\n### Beneficiary Rules (Template Guide) Endpoint Update\n\n**ETA: Q2 2026**\n\nAn updated version of the [GET Beneficiary Rules](https://apidocscrossborder.corpay.com/#ddfb9ee3-d7e9-4c55-9b22-b796569b5695) endpoint will be released. Key updates include:\n\n- Introduce new endpoints - `api/template-guide-rules` and `api/{clientCode}/{clientDivisionId}/template-guide-rules`\n \n- The API response will now return a list of accepted region values based on the specified `destinationCountry` and `bankCountry` parameters, ensuring compliance when creating or editing beneficiaries via the [POST Create/Edit Bene](https://apidocscrossborder.corpay.com/#36685106-4a23-48e8-b518-d98d869dbc85).\n \n- A new optional `routingCode` parameter will support accurate beneficiary rule retrieval for **CAD (Canada)**, addressing issues caused by varying account number digit lengths across Canadian banks and institutions.\n \n\nWe'll keep you informed about the new endpoints and sample responses as we roll out the updates.\n\n### Multi-Currency Accounts (MCA) Reporting Enhancements\n\n**ETA: Q2 2026**\n\nTo improve our MCA reporting, we'll introduce **new bank-style statements** via an **MCA Statement endpoint**, which will eventually replace the existing [GET Multi-Currency Accounts History](https://apidocscrossborder.corpay.com/#45182788-f835-4b84-8054-3b50f670f262) endpoint. Both endpoints will run in parallel during the transition period to support integration updates. We'll keep you informed about the detailed specifications, sample responses, and API deprecation timelines as we roll out the updates.\n\n# Release Notes\n\nCorpay Cross-Border's suite of API services and functionality is continuously growing in which we deploy multiple releases throughout the year. To discover what's new with Corpay's API, you can read our [What's New](https://apidocscrossborder.corpay.com/#7cf5b90c-3b0b-4ca8-9c3b-b4a8cc51e4a3) section that detail the most recent API enhancements and updates.\n\n# Common Terms\n\n
Client Code - A unique 6-digit client identifier for each client account. Used in all endpoints as part of URL.
Partner ID - Links multiple client accounts together. Used during authentication procedure.
Client Integration ID- Unique beneficiary ID that you can use in other endpoints.
Payment - Outgoing cashflow to a beneficiary.
Settlement - Incoming cashflow to Corpay.
MCA - Multi-Currency Accounts (Formerly known as FXBalance/CLIAB)
\n\n# Base URL\n\n| **ENVIRONMENT** | **URL** |\n| --- | --- |\n| Production | [https://crossborder.corpay.com](https://crossborder.corpay.com) |\n| Sandbox | [https://crossborder.beta.corpay.com](https://crossborder.beta.corpay.com) |\n\nThe documentation for each endpoint displays the HTTP method and the end path. Before you submit the request, you need to prepend the base path to get the full resource URL. All endpoints referenced in the documentation require the following base path: [https://crossborder.corpay.com](https://crossborder.corpay.com).\n\n**Note:** Depending on the stage of your implementation, the base path may be slightly different. For staging, pre-production, QA, and testing, use [https://crossborder.beta.corpay.com](https://crossborder.beta.corpay.com) to point to the Beta environment.\n\nCurly braces are used as a placeholder and indicate the type of value that you need to supply. For instance, where you see {clientCode} in the resource, you need to replace that string with your client code.\n\nFor example, in the documentation, endpoints look similar to this:\n\n`GET /api/{clientCode}/0/benes/{beneID}`\n\nWhen you add the base path, your client code, and any parameters, the result is a well-formed REST URL that looks something like this:\n\n`GET https://crossborder.corpay.com/api/123456/0/benes/jsmith321`\n\n# Response Codes\n\nMost of the endpoints include examples for both successful and unsuccessful responses. In the Example Request, click the downward arrow beside the response code to view additional examples.\n\nCorpay Cross-Border uses conventional HTTP response codes to indicate the success or failure of an API request.\n\n
Response Code
Description
2xx
Success.
4xx
Client error. This is usually due to missing or incorrect information, for example, a missing or incorrect parameter or value.
401 - Authorization issue. This usually means that the authorization token has expired and you need to refresh it.
410 - Rate resource expired. Due to currency fluctations, quotes are valid for a very limited period of time. When you get a 410 error, it means that the rate resource you're trying to use has expired and you need to generate a new quote.
5xx
Server error. If the error persists, contact Corpay Tier 2 support.