Corpay Cross-Border API Documentation v1.8

## Sections
• [Upcoming Updates](https://developer.crossborder.corpay.com/apidocscrossborder/upcoming-updates-1.md): Stay informed about our upcoming API changes and enhancements. We’ll announce these updates as they become available. Please direct any questions to your Corpay representative. Estimated release timelines shared here are subject to change. We’ll keep you informed as we progress. For additional resources, please visit this page . Migration Required Update Action Required Migration Deadline CoP & VoP - Bene Create V2. See Release Notes . Update integrations to use v2 Friday, October 30, 2026 Incoming Funds V2. See Release Notes . Update integrations to use v2 Friday, January 15, 2027 Cancel Order API V2. Read here . Update integrations to use v2 Q2 2027 (To be confirmed) SWIFT Mandate. Upcoming. Read here . Update Beneficiary Bank Information Q4 2026 (To be confirmed) Beneficiary Rules (Template Guide) Endpoint Update ETA: Q1 2026 Now Available - Released on: Friday, March, 9 2026. Read here . An updated version of the endpoint will be released. Key updates include: 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 Create/Edit Bene API. 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. We'll keep you informed about the new endpoints and sample responses as we roll out the updates. Confirmation of Payee (CoP) and Verification of Payee (VoP) ETA: Q1 2026 Now Available - Released on: Friday, July 27, 2026. Read here . UK 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. In Corpay's internal workflow , we have now enabled: UK’s Confirmation of Payee (CoP) protocol for all incoming and outgoing GBP payments made via FPS, Bacs, and CHAPS. 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). We are now integrating CoP and VoP protocols into our REST API workflows. Key updates include: Migration to updated versions of our existing beneficiary creation endpoints. Introduce new verification endpoints. We'll keep you informed about the new endpoints and sample responses as we roll out the updates. SWIFT Mandatory for Cross-Border Payments ETA: Q1 2026 The SWIFT BIC field is now required for most cross-border payment combinations when beneficiaries are created or updated via Corpay Cross-Border platform or API . Please ensure that you obtain the beneficiary’s bank SWIFT BIC before creating beneficiary templates and payment instructions. We'll keep you informed as we roll out this update. The SWIFT BIC field is mandatory for most cross-border payments, with exceptions listed below. For all other in-scope currency, modality, and country combinations, the SWIFT BIC field is mandatory. Title Description Title urrency Modality Country USD Wire United States of America USD Wire Guam USD Wire Puerto Rico CAD EFT Canada USD EFT Canada USD EFT United States of America USD EFT Guam USD EFT Puerto Rico GBP EFT United Kingdom AUD EFT Australia IP Whitelisting ETA: Q1 2026 We are enhancing IP Whitelisting to improve security, flexibility, and performance across our API services. Key updates include : Whitelisting at both client and partner levels Support for IPv4 , IPv6 , and valid CIDR ranges (for example, 192.0.2.0/24) Removal of SQL LIKE syntax (wildcards such as % will no longer be supported) Improved access control with cached authentication for faster performance Multi-Currency Accounts (MCA) Reporting Enhancements ETA: Q2 2026 To improve our MCA reporting, we'll introduce new bank-style statements via an MCA Statement endpoint , which will eventually replace the existing 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. Archive - 2025 Upcoming Updates As part of Corpay’s ongoing investment in payment modernization and compliance, we’re introducing ISO 20022-aligned enhancements to both our UI and API, enabling richer, standardized data formats. The Payment Tracking endpoints will now return either the SWIFT MT103 or the ISO equivalent MX messaging . Updated API docs with example responses will be published soon. Now Available - Released on: June 13, 2025. Read here . As part of additional regulatory and banking requirements, a valid POP will be mandatory when instructing payments . A Corpay accepted POP value must be entered in the purposeOfPayment request field when submitting a payment via the following endpoints: POST Instruct Deal POST Multiple Payments POST Book Drawdown Now Available - Released on: August 25, 2025 . Read here . To maintain consistency with the Corpay Cross-Border platform, editing the currency field on existing beneficiary templates via the API will be restricted . After this restriction is enforced, to change a beneficiary’s currency, a new template must be created via the API. Now Available - Released on: August 25, 2025. Read here . As part of our product development roadmap, we are introducing two new webhook subscription types: Incoming Fund Notifications: Payments on Hold If you’d like to be one of our pilot clients and gain early access to these webhook features, please contact your Corpay Account Manager. Now Available - Released on: June 27, 2025. Read here . We’re enhancing our Onboarding API with additional picklist values (e.g., purpose of transaction) and new data fields. These enhancements help ensure our partners and Corpay digitally capture all of the required information to meet global Compliance KYC requirements. Now Available - Released on: October 31, 2025. Read here .
• [Introduction](https://developer.crossborder.corpay.com/apidocscrossborder/introduction.md): Corpay Cross-Border API (Version: 1.8) The Corpay Cross-Border APIs enable you to integrate and automate international payments, foreign exchange, beneficiary management, client onboarding, payment tracking, and related workflow steps. Use these APIs to integrate and automate payments, FX, client onboarding, beneficiary workflows, and payment tracking. Explore Corpay Cross-Border APIs Authentication Authenticate your integration and obtain the access tokens required to call Corpay APIs. Beneficiaries Create, validate, and manage payment beneficiaries. FX Book Spot and Forward transactions and manage FX. Payments Send and track domestic and international payments. Accounts Access balances and accounts Reporting Track and reconcile transactions Client Onboarding Onboard clients and submit supporting documentation Webhooks Receive real-time notifications for account events AI & Export Button Use the AI & Export button to Copy/View as Markdown to turn any page into clean, LLM-ready Markdown content. API documentation is available on the Corpay Developer Portal as always-current formats (Markdown export) to ensure you always have access to the latest version. It is not offered as downloadable static PDFs. For assistance, please contact your Corpay Account Representative. Need Help? If you need assistance setting up your integration, accessing the sandbox or preparing for production, contact your Corpay Account Representative or email technicalsales@corpay.com
  • [Getting Started](https://developer.crossborder.corpay.com/apidocscrossborder/introduction/getting-started.md): Before you begin, make sure you have access to the sandbox, the authentication details for your environment, and the right product permissions for the workflows you plan to use. Request API access : Contact your Corpay Account Representative to request API access and credentials. Review the Authentication flow : Corpay APIs use a token-based authentication model. Before calling any API endpoint, generate an access token using the Partner-level and Client-level authentication endpoints. Test your first request in the sandbox : Test your integration using the Corpay Sandbox environment, which mirrors the production APIs. Use the workflow guides to build the full integration : Explore the documentation for complete request/response examples and error codes. Validate and Go Live : Validate your implementation before moving to production. Example Workflow Example workflow to create a beneficiary, book an FX transaction, send a payment, and track its progress. 1 Authenticate Obtain the access tokens required to make API requests. See: Authentication . 2 Retrieve validation requirements Before creating the beneficiary, retrieve the applicable beneficiary rules and supporting reference data. See: Beneficiary Rules 3 Validate the beneficiary Submit the beneficiary information to the validation endpoint. See: Beneficiary Validation 4 Create the beneficiary Use the validated payload to create the beneficiary. See: Create Beneficiary 5 Request a Spot quote Request an exchange rate using the endpoint See: Request Quote 6 Book the Spot deal Book the quoted rate. See: Book Deal 7 Instruct the payment Use the booked deal to instruct funds to the beneficiary. See: Instruct Deal 8 Track the payment After the payment is submitted track payment using payment tracking or webhooks See: Payment Tracking , Webhooks Test & Debug Use the workflow guides to find the API endpoints for each task. Every endpoint includes a Try in API Explorer button that opens it in a dedicated testing workspace. The Explorer documents all request parameters, and you can switch between endpoints, test requests, and troubleshoot issues. Run in Postman If you prefer Postman, click the button to fork the collection:
  • [Environments](https://developer.crossborder.corpay.com/apidocscrossborder/introduction/environments.md): Environment URL Sandbox https://crossborder.beta.corpay.com Production https://crossborder.corpay.com
  • [Sandbox Testing](https://developer.crossborder.corpay.com/apidocscrossborder/introduction/sandbox-testing.md): Use the sandbox to test requests, validate responses, and confirm your business rules before you go live. The sandbox provides the same API structure and authentication model as the production environment, enabling you to validate your implementation before going live. Getting Sandbox Access To request sandbox access, contact your Corpay Account Representative. Each endpoint in the documentation shows the HTTP method and the relative path. Depending on the stage of your implementation, the base path may be different. Requests should be sent to the correct URLs. Sandbox URL For the sandbox, prepend the Beta URL: https://crossborder.beta.corpay.com GET https://crossborder.beta.corpay.com/api/{clientCode}/0/benes/{beneID} Valid REST URL Curly braces indicate placeholders for values you must provide. For example, replace {clientCode} with your actual client code. After adding the base path, client code, and the required parameters, the URL looks like this: GET https://crossborder.beta.corpay.com/api/888000/0/benes/johndoe12
  • [Error Codes](https://developer.crossborder.corpay.com/apidocscrossborder/introduction/error-codes.md): Corpay Cross-Border APIs use standard HTTP status codes and validation messages to indicate why a request failed. Error responses help you identify invalid input, missing information, authentication issues, or business rule validation failures. When an API request cannot be completed, the Corpay API returns an error response that identifies why the request failed. Review the error message returned in the response to determine the cause of the failure and update your request before retrying. Error responses generally fall into one of the following categories (see status code table): Category Description Authentication Authentication or authorization failed. Validation One or more request fields are missing, invalid, or incorrectly formatted. Business Rules The request is valid but cannot be processed because it does not match a business or regulatory rule. Resource The requested resource could not be found. Processing The request could not be completed due to a temporary system or processing error. This section describes some of the common error responses you may come across. Error Description Example <RESOURCE>NOTFOUND The specified beneficiary could not be found. RESOLUTION: Verify the beneficiary ID BENENOTFOUND_BENEID INVALID <FIELD> Values passed are not supported RESOLUTION: Use supported values INVALID ROUTING CODE PERMISSION_* The authenticated user does not have permission to make the request. RESOLUTION: Contact your Corpay account representative PERMISSION_DENIED <FIELD>_NOT_IN_VALUESET The value provided for the paymentMethods field is not in the set of valid values or is not supported. RESOLUTION: Pass the supported payment method PAYMENTMETHODS_NOT_IN_VALUESET QUOTE_EXPIRED The exchange quote has expired and cannot be used to book a transaction. RESOLUTION: Request a new quote and use it to book the transaction. QUOTE_EXPIRED REGEX_MISMATCH The value provided for a field does not match the required format. This commonly occurs for fields such as postal codes, account numbers, routing codes, or other values with specific formatting requirements. RESOLUTION: Verify the value matches the required format for the field before retrying the request. Postal code, account number REQUIRED FIELD MISSING A mandatory field was omitted from the request RESOLUTION: Populate the required field and retry the request. Routing Code, Payee Name
  • [Common Terms](https://developer.crossborder.corpay.com/apidocscrossborder/introduction/common-terms-1.md): API Concepts Corpay APIs follow REST principles and return JSON responses. API responses include standard HTTP status codes and structured error messages to help you identify validation, authentication, and processing issues. The API also follows the HATEOAS (Hypertext As The Engine Of Application State) principle. Every response includes a self link to the current resource and, where applicable, links to related operations. JSON { "content": {}, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/{clientCode}/0/templates/{}", "method": "GET" }, { "rel": "UPDATE_BENEFICIARY", "uri": "https://crossborder.corpay.com/api/{clientCode}/0/benes/{}", "method": "PUT" } ] } What is self link? The self link is a standard REST and HATEOAS concept. Instead of constructing URLs manually, you can use the self link in the response to retrieve the same resource. What is an action link? In addition to the self link, each response includes links to related actions that can be performed based on the current state of the resource. This makes your integrations more resilient to future API changes by relying on links returned in the API rather than hard-coded endpoint URLs. For example, a beneficiary response may include links to retrieve, update, or perform other actions on that beneficiary. Key identifiers and concepts used across Corpay Cross-Border API documentation. Term Description Beneficiary The recipient of a payment. Also referred to as a payee. Beneficiary ID Internal beneficiary identifier Client Code A unique 6-digit client identifier for each client account. Used in all endpoints as part of the URL Client Token Access token used to authorize client-specific API requests IBAN International Bank Account Number. The standard numbering system used internationally to identify bank accounts. ISO Country/Currency Code Internationally recognized three-letter country/currency codes Multi-Currency Account (MCA) Multi-Currency Accounts (Formerly known as FXBalance/CLIAB) Partner ID Links multiple client accounts together. Used during the authentication procedure Partner Token Access token used to authenticate partner-level requests SWIFT Society for Worldwide Interbank Financial Telecommunications. A dedicated network that is designed to support financial messages between its member banks worldwide. Settlement Account The account used to fund payments Tracker ID The unique tracker identifier assigned to a payment transaction
• [Authentication](https://developer.crossborder.corpay.com/apidocscrossborder/authentication.md): Corpay uses a token-based authentication flow. In most integrations, you first obtain a partner-level token, then use that to generate the client-level access token required for API calls. Corpay Cross-Border API uses the OAuth2.0 standard authorization framework, with a two-step authentication flow. Authentication is performed by exchanging an HS256-signed JSON Web Token (JWT) for a CMG-AccessToken , which is included in the header of subsequent API requests. Authentication Flow The authentication process consists of two steps: Partner Authentication – Exchange a signed JWT for a Partner access token. Client Authentication – Use the Partner access token to request a Client access token for the client you want to access. Create a JWT using the following claims: Claim Description iss Issuer . Identifies the Partner or Client making the authentication request. aud Audience for the token. Must be set to cambridgefx . iat Issued-at Unix timestamp indicating when the JWT was issued. exp Expiration Unix timestamp indicating when the JWT expires. We recommend setting this approximately 20 minutes after iat . The partner-level and the client-level work in the following way: Set the iss claim to the applicable Partner or Client identifier and sign an encoded JWT token (hashed via HS256). Send the encoded JWT in the assertion field of the authentication request. A successful response returns an access_code . Include this value in the CMG-AccessToken header when making the subsequent (Client-Level) requests. Partner-level authentication returns the access code required for Client-level authentication. Client-level authentication returns the access code used to authorize subsequent client-level API requests. If authentication fails, check the following: Your credentials are valid for the correct environment. Your client and partner IDs match the account you are using. The token has not expired. The request includes the required headers.
  • [Partner-level Token Login](https://developer.crossborder.corpay.com/apidocscrossborder/authentication/partner-level-token-login.md): Use this endpoint to authenticate the Partner and obtain the access token required for Client-level authentication. Do not include the CMG-AccessToken header in this request. Partner-level authentication is the first step in the authentication flow, so an access token has not yet been generated. Sample payload for the JWT token generation: JSON { "iss": "test", "iat": 1480103915, "exp": 1480105116, "aud": "cambridgefx", "sub": "" } You can use this sample JWT generator link to generate a token. The JWT is valid only between the issued-at ( iat ) and expiration ( exp ) timestamps. Both values must be provided as Unix timestamps, and the current time must fall within this validity period. A successful request returns the access_code for the authenticated client. Pass this access token in the CMG-AccessToken header for Client-level authentication. IMPLEMENTATION NOTES: Algorithm has to be HS256. Assertion must be regenerated as it has an expiry time. Assertion value is an encoded JWT token that contains a security key provided by Corpay. iss (issuer) is the Corpay-provided partner ID. access_code expiry time is indicated by the parameter expires_in (in seconds) in the response body
  • [Client-level Token Login](https://developer.crossborder.corpay.com/apidocscrossborder/authentication/client-level-token-login.md): The authentication on the Client-level is similar to the authentication process at the partner-level. There are two key differences in the JWT construction: Pass the access_code from the Partner Authentication request in the CMG-AccessToken Header in this endpoint . The access_code granted in the response of this endpoint must be passed in the CMG-AccessToken Header of the subsequent calls in the current user session. API user ID is the iss (issuer) in the JWT token. access_code expiry time is indicated by the parameter expires_in (in seconds) in the response body. Expiry of the access_code can accommodate different use cases.
• [Beneficiaries](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries.md): The endpoints in this section are used to create functional beneficiary templates that comply with all country-specific regulatory requirements. Use the Beneficiary APIs to create, validate, update, retrieve, and manage beneficiary records before sending payments. Creating and validating beneficiaries before payment reduces processing delays and helps ensure payment details meet business and banking requirements. Common Workflows: Create a new beneficiary Validate beneficiary details before payment Update beneficiary information Retrieve beneficiary details Delete inactive beneficiaries Search for existing beneficiaries
  • [Beneficiary Rules](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-core/beneficiary-rules.md): The first call, Beneficiary Rules , outlines what is required for the beneficiary template, Create/Edit Bene creates the template, and View Bene allows you to view the template. The URL is a query string that requires the following parameters to obtain all the information needed to create the beneficiary: destinationCountry : ISO2 country code (must match bankCountry for compatibility) bankCountry : ISO2 code for beneficiary bank country bankCurrency : ISO-4217 Currency Code classification : Business or Individual paymentMethods : W - Wire, E - EFT routingCode : Bank routing code country : ISO2 code for beneficiary country ( Optional - include to retrieve valid beneficiary rules) For Canadian Banks, the routingCode must be a 9-digit value combining a 4-digit institution number and the 5-digit transit (branch) number. The API does not return an error if any of the six required parameters are omitted from the request URL. However, missing parameters may result in incomplete or less accurate response data. The provide element in the returned response will list any missing information. If provide is an empty array; no additional data is required.
  • [Create/Edit Bene](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-core/create-edit-bene.md): The clientIntegrationId value is a unique beneficiary ID that you can use in other endpoints. The first time it is provided, it creates a new resource, which is later used to reference that beneficiary. The clientIntegrationId must be unique, as Corpay uses global values in this field. The only characters allowed in the clientIntegrationId are alphanumeric (a-z, A-Z, 0-9), dash (-), underscore (_) The only special characters allowed in the accountHolder name and address fields, and the bank name and address fields are period (.), comma (,), ampersand (&), dash (-) You can use GUID, which has a very low chance of collision, your own hash, or some deterministic prefix to make it unique. Changing the clientIntegrationId creates a new beneficiary template. Tip : Before creating a beneficiary, you can validate the beneficiary details using the POST Beneficiary Validation endpoint without creating a template. Valid region values can be retrieved using the GET Regions endpoint, which returns the id and code . Either value is accepted in the region fields when creating or editing beneficiary templates. Unless otherwise noted, required means that the field is required for ALL beneficiaries, regardless of destination. Some destinations require additional information.
  • [View Bene](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-core/view-bene.md): Provide the clientIntegrationId of an existing beneficiary to retrieve its complete template information. The status field indicates whether the beneficiary is active in the system to send payments. A - Active P - Pending Approval Requests for viewing a deleted beneficiary will return a 404 Not Found response.
  • [Delete Bene](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-core/delete-bene.md): This endpoint permanently deletes a single beneficiary. You cannot delete more than one beneficiary at the same time. Deleted beneficiary cannot be viewed or reactivated.
  • [Search Benes](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-core/search-benes.md): This endpoint retrieves a list of all your bene templates that meet the specified criteria. EMPLOY QUERY STRING To perform a parameterized search, use one or more of the query parameters in the query string: For example: https://crossborder.corpay.com/api/{clientCode}/0/benes?q=Curr:EUR&Status:A Query Parameter Description Example q=Curr The ISO-4217 Currency Code /api/{clientCode}/0/benes?q=Curr:EUR q=PayeeCountryISO The ISO2 Country Code /api/{clientCode}/0/benes?q=PayeeCountryISO:AD q=Methods The method of payment = ['W' or 'E'] W = Wire or E = EFT /api/{clientCode}/0/benes?q=Methods:E q=Status The status of the beneficiary template = ['A' or 'I'] A= Active or I= Inactive /api/{clientCode}/0/benes?q=Status:A
  • [Beneficiary Validation](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-core/beneficiary-validation.md): Use the Beneficiary Validation APIs to validate information needed when creating or updating beneficiaries. Use the Reference APIs to provide the supporting data required to build valid beneficiary requests and present the correct options in your application. IBAN Validation is recommended for use in IBAN-enabled countries, while Bank Search is for countries that do not support IBAN. This endpoint validates the beneficiary data provided in the request body and returns whether the beneficiary information is valid. If valdation is successful, you can use the same payload to create or update a beneficiary. This endpoint performs validation only and does not create or modify a beneficiary. To create or update a beneficiary, use the POST Create/Edit Bene endpoint. Unless otherwise noted, required means that the field is required for ALL beneficiaries, regardless of destination. Some destinations require additional information. Use the GET Beneficiary Rules endpoint to retrieve the complete validation requirements for a specific beneficiary.
  • [Beneficiary Verification (CoP/VoP)](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-verification-cop-vop.md): UK and EU regulators have introduced payee name‑checking requirements to ensure that beneficiary details are correct and exactly match the associated bank account information. The new Bene Create/Edit endpoint integrates Confirmation of Payee (CoP) and Verification of Payee (VoP) checks in our REST API workflows. The updated endpoints in this section apply only to Beneficiary verification checks. Key Updates CoP checks are required for all GBP payments sent to UK banks. This applies to payments processed through FPS , BACs , and CHAPS for both incoming and outgoing payments. VoP checks are required for all EUR payments (Wire and SEPA) initiated by IE division clients and their branches through SEPA CT and SEPA Instant eligible BICs schemes. 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. Download CoP/VoP Beta Test Cases Click here to download and validate your beneficiary integration against supported payee verification scenarios.
    • [Create/Edit Bene Verification (CoP/VoP)](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-verification-cop-vop/create-edit-bene-copy.md): We have introduced a new endpoint to validate the beneficiary account details before a payment is initiated. There is no change to the beneficiary creation API workflow. New endpoint to create or update a beneficiary: /api/{clientCode}/0/ templates-v2 /{clientIntegrationId} How does it work? 1 Validate Template (Optional) Use the new validation endpoint to validate beneficiary data against Corpay template rules and beneficiary verification checks. See Beneficiary Validation Cop/VoP . 2 Submit Request Send a request to create a beneficiary using the new create endpoint shared above. 3 Payee Verification In addition to Corpay's template validation rules, the request is processed through the required verification protocols to validate the beneficiary's registered bank information. 4 Response If there are no errors, the beneficiary is created successfully. 5 Bypass Beneficiary Verification (Optional) If the beneficiary verification fails, the response will include the reason for the failure, a suggested name (if a close match is found), and a unique override key. To bypass that verification error and create the beneficiary, resubmit the request with the override key as a request parameter. Note : If you choose to override the verification , you confirm you wish to proceed at your own risk and accept responsibility for the information provided. Payments sent using incorrect details may be delayed, misdirected, or not recoverable. CoP (Confirmation of Payee): Matching outcomes, including any applicable override, remain valid for 6 months. Within this period, the designated template may proceed without requiring re-verification. VoP (Verification of Payee): Verification is conducted on every request. Any override applied is specific to that request and expires upon completion. A new override must be applied for each subsequent submission using the designated template. Allowed values: clientIntegrationId The clientIntegrationId value is a unique beneficiary ID that you can use in other endpoints. The first time it is provided, it creates a new resource, which is later used to reference that beneficiary. The clientIntegrationId must be unique, as Corpay uses global values in this field. The only characters allowed in the clientIntegrationId are alphanumeric (a-z, A-Z, 0-9), dash (-), underscore (_) The only special characters allowed in the accountHolder name and address fields, and the bank name and address fields are period (.), comma (,), ampersand (&), dash (-) You can use GUID, which has a very low chance of collision, your own hash, or some deterministic prefix to make it unique. Changing the clientIntegrationId creates a new beneficiary template. Tip : Before creating a beneficiary, you can validate the beneficiary details using the updated template validation endpoint without creating a template. Valid region values can be retrieved using the GET Regions endpoint, which returns the id and code . Either value is accepted in the region fields when creating or editing beneficiary templates. The Beneficiary Validation endpoint will only verify In the following table, unless otherwise noted, required means that the field is required for ALL beneficiaries, regardless of destination. Some destinations require additional information.
      • [CoP/VoP Verification Errors](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-verification-cop-vop/create-edit-bene-copy/cop-vop-validation-errors.md): This section provides a list of the verification issues that might be returned in the beneficiary verification response. Client Message Impacted Field Reason Account holder's name does not match the receiving bank’s records. Confirm the account holder's name. Beneficiary Name — Account name is similar but not an exact match with the receiving bank’s records. Confirm the exact account holder name. Beneficiary Name — Receiving bank identifies this as a business account. Update your selection in the template. Beneficiary Classification — Receiving bank identifies this as a personal account. Update your selection in the template. Beneficiary Classification — Business account name is similar but not an exact match with the receiving bank’s records. Confirm the exact business name. Beneficiary Name — Personal account name is similar but not an exact match with the receiving bank’s records. Confirm the exact account name. Beneficiary Name — Cannot verify this account because the account number appears to be invalid. Confirm beneficiary details before saving the template. Account number/ Local account number — Cannot find the customer reference with the receiving bank. Confirm beneficiary details before saving the template. — Invalid Customer reference Cannot verify this account because the account type is not supported. Confirm beneficiary details before saving the template. — Account type not supported for COP Cannot verify the account because the account holder has opted out of verification. Confirm beneficiary details before saving the template. — Opted out of the CoP Scheme Cannot verify the account because it has been switched to another account. Confirm beneficiary details before saving the template. — Account has been switched Cannot verify the account because this sort code is not supported. Confirm beneficiary details before saving the template. Sort Code — Cannot verify the account with the receiving bank. Confirm beneficiary details before saving the template. — Verification check not possible
      • [CoP/VoP FAQs](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-verification-cop-vop/create-edit-bene-copy/cop-vop-faqs.md): Frequently Asked Questions What Changed? A new endpoint that allows UK and EU-based entities to validate that the beneficiary details are correct and exactly match the associated bank account information: POST /api/{clientCode}/0/templates-v2/{clientIntegrationId}. If there are no errors, the beneficiary is created successfully. If the beneficiary verification fails, the response will include the reason for the failure, a suggested name (if a close match is found), and a unique override key. What happens if a beneficiary is created using an override key? When a beneficiary is created with an override key, the verification outcome is manually overridden. Payments associated with that beneficiary bypass Confirmation of Payee (CoP) / Verification of Payee (VoP) checks and are not held for CoP/VoP review. The payment continues through the standard payment processing workflows. If a beneficiary is created using an override key, how likely is the payment to be rejected? When verification is overridden, subsequent payment failures are unlikely to be related to CoP/VoP checks. However, because the beneficiary details are not validated through the standard process, the client is responsible for ensuring their accuracy, including the risk of funds being sent to an unintended recipient. How long are CoP and VoP verification outcomes and overrides valid? CoP : Matching outcomes, including overrides, are valid for 6 months. During this period, the designated template can be reused without re‑verification. VoP : Verification occurs on every request. Overrides apply only to the current request and expire upon completion; a new override is required for each subsequent submission. Editing critical CoP/VoP fields triggers immediate rescreening, even if the original verification has not expired, and may result in a new verification outcome. What happens when a payment is created using a template with an existing CoP/VoP verification status? When a payment is created using a template, the system performs a soft check of the template’s current CoP/VoP verification status. If the status is valid (within its validity period) and marked as a match or override, the payment proceeds through standard payment processing workflows. If the status is invalid , the template is rescreened for CoP/VoP before the payment can proceed. If the verification fails, clients must update or override the result before the payment can proceed. More resources available here: Account Verification Client FAQs
    • [Beneficiary Validation CoP/VoP](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/beneficiary-verification-cop-vop/beneficiary-validation-copy.md): Use the validation endpoint to validate the beneficiary data submitted in the request body against Corpay template rules and beneficiary verification checks. If successful, you can use this payload to successfully create a beneficiary. New endpoint to validate beneficiary template: /api/{clientCode}/0/ templates-validate-v2 /{clientIntegrationId} This endpoint will only validate the beneficiary information without creating a new template. To create a new beneficiary template, use the Create/Edit Beneficiary endpoint. If the beneficiary validation fails due to beneficiary verification errors, the response will include the error details and a unique override key. To bypass that verification error and validate the template, resubmit the request with the override key as a request parameter. How does it work? 1 Validate Template Use the new validation endpoint to validate beneficiary data against Corpay template rules and beneficiary verification checks. 3 Payee Verification In addition to Corpay's template validation rules, the request is processed through the required verification protocols to validate the payee's registered bank information. 4 Response If there are no errors, the beneficiary validation is successfully validated. 5 Bypass Beneficiary Verification (Optional) If the beneficiary template validation fails due to verification errors, the response will include the error details and a unique override key. To bypass that verification error and validate the beneficiary template, resubmit the request with the override key as a request parameter. The override key returned in the validation response should not be used to bypass and create a beneficiary; it is unique for template validation only. Note : If you choose to override the validation , you confirm you wish to proceed at your own risk and accept responsibility for the information provided. Payments sent using incorrect details may be delayed, misdirected, or not recoverable. In the following table, unless otherwise noted, required means that the field is required for ALL beneficiaries, regardless of destination. Some destinations require additional information.
  • [Remitters](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/remitters-1.md): Use this endpoint to create a remitter that can be associated with one or more payments. Remitters are third parties that initiate payments on behalf of the account holder. The Remitter APIs allow you to create, retrieve, and update remitter information.
    • [Remitter Add/Edit](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/remitters-1/remitter-add-edit.md): Similar to the POST Create/Edit Bene call, the PUT method is used for better error handling due to the idempotency of PUT requests. The URL query string contains the Remitter ID, which must be unique. You can either use GUID , as it has a very low chance of collision, your own hash, or some deterministic prefix in order to make sure it is unique. The only characters allowed in the uniqueRemitterId are alphanumeric (a-zA-Z0-9), dash (-), and underscore (_). Remitter identifiers longer than 34 characters are now automatically truncated when processing the SWIFT MX message.
    • [Remitter Retrieve](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/remitters-1/remitter-retrieve.md): This call retrieves the details of a remitter. **Note:** The URL is the same as `PUT` [Remitter Add/Edit](https://developer.crossborder.corpay.com/apidocscrossborder/remitter/remitter-add-edit), which creates or modifies a remitter, but this is a `GET` call rather than a `PUT`.
  • [Reference APIs](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/reference-apis.md): The Reference APIs provide access to static and configurable data essential for cross-border transactions, such as IBAN validation, currency codes, country information, and purpose of payment. You can retrieve up-to-date reference details to ensure accurate and consistent processing across global payments.
    • [IBAN Validation](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/reference-apis/iban-validation.md): This endpoint validates the IBAN provided in the request body and returns the bank details associated with it. The response includes: IBAN validation status - Indicates whether the IBAN is valid. Bank information - Returns the bank details parsed from the IBAN, where available. This is not contingent on the valid structure of the IBAN. Bank information may still be returned even if the IBAN is invalid.
    • [Bank Search](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/reference-apis/bank-search.md): This call searches a database of global banks and returns banks that match your search criteria. You can search using one or more query parameters, such as the bank name, city, routing code, or other supported bank information. For large result sets, use the optional take and skip query parameters to paginate the response: take – Specifies the maximum number of results to return. skip – Specifies the number of matching results to skip before returning records. Using these parameters is recommended for broad searches to improve performance and reduce response size. Always use the latest values returned by this endpoint to ensure your integration remains aligned with our current API validation rules and supported data formats. Corpay may add or modify values to support regulatory, banking, or product updates. Refer to the Release Notes to stay informed of changes that may impact your integration.
    • [Purpose of Payment](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/reference-apis/purpose-of-payment.md): This endpoint returns the valid Purpose of Payment values for the specified country, currency, and payment method. For Purpose of Payment request fields, you can provide either the id or the text value returned by this endpoint. For countries such as India (INR via EFT), China, and Hong Kong (CNH via Wire), the API returns a custom list of allowed values. For all other countries, it returns the standard Purpose of Payment list. Always use the latest values returned by this endpoint to ensure your integration remains aligned with our current API validation rules and supported data formats. Corpay may add or modify values to support regulatory, banking, or product updates. Refer to the Release Notes to stay informed of changes that may impact your integration.
    • [Regions](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/reference-apis/regions.md): This endpoint returns the valid region values for the specified country. The response includes both the region ID and the region code . When creating or updating a beneficiary, you can use either value in the beneficiary's region field. Always use the latest values returned by this endpoint to ensure your integration remains aligned with our current API validation rules and supported data formats. Corpay may add or modify values to support regulatory, banking, or product updates. Refer to the Release Notes to stay informed of changes that may impact your integration.
    • [Countries](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/reference-apis/countries.md): This endpoint returns the list of supported countries and the default currency associated with each country. Always use the latest values returned by this endpoint to ensure your integration remains aligned with our current API validation rules and supported data formats. Corpay may add or modify values to support regulatory, banking, or product updates. Refer to the Release Notes to stay informed of changes that may impact your integration.
    • [Currencies](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiaries/reference-apis/regions-copy-1.md): This endpoint returns the list of supported currencies. Each response includes the ISO currency code (curr) and a description (desc) containing the currency code and currency name. Always use the latest values returned by this endpoint to ensure your integration remains aligned with our current API validation rules and supported data formats. Corpay may add or modify values to support regulatory, banking, or product updates. Refer to the Release Notes to stay informed of changes that may impact your integration.
• [Payments & FX](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx.md): Use this section to initiate and manage payment and FX workflows, monitor payment status, retrieve transaction details, and support post-trade operations.
  • [Spot Workflow](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/spot-workflow.md): Use the Spot APIs to request FX quotes and book spot transactions. Common workflows: This set of endpoints deals with the exchange of a currency pair and the transfer of that exchanged currency to a beneficiary or a holding balance. The first three endpoints are the key elements of the Spot Workflow: Spot Rate - Retrieve a live FX quote Book Deal - Book the live rate for a Spot transaction Instruct Deal - Instruct the funds to a beneficiary The other endpoints are used to fetch rate and quote information: Lookup Orders - Retrieve order details Rate Resource - Create a Spot Rate resource Quotes _ Retrieve quote details Indicative rate - Get an indicative rate and amount for a Spot transaction
    • [[1] Spot Rate](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/spot-workflow/1-spot-rate.md): This is the first of two calls that are used to book a live rate as part of a Spot transaction. This call creates a temporary resource based on the live exchange rate (between a currency pair). To secure the rate, you must book the deal ( POST Book Deal ). The lockside determines which side of the pair will carry the base amount. As market rates are constantly changing, this quote may expire before you book the deal. By default, the rate expires in 10 seconds. The quote resource is in the response header under Location . This URL is the precursor to executing the POST Book Deal endpoint.
    • [[2] Book Deal](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/spot-workflow/2-book-deal.md): This is the second of two calls that are used to book a live rate as part of a Spot transaction. This call uses the quoteId returned by the POST Spot Rate call to book a deal using the quoted rate. The quote obtained from POST Spot Rate is valid for 10 seconds, after which it expires. If you don't book the deal before the rate expires, the response status will be 400 (Quote expired) , and you will need to generate a new quote.
    • [[3] Instruct Deal](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/spot-workflow/3-instruct-deal.md): Once the Spot Transaction has been booked, you can instruct the funds to a beneficiary or an internal holding balance (this is specified in the payment portion of this payload). The settlement funds (the settlement portion) can come from a bank account or a holding balance. This call also specifies which settlement account to use for fees. In most cases, the account designated for fees contains the base currency (for example, if you are located in Canada, your fee settlement account will be a CAD account). The total instructed amount does not have to equal the amount exchanged during the Spot Transaction, but it cannot exceed that amount. This endpoint supports idempotency through the requestId parameter. If the request is repeated with the same idempotencyKey the endpoint will return the original booking result. If the deal is subject to the Regulation E remittance transfer rule as required by the Dodd-Frank Wall Street Reform and Consumer Protection Act (commonly referred to as Dodd-Frank), and the order includes at least one payment where the remitter classification is Individual , the response will include Reg E payment disclosure information. This is required by U.S. law for electronic funds transfers by individuals.
    • [Indicative Rate](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/spot-workflow/indicative-rate.md): This API returns an indicative rate and amount for a Spot transaction based on a live exchange rate (between a currency pair). The lockside determines which side of the pair will carry the base amount. For example, for a EUR/USD spot deal, if lockside is set to the payment currency (which in this case is EUR), then the quoted amount will be the settlement currency (or USD in this case). This rate is indicative only and may change when you get a quote from POST Spot Rate for booking a deal.
  • [Mass Payments](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/mass-payments.md): The Mass Payment workflow allows you to submit payments to multiple beneficiaries using a single request. The workflow aggregates multiple payment instructions into one API call, simplifying bulk payment processing. The only limitation is the currency-specific account limit of any currency being used for settlement (as defined in your onboarding agreement).
    • [Multiple Payments](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/mass-payments/multiple-payments.md): This is the first of two calls that are used to book multiple payments. You send the payment information in the request, and the response returns the rate information. To secure the rate(s), you must execute the next call, POST Book Multiple Payments , before the rate expires (usually 10 seconds).
    • [Book Multiple Payments](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/mass-payments/book-multiple-payments.md): This is the second of the two calls that are used to book multiple payments. The URL that you need to send can be found in the response to the preceding call - POST Multiple Payments under BOOK_PAYMENT . The quote obtained from POST Multiple Payments is valid for 10 seconds, after which it expires. If you don't book the deal before the rate expires, the response status will be 400 (Quote expired). If that happens, you will need to generate a new quote. The quoteKey and loginSessionId params are contained in the URL, which is a unique feature of this workflow. This endpoint supports idempotency through the loginsessionId parameter. If the request is repeated with the same idempotencyKey the endpoint will not process the new data and book again (loginsessionId is returned in the response in the previous call under BOOK_PAYMENT).
  • [Forwards and Drawdowns](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns.md): Use the Forwards APIs to lock in an exchange rate for payments that will be made on a future date. Use the Drawdown APIs to draw down against the forward to make payments at a future date.
    • [Forwards](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/forwards.md): Forward Contracts are an effective way to hedge against foreign exchange fluctuations by locking in the current FX rate and then settling that rate and amount at a future date. There are two types of forward agreements: Closed Forwards and Open Forwards. A Closed Forward lets you lock in the current exchange rate, and receive foreign currency funds on a specified future date (also known as the maturity date). This type of contract requires you to complete the transaction on the date it expires (the Maturity Date) at the agreed rate of exchange. A Closed Forward is settled in its entirety on the maturity date. With an Open Forward, you also lock in the current exchange rate for a future date value and settlement, but unlike a Closed Forward, you can draw down the funds at any time within the specified period. You do not need to wait until the maturity date. All the drawdowns are processed at the agreed-upon rate. The trade can be settled either in full or in part as long as the full amount has been paid by the maturity date. The following identifiers are created for each completed forward: The ordNum is the alpha-numeric transaction identifier. It is the same as the deal number except that it is prefixed with 'OFD' (i.e. OFD40123456). The forwardId / paymentInstructionId is the numeric forward identifier (i.e. 1386511). The quoteId is the identifier of the forward quote rate resource (i.e. cc2999ba7eb84e19a158a8bf0f21296e). These three endpoints are the key elements of the Forwards workflow. Request Forward Quote Book Forward Quote Complete Order The other two endpoints are optional to get more information: Retrieve Forward Quote Forward Instructions
      • [[1] Request Forward Quote](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/forwards/1-request-forward-quote.md): This endpoint and the following two calls (ordered \[1\] through \[3\]) must be submitted in quick succession within the allotted time (default, but adjustable, 10-second window). This call is the Request for Forward Contract information. If all information is provided correctly, the subsequent call - `GET` [Retrieve Forward Quote](https://developer.crossborder.corpay.com/apidocscrossborder/forwards-and-drawdowns/forwards/retrieve-forward-quote) – will return the quote details.
      • [[2] Book Forward Quote](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/forwards/2-book-forward-quote.md): This is the final of three endpoints that book the rate and amount in question. The URL for this endpoint is found in the Response Body of the previous endpoint as a HATEOAS link. If you don't book the deal before the rate expires, the response status will be '400 (Quote expired)'. If that happens, you will need to generate a new quote. The Response – if successful – includes the `orderNumber`.
      • [[3] Complete Order](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/forwards/3-complete-order.md): This is the final step of the forward process and it completes the order. The URL for this endpoint is found in the Response Body of the previous endpoint as a HATEOAS link.
      • [Retrieve Forward Quote](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/forwards/retrieve-forward-quote.md): This call returns details about the forward quote requested in the previous call `POST` [Request Forward Quote](https://developer.crossborder.corpay.com/apidocscrossborder/forwards-and-drawdowns/forwards/1-request-forward-quote). The URL for this endpoint is found in the Response Body of the previous endpoint as a HATEOAS link. If the content in the Response is empty and the status code is '410 Gone', this means that the quote has expired.
      • [Forward Instructions](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/forwards/forward-instructions.md): This call is used after you book the rate and amount in the forward agreement. The URL for this endpoint is found in the Response Body of the previous endpoint (`POST` [\[3\] Book Forward Quote](https://developer.crossborder.corpay.com/apidocscrossborder/forwards-and-drawdowns/forwards/2-book-forward-quote)) as a HATEOAS link. The URL now contains the `forwardID`, which is different from the `orderNumber` (which is handed in the Response Body).
      • [Forward Guidelines](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/forwards/forward-guidelines.md): This endpoint returns the clauses in the Master Hedging Agreement contract. The Response Body lists the contractual restrictions when creating forwards.
      • [Forwards](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/forwards/forwards.md): This endpoint returns information about all your forwards. It displays forwards that are available now, those that will be available at a future date, and those that are incomplete. You can draw down funds from any of the forwards that have the status 'Available'.
    • [Drawdowns](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/drawdowns.md): The drawdown workflow withdraws or instructs a specified amount from the available balance of the forward contract. This can happen on the 'Maturity' date, or, in the case of an Open forward, this can happen on or after the open date.
      • [Book Drawdown](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/forwards-and-drawdowns/drawdowns/book-drawdown.md): The ‘Book Drawdown’ payload is very similar to the POST Instruct Deal payload. The fee amount must reflect the contractual fee set up for the client. If fees are contractually $0 for this drawdown, then set amount: 0 . If otherwise, set the amount accordingly. This endpoint supports idempotency through the requestId parameter. If the request is repeated with the same idempotencyKey the endpoint will return the original booking result. Top-up of drawdown instruction amounts (when the drawdown amount exceeds the value of the forward contract) is currently not supported on API.
  • [Rate Orders](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/rate-orders.md): Use the Rate Order APIs to create and manage orders that automatically execute a deal when your target exchange rate is reached. A Rate Order is an order to buy or sell currency at a specific rate or better. If the requested target rate becomes available before the order’s expiry date, Corpay automatically books the deal. You can create Rate Orders for spot trades and for forward trades. Important: A Rate Order is not guaranteed to fill. Common Workflows: Create, retrieve, or delete Rate Orders.
    • [Create Rate Order](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/rate-orders/create-rate-order.md): Creates a new Rate Order. You can create Spot Rate Orders and Forward Rate Orders. Forward Rate Orders can be either Closed Forwards or Open Forwards.
    • [View Rate Orders](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/rate-orders/view-rate-orders.md): Retrieves complete information for all of your Rate Orders. See View Rate Order Response section for detailed explanations of the API response fields.
      • [View Rate Order Response](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/rate-orders/view-rate-orders/view-rate-order-response.md)
    • [Delete Rate Order](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/rate-orders/delete-rate-order.md): This endpoint permanently deletes the specified Rate Order. You cannot delete more than one Rate Order at the same time.
  • [Cancellations](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/cancellations-1.md): Use this workflow to cancel a previously booked Spot or Forward transaction. When a cancellation is requested, Corpay creates a reverse transaction that offsets the original trade using the current market rate. For example, cancelling a USD/CAD Spot transaction creates a corresponding CAD/USD transaction. The v2 cancellation workflow consists of three API calls: Create Cancellation Quote - Creates a cancellation quote and returns the cancellation ID. Get Cancellation Quote - Retrieves the offset trade and returns the Book Cancel link with the quote expiry timestamp. Book Cancellation - Books the cancellation using the returned cancellation ID. For new integrations, Corpay recommends using the Cancel Order v2 APIs. No action is required for existing integrations . The current endpoints will continue to be supported and will operate through a compatibility layer until their planned deprecation in Q2 2027. Read here .
    • [[1] Create Cancellation Quote v2](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/cancellations-1/1-create-cancellation-quote-v2.md): To start the cancellation process, you will need to request a cancellation quote using the original Spot/Forward order number . The response contains the link to the GET Cancellation Quote. Once a cancellation quote has been requested, it must be booked before the quote expires (default is 10 seconds ). If the quote expires, request a new cancellation quote. If the client is subject to the Regulation E (Reg E) remittance transfer rule as required by the Dodd-Frank Wall Street Reform and Consumer Protection Act (commonly referred to as Dodd-Frank), the entire order can be cancelled without any charges if the following conditions are met: There is at least one payment instruction in the deal with a remitter whose classification is 'Individual'. The payment is cancelled within 30 minutes of it being booked or instructed. An order can only be cancelled once. If a cancellation request is submitted for an order that has already been cancelled, the API returns a 400 Bad Request response with the error key NOT_CANCELLABLE .
    • [[2] Retrieve Cancellation Quote v2](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/cancellations-1/2-retrieve-cancellation-quote-v2.md): Before calling this endpoint, you must first submit a Request Cancellation request. The response returns the Get Cancellation Quote link with the cancellation ID . You can retrieve the offset transaction details using this endpoint or use the cancellation ID to book the cancellation directly. The response includes POST Book Cancellation API with the quote expiry timestamp. Once a cancellation quote has been requested, it must be booked before the quote expires (default is 10 seconds ). If the quote expires, request a new cancellation quote.
    • [[3] Book Cancellation v2](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/cancellations-1/3-book-cancellation-quote-v2.md): This is the final step of the order cancellation process. The URL for this endpoint is found in the Response Body of the previous GET Cancellation Quote endpoint as a HATEOAS link. Once a cancellation quote has been requested, it must be booked before the quote expires (default is 10 seconds ). If the quote expires, request a new cancellation quote. A successful request returns the deal offset order number . This is a new order number assigned to the cancelled transaction, offsetting the original deal. An order can only be cancelled once. If a cancellation request is submitted for an order that has already been cancelled, the API returns a 400 Bad Request response with the error key NOT_CANCELLABLE . Subscribe to the Payment Events webhooks to receive real-time notifications when a payment is cancelled.
  • [Payment Tracking](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/payment-tracking.md): Use the Payment Tracking APIs to trace the details and status of SWIFT payments after the payment has exited the Corpay bank account and are in transit to the beneficiary’s bank account. Currently, this feature is only available for payments travelling via the SWIFT Network - Wires - (i.e. method is Wire). EFT/iACH payments are not currently supported .
    • [Payment Channel Information](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/payment-tracking/payment-channel-information.md): The confirmation endpoint displays a channel-specific payment confirmation message. To receive a successful response, the payment must be successfully instructed. (status: 200 on POST Instruct Deal ). Rather than ordNum , this endpoint uses the paymentInstructionId in the URL. You can get the paymentInstructionId by using GET Lookup Orders Messages are provided in full only if the payment has exited the Corpay bank account and is en route to the beneficiary's bank account. Therefore, if the number of returned messages is 0, even though the payment has been booked, it just means the funds haven't left the Corpay bank account. The endpoint will return one or more MT103 or pacs 008 messages in the response field when the Method is set to W (Wire) and an MT103/pacs 008 is found for the specified paymentInstructionId. If the Method is set to C (MCA Balance) or E (EFT), the response field will be blank. No other MTxxx messages will be returned. SWIFT MESSAGE FIELDS Title Description Field Name Description :20 Transaction reference number Message number assigned by the sender. :23B Bank operation code Type of operation. :32A Value date, Currency, Interbank settled amount Date format is YYMMDD . Currency is three-letter ISO code. :33B Currency, Original ordered amount Three-letter ISO currency code and amount of instruction. :50A, F, or K Ordering customer (payer) or address of the remitter Customer ordering the transaction. :52A or D Ordering institution Payer's bank. :53A, B, or D Sender's correspondent (bank) Account or branch of sender. :54A, B, or D Receiver's correspondent Branch or FI where funds are available to receiver. :56A, C, or D Intermediary bank FI through which transaction must pass. :59 or 59A Beneficiary customer Recipient of the funds. :57A, B, C, or D Account with institution Beneficiary's account. :70 Remittance information Information about the transaction. :71A Details of charges. Specifies which party is responsible for fees - OUR, SHA, or BEN. :72 Sender to receiver information Additional information for the receiver. :77B Regulatory reporting Regulatory information required by the sender or receiver country.
    • [Payment Tracking Lookup](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/payment-tracking/payment-tracking-lookup.md): This endpoint retrieves the tracker identifier of a specific payment by passing its `paymentInstructionId`. You can get the `paymentInstructionId` by using `POST` [Instruct Deal](https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/post-3-instruct-deal) or `GET` [Lookup Orders](https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/get-lookup-orders).
    • [Payment Tracking](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/payment-tracking/payment-tracking.md): Trace the detailed information of a payment transaction by passing its trackerId . You can get the trackerId by using POST Instruct Deal or GET Lookup Orders or GET Payment Tracking Lookup . Payment Tracking does not currently support exotic currencies. Please contact your account representative for more information. CHARGE AMOUNT AT EACH CORRESPONDENT BANK IS CALCULATED AS: Plain text A. First Event charge_amount = instructed_amount - interbank_settlement_amount B. Corresponding Events charge_amount = interbank_settlement_amount/confirmed_amount (previous event) - interbank_settlement_amount/confirmed_amount (current event) A. First Event charge_amount = instructed_amount - interbank_settlement_amount B. Corresponding Events charge_amount = interbank_settlement_amount/confirmed_amount (previous event) - interbank_settlement_amount/confirmed_amount (current event) NOTE : interbank_settlement_amount and confirmed_amount are the amounts forwarded to the next correspondent bank or credited to the beneficiary. See the Payment Tracking Response section for detailed explanations of the API response fields.
      • [SWIFT Payment Tracking Response](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/payment-tracking/payment-tracking/payment-tracking-response.md): For more information, see the Reference Section CORPAY EVENT TYPE SWIFT MESSAGE NAME IDENTIFICATION SWIFT BUSINESS SERVICE SWIFT TRACKER EVENT TYPE SWIFT TRANSACTION STATUS CODE SWIFT SETTLEMENT METHOD SWIFT CHARGE BEARER TABLE
      • [Reference Section](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/payment-tracking/payment-tracking/reference-section.md): CORPAY PAYMENT EVENT TYPE Title Description Field Description PaymentAccepted Payment is accepted by Corpay PaymentCancelled Payment cancelled by SWIFT UETRCreated Payment sent to SWIFT PaymentProcessed Payment acknowledged by SWIFT PaymentTrackingInfoReceived GPI Event PaymentProcessedNonSwift Payment acknowledged by any Non-SWIFT rail Corpay does not send webhook notifications for all the payment events listed above. For full details on the supported notifications, please refer to the Supported Events section. SWIFT SETTLEMENT METHOD Title Description Title Field Name Description CLRG ClearingSystem Settlement is done through a payment clearing system. COVE CoverMethod Settlement is done through a cover payment. INDA InstructedAgent Settlement is done by the agent instructed to execute a payment instruction. INGA InstructingAgent Settlement is done by the agent instructing and forwarding the payment to the next party in the payment chain. SWIFT TRACKER EVENT TYPE Title Description Title Field Name Description COPT CoverPayment Indicates a cover payment. COSU StatusUpdateCoverPayment Indicates a cover payment status update. CTCA CreditTransferPaymentCancellationRequest Indicates a cancellation request related to a credit transfer payment. CTCR CreditTransferPaymentCancellationResponse Indicates a cancellation response related to a credit transfer payment. CTPT CustomerCreditTransferPayment Indicates a customer credit transfer payment. CTSU StatusUpdateCustomerCreditTransferPayment Indicates a customer credit transfer payment status update. CTTS CreditTransferPaymentCancellationRequest-TrackingStatus Indicates the tracking status of a cancellation request related to a credit transfer payment. FTPT FinancialInstitutionCreditTransferPayment Indicates a Financial Institution Credit Transfer Payment. FTSU StatusUpdateFinancialInstitutionCredit-TransferPayment Indicates a Financial Institution Credit Transfer Payment status update. SWIFT BUSINESS SERVICE Title Description Title Field Name Description 001 gpiCustomerCreditTransferService Indicates the gpi Customer Credit Transfer (CCT) service. 002 gpiStopAndRecallService Indicates the gpi Stop and Recall (SRP) service. 004 gpiFinancialInstitutionCreditTransfer-InstantService Indicates the gpi Financial Institution Credit Transfer service (FIT). 005 gpiCustomerCreditTransferInstantService Indicates the gpi Customer Credit Transfer Instant service (CCT Instant). 009 gpiCustomerCreditTransferSimpleService Indicates the gpi Customer Credit Transfer Simple Service. SWIFT TRANSACTION STATUS CODE Title Description Title Field Name Description ACCC AcceptedCreditSettlementCompleted Settlement on the creditor's account has been completed. ACSP AcceptedSettlementInProcess All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. RJCT Rejected Payment initiation or individual transaction included in the payment initiation has been rejected. SWIFT CHARGE BEARER Title Description Title Field Name Description CRED BorneByCreditor All transaction charges are to be borne by the creditor. DEBT BorneByDebtor All transaction charges are to be borne by the debtor. SHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor. SWIFT TRANSACTION STATUS REASON Title Description Title Field Name Description AC01 IncorrectAccountNumber Account number is invalid or missing AC04 ClosedAccountNumber Account number specified has been closed on the bank of account's books. AC06 BlockedAccount Account specified is blocked, prohibiting posting of transactions against it. AM06 AmountTooLow Below limit. BE01 InconsistentWithEndCustomer Identification of end customer is not consistent with associated account number. (formerly CreditorConsistency). CUST RequestedByCustomer At request of creditor. DUPL Duplication Payment is a duplicate of another payment. FF07 InvalidPurpose Purpose is missing or invalid. FOCR FollowingCancellationRequest Return following a cancellation request. G000 PaymentTransferredAndSLAMaintained The Status Originator transferred the Credit Transfer to the next Agent or to a Market Infrastructure maintaining the transaction's service obligations. G001 PaymentTransferredAndSLANoLongerMaintained The Status Originator transferred the Credit Transfer to the next Agent or to a Market Infrastructure where the transaction's service obligations may no longer be guaranteed. G002 CreditDebitNotConfirmed The transaction processing cannot be completed the same day. G003 CreditPendingDocuments In an FI to FI Customer Credit Transfer: Credit to creditor's account is pending receipt of required documents. The Status Originator has requested creditor to provide additional documentation. G004 CreditPendingFunds Credit to the creditor's account is pending as status Originator is waiting for funds provided via a cover. G007 MIPaymentTransferred The payment of the (gpi) sending MI agent was transferred to the receiving MI agent. G008 MIPaymentTransferredAndReceived The payment of the (gpi) sending MI agent was transferred to and received by the receiving MI agent. MS03 NotSpecifiedReasonAgentGenerated Reason has not been specified by agent. NOAS NoAnswerFromCustomer Failed to contact beneficiary RC01 BankIdentifierIncorrect Bank identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode) RR03 MissingCreditorNameOrAddress Specification of the creditor's name and/ or address needed for regulatory requirements is insufficient or missing. RR05 RegulatoryInformationInvalid Regulatory or Central Bank Reporting information missing, incomplete or invalid. RC08 InvalidClearingSystemMemberIdentifier Routing code not valid for local c learing. SWIFT MESSAGE NAME IDENTIFICATION Title Description Title Field Name Description MT 101 Request for Transfer Requests to debit a customer's account held at the receiver or at another institution. MT 102 Multiple Customer Credit Transfer Conveys multiple payment instructions between financial institutions. MT 102 +(STP) Multiple Customer Credit Transfer (STP) Conveys multiple payment instructions between financial institutions (Straight-Through Processing). MT 103 Single Customer Credit Transfer Instructs a funds transfer. MT 103+(REMIT) Single Customer Credit Transfer (REMIT) Instructs a funds transfer (Straight-Through Processing). MT 103+(STP) Single Customer Credit Transfer (STP) Instructs a funds transfer (Straight-Through Processing). MT 104 Direct Debit and Request for Debit Transfer Message (STP) Conveys direct debit instructions and requests for direct debits between financial institutions (Straight-Through Processing). MT 105 EDIFACT Envelope An envelope which conveys a 2k EDIFACT message. MT 106 EDIFACT Envelope An envelope which conveys a 2k EDIFACT message. MT 107 General Direct Debit Message Conveys direct debit instructions between financial institutions. MT 110 Advice of Cheque(s) Advises or confirms the issuance of a cheque to the drawee bank. MT 111 Request for Stop Payment of a Cheque Requests the drawee bank to stop payment of a cheque. MT 112 Status of a Request for Stop Payment of a Cheque Indicates action(s) taken in attempting to stop payment of a cheque. MT 121 Multiple Interbank Funds Transfer (EDIFACT FINPAY Message) Conveys multiple payment instructions between financial institutions in EDIFACT format. MT 190 Advice of Charges, Interest and Other Adjustments Advises an account owner of charges, interest, and other adjustments. MT 191 Request for Payment of Charges, Interest and Other Expenses Requests payment of charges, interest, or other expenses. MT 192 Request for Cancellation Requests the receiver to consider cancellation of the message identified in the request. MT 195 Queries Requests information relating to a previous message or amendment to a previous message. MT 196 Answers Responds to an MT 195 Query or MT 192 Request for Cancellation or other message where no specific message type has been provided for a response. MT 198 Proprietary Message Contains formats defined and agreed to between users and for those messages not yet live. MT 199 Free Format Message Contains information for which no other message type has been defined.
  • [Transaction Lookup](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/transaction-lookup.md): Use these APIs to look up rates, quote history, and order details.
    • [Lookup Rate](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/transaction-lookup/lookup-rate.md): When you run the POST Spot Rate call, a resource is created that contains the conversion and quote information. This endpoint returns the resource details.
    • [Quote History](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/transaction-lookup/quote-history.md): This call lists all of the GET Get Rate requests after POST Spot Rate in chronological order. Even though the retrieved quotes may not have been booked, they still appear in this list. To view the details of a particular quote, append the quoteId to the URL.
    • [Lookup Orders](https://developer.crossborder.corpay.com/apidocscrossborder/payments-and-fx/transaction-lookup/lookup-orders.md): Allows you to view the following information for a specific order: regEDisclosure - Reg E Disclosure information (if applicable) payments - beneficiary details settlements - settlement details orderDetails - rates, amounts, trade details, etc. If the order is subject to the Regulation E (Reg E) remittance transfer rule as required by the Dodd-Frank Wall Street Reform and Consumer Protection Act (commonly referred to as Dodd-Frank), and the order includes at least one payment where the remitter classification is 'Individual', the response will include Reg E payment disclosure information. This is required by U.S. law for electronic funds transfers by individuals.
• [Settlement & Multi-Currency Accounts](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts.md): This endpoint retrieves settlement account information. Similar to how the beneficiary template creates a record for the beneficiary and bank account to be paid, the settlement account template is for the bank account that is issuing the payment. The Settlement Account template is also known as the Incoming Funds Template. Once complete, these accounts can be used to settle transactions and payments. Accounts created through this workflow are non-Corpay bank accounts. Multi-Currency Accounts (MCA) (previously called FXBalance) or Corpay holding account templates are not created in this same way.
  • [Settlement Templates](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts/settlement-templates.md): This endpoint enables you to view all settlement accounts for this client.
  • [View Multi-Currency Accounts](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts/view-multi-currency-accounts.md): This call returns a list of the Corpay Multi-Currency Accounts (previously called FXBalance) for this client. Multi-Currency Accounts are internal holding balances for currency-specific deposits. They are an alternative settlement option. Multi-Currency Accounts cannot be created through the API. They are set up using a back-office process.
  • [Multi-Currency Accounts History](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts/multi-currency-accounts-history.md): This call returns the transaction history of the specified Corpay Multi-Currency Account (previously called FXBalance). #### RESPONSE BODY
  • [Incoming Funds](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts/incoming-funds.md): This endpoint returns details of incoming funds for both Standard and Named MCAs, including funds directed to any downstream client Multi-Currency Accounts. The GET Incoming Funds v1 endpoint will be deprecated on January 15, 2027 . Clients must migrate to the new endpoint, GET Incoming Funds v2, before this date.
  • [Manage Multi-Currency Accounts Nickname](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts/manage-multi-currency-accounts-nickname.md): The endpoints in this section are used to manage Multi-Currency Account nickname.
    • [Assign/Edit Multi-Currency Account Nickname](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts/manage-multi-currency-accounts-nickname/assign-edit-multi-currency-account-nickname.md): This endpoint enables you to assign or update the nickname for a Multi-Currency Account. The `glNumber` in the request refers to the account number, which can be retrieved from the [View Multi-Currency Accounts](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/view-multi-currency-accounts) endpoint response.
    • [Multi-Currency Account Nickname](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts/manage-multi-currency-accounts-nickname/multi-currency-account-nickname.md): This endpoint retrieves the account name details and the `nickname` (if any). The `glNumber` in the request refers to the account number, which can be retrieved from the [View Multi-Currency Accounts](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/view-multi-currency-accounts) endpoint response.
    • [Reset Multi-Currency Account Nickname](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-and-multi-currency-accounts/manage-multi-currency-accounts-nickname/reset-multi-currency-account-nickname.md): This endpoint resets the account nickname to the original name, removing any previously assigned nickname. The glNumber in the request refers to the account number, which can be retrieved from the View Multi-Currency Accounts endpoint response.
• [Webhooks](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks.md): Webhooks let you subscribe to events and receive real-time notifications when those events occur in your Corpay account. Use webhooks when you need Corpay to notify your system of an event instead of polling for updates. How do Webhooks work? 1 Register your Webhook URL Provide a public, secure URL where your system can receive webhook notifications. 2 Subscribe to Events Enable events for your account (e.g., payment processed, client onboarded, etc.). 3 Event Occurs An event you've subscribed to occurs in the Corpay system. 4 Webhook Notification Sent Corpay sends an HTTP POST request with the event details to your registered webhook URL. 5 Process the Payload Use the received webhook notifications to monitor specific events and sync the updates. Sample Payload JSON { "EventType": "PaymentAccepted", "CreatedDate": "2023-03-30T11:04:59.846784-04:00", "ClientCode": "{clientCode}", "Id": "{clientCode}-P5MBEP", "MessageId": "d2fa6482-c4c3-4a7a-9957-73ca1931143d" } When to use? Use REST APIs when you need to query data on demand. Use Webhooks when you need to be notified immediately when an event occurs to avoid constant polling. Example : Tracking a payment Without Webhooks : You would need to poll GET /api/payment-tracking/{trackerId} repeatedly. With Webhooks : Subscribe to events like PaymentProcessed or PaymentOnHold . Corpay will automatically send a POST request to your webhook endpoint when the event occurs. Webhooks Security - Signature verification To ensure secure communication, each webhook request includes a digital Corpay-Signature in the Headers. You can use this signature to authenticate the payload and prevent man-in-the-middle (MITM) attacks. The header includes a Unix timestamp with an encrypted key in SHA1 cryptographic hash format, created using HMAC. You can verify the authenticity of the notification by decrypting this header with HMAC to confirm if it matches the key (shared during implementation). Request Body Request Header JSON { "EventType": "PaymentProcessed", "CreatedDate": "2023-03-30T12:01:20.9526609-04:00", "ClientCode": "220829", "Id": "{clientCode}-P5MBEP", "MessageId": "4c3319ea-9986-4140-bcd4-c397a17bc669" } JSON Corpay-Signature: t=1680192080,v1=8dd6434ab8d1efe8c04f2854f856eac5780d7dfc Content-Type: application/json Verify v1 to authenticate the payload. The encryption method for v1 will be shared with you during implementation. Please contact your account representative for instructions to decrypt or validate your signature.
  • [Subscribe to Webhooks](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/subscribe-to-webhooks.md): Use this section to create and manage webhook subscriptions that enable your application to receive real-time notifications about key events in your Corpay account. By registering your webhook URL and subscribing to supported events, you can automate workflows and stay informed of transaction updates, payment statuses, and other critical activities. 1 Create your webhook endpoint Set up a publicly accessible HTTPS URL on your server. Ensure it returns a 2xx HTTP status code to acknowledge receipt. 2 Register with Corpay Contact your account representative and provide your webhook URL. 3 Subscribe to events supported events 4 Test and Deploy For BETA testing, HTTP URLs are allowed For Production, HTTPS is mandatory. 5 Enable on Production Once verified, enable your public HTTPS URL webhook endpoint in production. Register your URL with Corpay. Any updates to the registered URL must be informed to your account representative to continue receiving notifications. Always test your webhook in the Beta environment before enabling it in Production to ensure it correctly handles notifications.
  • [Receive Webhooks Notifications](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/receive-webhooks-notifications.md): Acknowledgement Receipt Your server must respond with a 2xx HTTP status code. If Corpay does not get a 2xx response, it will be logged as an error, and the system will attempt a retry, according to the retry logic described below. Retry Logic Webhooks can fail if your endpoint is unavailable, returns an error response, or takes too long to respond. If webhook notifications repeatedly fail: Corpay will retry for up to 24 hours using exponential backoff (instead of retrying immediately, the system waits longer between retries). If all retries fail within 24 hours, the webhook is automatically disabled . To reactivate the notifications, please contact your account representative.
  • [Troubleshoot Notifications](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/troubleshoot-notifications.md): If you’re not receiving notifications, check for: Endpoint not publicly accessible Non-2xx HTTP responses Slow response times causing timeouts Incorrect event subscriptions Signature validation failure Notifications may be manually disabled by your account representative Contact your account representative to manage subscriptions or reactivate disabled webhooks.
  • [Supported Event Types](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/supported-event-types.md): Corpay sends webhook notifications for the following events: Title Description Title Request Event Status Payment GPS PaymentAccepted, PaymentProcessed, PaymentTrackingInfoReceived, PaymentCancelled, PaymentReturned, PaymentCancelledByClient, PaymentProcessedNonSwift Active Client Onboarding AccountApproved Active Incoming Funds Credited to Multi-Currency Account IncomingFundsCredited Active Exceptions PaymentOnHold Active
    • [Payment Events](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/supported-event-types/payment-events.md): Corpay sends push notifications for the following events: Title Description Event Description PaymentAccepted Sent when Corpay accepts the payment. PaymentCancelled Sent when the network cancels the payment. PaymentCancelledByClient Sent when the client cancels the payment via the Cancel API . PaymentReturned Sent when the payment is returned to the client. PaymentProcessed Sent when SWIFT acknowledges the payment. PaymentTrackingInfoReceived Sent when the payment moves within the SWIFT ecosystem. PaymentProcessedNonSwift Sent when a Non-SWIFT channel acknowledges the payment. Note : If the payment is processed via a Non-SWIFT channel, notifications will not be sent for PaymentProcessed or PaymentTrackingInfoReceived events. You can also send a request to /api/payment-tracking/{trackerId} to trace the detailed information of your payment transaction. Example webhook endpoint POST https://partner.webhook.site/
    • [Client Onboarding Events](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/supported-event-types/client-onboarding-events.md): Corpay sends push notifications for the following onboarding event: Title Description Event Description AccountApproved Sent when the onboarding request is approved and the secret key is generated. Example webhook endpoint POST https://partner.webhook.site/{}
    • [Incoming Funds Events](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/supported-event-types/incoming-funds-events.md): Corpay sends incoming funds notifications for the following event: Title Description Event Description IncomingFundsCredited Sent when incoming funds are credited to the Multi-Currency Account (MCA) or linked (child) MCA. You can also send a request to GET incoming-funds-v2/{ordNum} to trace detailed information about your incoming funds. Example webhook endpoint POST https://partner.webhook.site/{}
    • [Exceptions Events](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/supported-event-types/exceptions-events.md): Corpay sends notifications for the following exception event: Title Description Event Description PaymentOnHold Sent when payment is on hold at Corpay. Example webhook endpoint POST https://partner.webhook.site/{}
• [Client Onboarding](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding.md): The client onboarding API allows our integrated partners to expedite the onboarding process of their downstream clients. Partners submit the client onboarding data, upload the required verification documents, and generate the auth key. Once the authentication key is generated, the client gains access to Corpay's API. Get Started . Use the Client Onboarding APIs to submit onboarding information, upload required documentation, and monitor onboarding progress.
  • [Onboard Client](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client.md): Partner Onboarding Workflow 1 Submit Client Onboarding Data Onboard a client via the client onboarding request. Upon successful submission of data, a unique clientOnboardingId is generated. 2 Upload Verification Documents Submit the required verification documents for the approved onboarded client through the document submission request. This is a mandatory requirement to complete the client onboarding process. 3 Generate Authentication Key Once the onboarding request is approved, generate auth keys via the AuthSecret Keys request. This key enables your downstream client to securely access Corpay’s API suite based on assigned permissions. 4 Track Status Optionally, subscribe to the Client Onboarding Webhook to receive real-time notifications when the onboarding request is approved and the secret key is generated. You cannot onboard duplicate client profiles.
    • [Client Onboarding](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/client-onboarding.md): Allows partners to submit a client onboarding request using the required data points. If successful, returns a unique client onboarding identifier clientOnboardingId and the subsequent ONBOARDING_ADD_FILES API to submit supporting documents. Field requirements vary by regulatory region. Refer to individual field descriptions for mandatory fields. For an overview of the required fields, see Onboarding Parameters Reference . The customer’s registered country determines the applicable regulatory region. Please reach out to your account representative if a customer cannot be onboarded under any regulatory region. Customer Country Applicable Regulatory Region CA - Canada CA US - United States US UK - United Kingdom UK AU - Australia AU NZ - New Zealand NZ SG - Singapore SG Ireland + EEA countries EU Refer to Onboarding Picklists for allowed values.
      • [Onboarding Parameters Reference](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/client-onboarding/onboarding-parameters-reference.md): Region-specific mandatory onboarding fields are listed below. To see the full payload, refer to Client Onboarding . Ireland + branches includes all EEA countries Company Details Field Required In Optional In CompanyName Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches DBAOrRegisteredTradeName United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Canada , United States CompanyStreetAddress Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches CompanyCity Canada, United States, Singapore United Kingdom, Australia, New Zealand, Ireland + branches CompanyState Canada, United States United Kingdom, Australia, New Zealand, Singapore, Ireland + branches CompanyPostalCode Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches CompanyCountryCode Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Business Details Field Required In Optional In BusinessContactNumber Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches BusinessAlternativePhoneNumber Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches BusinessConfirmationEmail Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches BusinessConfirmationEmail2 Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsPubliclyTraded Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches StockSymbol Canada (if IsPubliclyTraded is true ) United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches FormationIncorporationCountryCode Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches FormationIncorporationState Canada, United States, United Kingdom, Australia, New Zealand, Singapore Ireland + branches DateOfIncorporation United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Canada, United States BusinessRegistrationIncorporationNumber Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches TaxIDEINNumber Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches NatureOfBusiness Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches DirectDebitAuthorization Canada United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches ApplicantTypeId Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches BusinessTypeId Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches WebsiteUrl Recommended when available Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Owned By Field Required In Optional In OwnedByOtherCorporateEntity Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches OwnedByPubliclyTradedCompany Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches OwnedByPubliclyTradedCompanyStockSymbol Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Fund Details Field Required In Optional In PurposeOfTransactionId Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches CurrencyNeeded Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches TradeVolume Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches AnnualVolume Singapore,Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand NumberOfMonthlyTransaction Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches FundSourceCountries Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches FundDestinationCountries Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches PoliticallyExposedPerson Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches NameTitlePositionHeld Canada ( if PoliticallyExposedPerson is true ) United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Registered /Trading Business Details Field Required In Optional In IsRegisteredBusinessAddressSameAsTrading Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches FullTradingAddress Required if the registered address and trading address differ Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches CityTown Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches PostCode Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Country Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches OtherBusinessLegalStructure Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches OtherSourceOfFunds Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches OtherSourceOfWealth Singapore Canada, United States, United Kingdom, Australia, New Zealand, Ireland + branches AnnualTurnoverInEUR Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand AnyBeneficialOwnersHoldUSCitizenship Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches NoOfEmployees Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand Additional Information Field Required In Optional In IsClientCharitableOrganization Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsClientDealerInStonesPreciousMetals Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsClientHighValueDealer Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsClientNetworkMarketingCompany Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsClientRealEstateCompany Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsClientTravelOrTourCompany Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsClientCannabisRelatedCompany Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsClientCryptoCompany Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IsClientMSBFI Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches ClientIntendsToUseCorpayAccountTo Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches ExpectedFrequencyOfTransactions Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Settlement Account Details Field Required In Optional In AccountNumber Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Routing Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches RoutingNo Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches CurrencyOfAccount Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SettlementMethod Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SourceOfFunds Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SourceOfWealth Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand Company Directors Up to 6 entries can be provided in the array Field Required In Optional In FullName Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches JobTitle Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Occupation Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches FormerName (if applicable) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Alias (if applicable) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches NationalityCitizenship Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches PreviousOtherNationalityHeld Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches DateOfBirth Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IdentificationType Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IdentificationNo Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches CompleteResidentialAddress Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SSN (US citizens) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Email Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches TelephoneNo Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches AnyIndividualOwn25PercentOrMore Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Beneficial Owners Up to 4 entries can be provided in the array Field Required In Optional In FullName Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Nationality Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SSN (US Citizens) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches ResidentialAddress Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches OwnershipPercentage Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches FormerName (if applicable) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Alias (if applicable) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches PreviousOtherNationalityHeld Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches DateOfBirth Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IdentificationType Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IdentificationNo Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IdentificationExpiryDate Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches JurisdictionWhereIssued Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Email Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches TelephoneNo Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches PositionOrOccupation Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Authorized User Up to 3 entries can be provided in the array Field Required In Optional In FullName Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand Occupation Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand Nationality Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand Email Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand TitlePosition Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand DateOfBirth Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand ResidentialAddress Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand PhoneNo Singapore, Ireland + branches Canada, United States, United Kingdom, Australia, New Zealand Authorized Signatory Up to 2 entries can be provided in the array Field Required In Optional In FormerName (if applicable) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Alias (if applicable) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches NationalityCitizenship Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches PrevNationality Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IdentificationType Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IdNo Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches IdentificationExpiryDate Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches JurisdictionWhereIssued Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SSN (US Citizens) Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches TelephoneNo Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Company Secretary Only 1 entry can be provided in the array Field Required In Optional In FullLegalName Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Position Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Agree to Terms & Conditions Field Required In Optional In AgreeToTermsAndConditions Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches AuthorizedToBindClientToAgreement Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches ConsentToPrivacyNotice Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches ProvideTruthfulInformation Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches Signer Information Field Required In Optional In SignerFullName Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SignerCompleteResidentialAddress Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SignerDateOfBirth Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SignerDateSigned Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SignerEmail Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SignerJobTitle Canada, United States, United Kingdom, Australia, New Zealand, Singapore, Ireland + branches SecondSignerFullName Australia Canada, United States, United Kingdom, New Zealand, Singapore, Ireland + branches SecondSignerDateOfBirth Australia Canada, United States, United Kingdom, New Zealand, Singapore, Ireland + branches SecondSignerJobTitle Australia Canada, United States, United Kingdom, New Zealand, Singapore, Ireland + branches SecondSignerEmail Australia Canada, United States, United Kingdom, New Zealand, Singapore, Ireland + branches SecondSignerCompleteResidentialAddress Australia Canada, United States, United Kingdom, New Zealand, Singapore, Ireland + branches
    • [Submit Onboarding Files](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/submit-onboarding-files.md): After you successfully submit the client information, upload the required verification documents (refer to the table below). We recommend waiting 60 seconds before running the request to submit the files. This delay ensures that the system has completed the necessary processing for the onboarding request. If more documents are required, additional file uploads can be made. If you get a 400 Bad Request error when uploading files, please wait a few seconds and retry the request. Ensure that clientOnboardingId is valid, and all file upload criteria are met. For persistent errors, please contact your account representative.
      • [Mandatory Documents Required for Onboarding](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/submit-onboarding-files/mandatory-documents-required-for-onboarding.md): After you successfully submit the client information, upload the required verification documents (refer to the table below). We recommend waiting 60 seconds before running the request to submit the files. This delay ensures that the system has completed the necessary processing for the onboarding request. If more documents are required, additional file uploads can be made. If you get a 400 Bad Request error when uploading files, please wait a few seconds and retry the request. Ensure that clientOnboardingId is valid, and all file upload criteria are met. For persistent errors, please contact your account representative. File Upload Criteria Include the clientOnboardingId in the URL. This ID is returned in the POST /clientonboarding response. Files must be uploaded in binary format. A maximum of 10 files can be uploaded per request, and the total file upload size must not exceed 5 MB. Only PDF, PNG, and JPEG formats are supported. Each document must include a file name in the request. If any of the above criteria are not met, the entire request will be rejected. Mandatory Documents Required for Onboarding For client onboarding requests outside the listed jurisdictions, please contact your account representative. Direct Debit forms are currently collected offline and cannot be submitted via the API. Title Description Title Description Title Country Documents Required Ultimate Beneficiary Ownership (UBO) Notes Special Notes Timeline United States (US) Corpay Direct Debit Form. See Direct Debit Setup Timeline column . 1 business day after Corpay Compliance approval. Canada (CA) • Corpay Direct Debit Form. See Direct Debit Setup Timeline column. • Address verification document dated within 3 months (i.e., Utility bill or bank statement, or tax assessment) • Bank Statement to set up direct debit and act as source of income. • Proof of Ultimate Beneficial Ownership (UBO), e.g., Schedule 50. See UBO Notes column. Acceptable UBO verification includes: (1) Schedule 50 (2) a structure chart certified within the last 3 months by a registered lawyer, accountant, or notary. 1 business day after Corpay Compliance approval. United Kingdom (UK) • Corpay Direct Debit Form. See Direct Debit Setup Timeline column. • Address verification document dated within 3 months (i.e., Utility bill or bank statement, or tax assessment) • Bank Statement to set up direct debit and act as source of income. • Proof of Ultimate Beneficial Ownership (UBO). See UBO Notes column. • Copy of ID and Proof of address dated within 3 months for Signatories, Authorized Users, and UBO if they do not reside in the UK. • Copy of ID and proof of address dated within 3 months for all signatories, authorized users, and ultimate beneficial owners. Acceptable UBO verification includes: (1) a structure chart certified within the last 3 months by a registered lawyer, accountant, or notary. An independent attestation is required from a chartered accountant, lawyer, or notary confirming if any individuals directly or indirectly own 25% or more of the company, including its ultimate parent company. It must include an org chart (dated within 3 months), the certifier’s full name, and license number (e.g., bar license for lawyers). If there are no UBO by shares , provide an email from a listed director appointing an individual as a UBO by control (i.e., the individual(s) in charge of the day-to-day management of the company). ID and proof of address (dated within 3 months) must be provided for the appointed individual. If the board of directors is not visible on Companies House, a Board Resolution or Certified Board of Directors must be provided. 10 - 12 business days after Corpay Compliance approval. European Union (EU) • Corpay Direct Debit Form. See Direct Debit Setup Timeline column. • Address verification document dated within 3 months (i.e., Utility bill or bank statement, or tax assessment) • Bank Statement to set up direct debit and act as source of income. • Proof of Ultimate Beneficial Ownership (UBO). See UBO Notes column. • Copy of ID and proof of address dated within 3 months for all signatories, authorized users, and ultimate beneficial owners. Acceptable UBO verification includes: (1) Official business registry extract, dated within the last 3 months (2) UBO certificate from a government website dated within 12 months, or (3) a structure chart certified within the last 3 months by a registered lawyer, accountant, or notary. If neither a business registry extract nor a UBO certificate is provided, an independent attestation is required from a chartered accountant, lawyer, or notary confirming if any individuals directly or indirectly own 25% or more of the company, including its ultimate parent company. It must include an org chart (dated within 3 months), the certifier’s full name, and license number (e.g., bar license for lawyers). If there are no UBO by shares , provide an email from a listed director appointing an individual as a UBO by control (i.e., the individual(s) in charge of the day-to-day management of the company). ID and proof of address (dated within 3 months) must be provided for the appointed individual. Italy : Provide tax code verification. (e.g., Tessera Sanitaria or electronic ID) for all signatories, authorized users, and ultimate beneficial owners. Spain : • A copy of the passport as ID proof; driver's licenses are not accepted. • Acta de Titularidad or Acta de Manifestaciones is required. • If the signor is not the Administrator, a power of attorney (Power Deed) is also required. If the company is in Jersey: Certified copies of ID and proof of address for Directors, Beneficial Owners, and authorized users are required. 10 - 12 business days after Corpay Compliance approval. Australia (AU) • Corpay Direct Debit Form. See Direct Debit Setup Timeline column. • Address verification document dated within 3 months (i.e., Utility bill or bank statement, or tax assessment) • Bank Statement to set up direct debit and act as source of income. • Proof of Ultimate Beneficial Ownership (UBO)- e.g., Illion Report. See UBO Notes column. • Copy of ID and proof of address dated within 3 months for all signatories, authorized users, and ultimate beneficial owners. Acceptable UBO verification includes: (1) Official business registry extract, dated within the last 3 months - Illion Report (2) UBO certificate from a government website dated within 12 months, or (3) a structure chart certified within the last 3 months by a registered lawyer, accountant, or notary. If neither a business registry extract nor a UBO certificate is provided, an independent attestation is required from a chartered accountant, lawyer, or notary confirming if any individuals directly or indirectly own 25% or more of the company, including its ultimate parent company. It must include an org chart (dated within 3 months), the certifier’s full name, and license number (e.g., bar license for lawyers). Corpay Product Disclosure Statement (PDS), Financial Services Guide (FSG), and Target Market Determination (TMD) sent to the company directors. 1 business day after Corpay Compliance approval. Singapore (SG) • Corpay Direct Debit Form. See Direct Debit Setup Timeline column. • Address verification document dated within 3 months (i.e., Utility bill or bank statement, or tax assessment) • Bank Statement to set up direct debit and act as source of income. • Proof of Ultimate Beneficial Ownership (UBO) - e.g., ACRA report. See UBO Notes column. • Director / Board resolution • Memorandum and Articles of Association • Certified copies of ID and proof of address for Directors, Beneficial Owners, signatories, and authorized users Acceptable UBO verification includes: (1) Official business registry extract, dated within the last 3 months - ACRA Report (2) UBO certificate from a government website dated within 12 months, or (3) a structure chart certified within the last 3 months by a registered lawyer, accountant, or notary. If neither a business registry extract nor a UBO certificate is provided, an independent attestation is required from a chartered accountant, lawyer, or notary confirming if any individuals directly or indirectly own 25% or more of the company, including its ultimate parent company. It must include an org chart (dated within 3 months), the certifier’s full name, and license number (e.g., bar license for lawyers). 3 weeks after Corpay Compliance approval.
    • [AuthSecret Keys](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/authsecret-keys.md): This endpoint returns the secret key for a successfully onboarded client. This secret key is used to authenticate the API requests made by the client and enables access to Corpay’s suite of API services. Each feature is permission-based and can be enabled or restricted per client. Generate Key Provide a valid clientOnboardingId to retrieve the associated client-level Secret Key for a client that has been successfully onboarded and approved. The clientOnboardingId is returned in the POST clientOnboarding response. Subscribe to the Client Onboarding Notification Webhook to receive real-time updates when a client is approved, and their Secret Key is ready. Decrypt the Returned Message The message is encrypted using AES encryption. You can use decrypting tools (e.g., LINQPad 7) to decrypt the response. Please contact your account representative for the decryption script. Run the script. The decrypted response will return your ClientCode, AuthSecret, and the UserName. For example, JSON {"ClientCode":"clientCode","AuthSecret":"5da06ce6461d4411b7aef64ed64dfb2fgdwj_R2xx_-XXXX","UserNames":["DEMO USER"]} {"ClientCode":"clientCode","AuthSecret":"5da06ce6461d4411b7aef64ed64dfb2fgdwj_R2xx_-XXXX","UserNames":["DEMO USER"]}
  • [Reference Data](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data.md): This folder defines picklist values used across the Client Onboarding API . These values help ensure consistency and accuracy when creating or updating onboarding requests. The picklist endpoints are updated periodically to reflect changes in Corpay's business rules and regulatory requirements. We may add new values or modify existing ones as required . Please refer to our API release notes to stay informed of changes.
    • [Onboarding Picklists](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists.md): This endpoint returns a list of valid picklist values for various data fields used in the POST clientOnboarding request. Use the values returned in the picklist response when sending the onboarding request. Referencing these values helps ensure your requests conform to expected formats and pass validation. You can retrieve picklist values for the following fields: AnnualVolumeRange ApplicantType BusinessType ClientIntendsToUseCorpayAccountTo ExpectedFrequencyOfTransactions IdType NatureOfBusiness PurposeOfTransaction Routing SettlementMethod SourceOfFunds SourceOfWealth TotalAssetsOrNetWorth TradeVolumeRange Always use the latest values returned by these endpoints to ensure your integration remains aligned with our current API validation rules and supported data formats. Corpay may add or modify values to support regulatory, banking, or product updates. Refer to the Release Notes to stay informed of changes that may impact your integration.
      • [Annual Volume Range](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/annual-volume-range.md): Retrieve categories for annual transaction volume ranges JSON { "content": { "annualVolumeRangeList": [ { "id": "1", "name": "LessThan25000", "stringValue": "Less than 25000" }, { "id": "2", "name": "TwentyFiveThousandToFiftyThousand", "stringValue": "25,000 – 50,000" }, { "id": "3", "name": "FiftyThousandToSeventyFiveThousand", "stringValue": "50,000 – 75,000" }, { "id": "4", "name": "SeventyFiveToOneHundredThousand", "stringValue": "75,000 – 100,000" }, { "id": "5", "name": "OneHundredToOneHundredFiftyThousand", "stringValue": "100,000 – 150,000" }, { "id": "6", "name": "OneHundredFiftyToTwoHundredThousand", "stringValue": "150,000 – 200,000" }, { "id": "7", "name": "TwoHundredToTwoHundredFiftyThousand", "stringValue": "200,000 – 250,000" }, { "id": "8", "name": "TwoHundredFiftyToThreeHundredThousand", "stringValue": "250,000 – 300,000" }, { "id": "9", "name": "ThreeHundredToFourHundredThousand", "stringValue": "300,000 – 400,000" }, { "id": "10", "name": "FourHundredToFiveHundredThousand", "stringValue": "400,000 – 500,000" }, { "id": "11", "name": "FiveHundredToSevenHundredFiftyThousand", "stringValue": "500,000 – 750,000" }, { "id": "12", "name": "SevenHundredFiftyThousandToOneMillion", "stringValue": "750,000 – 1 million" }, { "id": "13", "name": "OneMillionToTwoMillion", "stringValue": "1 million – 2 million" }, { "id": "14", "name": "TwoMillionToThreeMillion", "stringValue": "2 million – 3 million" }, { "id": "15", "name": "ThreeMillionToFiveMillion", "stringValue": "3 million – 5 million" }, { "id": "16", "name": "FiveMillionToSevenPointFiveMillion", "stringValue": "5 million – 7.5 million" }, { "id": "17", "name": "SevenPointFiveMillionToTenMillion", "stringValue": "7.5 million – 10 million" }, { "id": "18", "name": "GreaterThan10Million", "stringValue": "Greater than 10 Mil" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20AnnualVolumeRange", "method": "GET" } ] } { "content": { "annualVolumeRangeList": [ { "id": "1", "name": "LessThan25000", "stringValue": "Less than 25000" }, { "id": "2", "name": "TwentyFiveThousandToFiftyThousand", "stringValue": "25,000 – 50,000" }, { "id": "3", "name": "FiftyThousandToSeventyFiveThousand", "stringValue": "50,000 – 75,000" }, { "id": "4", "name": "SeventyFiveToOneHundredThousand", "stringValue": "75,000 – 100,000" }, { "id": "5", "name": "OneHundredToOneHundredFiftyThousand", "stringValue": "100,000 – 150,000" }, { "id": "6", "name": "OneHundredFiftyToTwoHundredThousand", "stringValue": "150,000 – 200,000" }, { "id": "7", "name": "TwoHundredToTwoHundredFiftyThousand", "stringValue": "200,000 – 250,000" }, { "id": "8", "name": "TwoHundredFiftyToThreeHundredThousand", "stringValue": "250,000 – 300,000" }, { "id": "9", "name": "ThreeHundredToFourHundredThousand", "stringValue": "300,000 – 400,000" }, { "id": "10", "name": "FourHundredToFiveHundredThousand", "stringValue": "400,000 – 500,000" }, { "id": "11", "name": "FiveHundredToSevenHundredFiftyThousand", "stringValue": "500,000 – 750,000" }, { "id": "12", "name": "SevenHundredFiftyThousandToOneMillion", "stringValue": "750,000 – 1 million" }, { "id": "13", "name": "OneMillionToTwoMillion", "stringValue": "1 million – 2 million" }, { "id": "14", "name": "TwoMillionToThreeMillion", "stringValue": "2 million – 3 million" }, { "id": "15", "name": "ThreeMillionToFiveMillion", "stringValue": "3 million – 5 million" }, { "id": "16", "name": "FiveMillionToSevenPointFiveMillion", "stringValue": "5 million – 7.5 million" }, { "id": "17", "name": "SevenPointFiveMillionToTenMillion", "stringValue": "7.5 million – 10 million" }, { "id": "18", "name": "GreaterThan10Million", "stringValue": "Greater than 10 Mil" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20AnnualVolumeRange", "method": "GET" } ] }
      • [Applicant Type](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/applicant-type.md): Retrieve classifications of applicants. JSON { "content": { "applicantTypeList": [ { "id": "1", "name": "Corporation", "stringValue": "Corporation" }, { "id": "2", "name": "Limited_Liability_Company", "stringValue": "Limited Liability Company" }, { "id": "3", "name": "Partnership", "stringValue": "Partnership" }, { "id": "4", "name": "Unincorporated_Entity", "stringValue": "Unincorporated Entity" }, { "id": "5", "name": "Hybrid_Or_Flexible_Entities", "stringValue": "Hybrid or Flexible Entities (e.g. LLC)" }, { "id": "6", "name": "Non_Profit", "stringValue": "Non Profit" }, { "id": "7", "name": "Financial_Institution", "stringValue": "Financial Institution" }, { "id": "8", "name": "Charitable_Organization", "stringValue": "Charitable Organization" }, { "id": "9", "name": "Sole_Proprietorship_Sole_Trader", "stringValue": "Sole Proprietorship Sole Trader" }, { "id": "10", "name": "Personal_Account", "stringValue": "Personal Account" }, { "id": "11", "name": "Trust", "stringValue": "Trust" }, { "id": "12", "name": "Online_User_Verification", "stringValue": "Online User Verification" }, { "id": "13", "name": "Private_Person_Entity", "stringValue": "Private Person Entity" }, { "id": "14", "name": "Other", "stringValue": "Other" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ApplicantType", "method": "GET" } ] } { "content": { "applicantTypeList": [ { "id": "1", "name": "Corporation", "stringValue": "Corporation" }, { "id": "2", "name": "Limited_Liability_Company", "stringValue": "Limited Liability Company" }, { "id": "3", "name": "Partnership", "stringValue": "Partnership" }, { "id": "4", "name": "Unincorporated_Entity", "stringValue": "Unincorporated Entity" }, { "id": "5", "name": "Hybrid_Or_Flexible_Entities", "stringValue": "Hybrid or Flexible Entities (e.g. LLC)" }, { "id": "6", "name": "Non_Profit", "stringValue": "Non Profit" }, { "id": "7", "name": "Financial_Institution", "stringValue": "Financial Institution" }, { "id": "8", "name": "Charitable_Organization", "stringValue": "Charitable Organization" }, { "id": "9", "name": "Sole_Proprietorship_Sole_Trader", "stringValue": "Sole Proprietorship Sole Trader" }, { "id": "10", "name": "Personal_Account", "stringValue": "Personal Account" }, { "id": "11", "name": "Trust", "stringValue": "Trust" }, { "id": "12", "name": "Online_User_Verification", "stringValue": "Online User Verification" }, { "id": "13", "name": "Private_Person_Entity", "stringValue": "Private Person Entity" }, { "id": "14", "name": "Other", "stringValue": "Other" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ApplicantType", "method": "GET" } ] }
      • [Business Type](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/business-type.md): Retrieve the list of supported business types. JSON { "content": { "businessTypeList": [ { "id": "1", "name": "Call_In", "stringValue": "Call-In" }, { "id": "2", "name": "Cannabis_Related_Business", "stringValue": "Cannabis-Related Business" }, { "id": "3", "name": "Charitable_Organization", "stringValue": "Charitable Organization" }, { "id": "4", "name": "ECommerce_Online_Retail_Businesses", "stringValue": "E-Commerce/ Online Retail Businesses" }, { "id": "5", "name": "Health_Care_Travel_Insurance", "stringValue": "Health Care and Travel Insurance" }, { "id": "6", "name": "Holding_Company", "stringValue": "Holding Company" }, { "id": "7", "name": "Investment_Firm", "stringValue": "Investment Firm" }, { "id": "8", "name": "Law_Firms_Accounting_Firms", "stringValue": "Law Firms/Accounting Firms" }, { "id": "9", "name": "Multi_Level_Marketing_MLMs", "stringValue": "Multi-Level Marketing (MLMs)" }, { "id": "10", "name": "Payment_Processor", "stringValue": "Payment Processor" }, { "id": "11", "name": "Payroll_Processor", "stringValue": "Payroll Processor" }, { "id": "12", "name": "Precious_Metals_High_Value_Dealer", "stringValue": "Precious Metals/ High Value Dealer" }, { "id": "13", "name": "Real_Estate", "stringValue": "Real Estate" }, { "id": "14", "name": "Travel_and_Tour", "stringValue": "Travel and Tour" }, { "id": "15", "name": "Used_Vehicle_Dealer", "stringValue": "(Used) Vehicle Dealer" }, { "id": "16", "name": "Vendor_In_Amazon_Or_Equivalent", "stringValue": "Vendor in Amazon/ Equivalent Website" }, { "id": "17", "name": "Not_Applicable", "stringValue": "Not Applicable" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20BusinessType", "method": "GET" } ] } { "content": { "businessTypeList": [ { "id": "1", "name": "Call_In", "stringValue": "Call-In" }, { "id": "2", "name": "Cannabis_Related_Business", "stringValue": "Cannabis-Related Business" }, { "id": "3", "name": "Charitable_Organization", "stringValue": "Charitable Organization" }, { "id": "4", "name": "ECommerce_Online_Retail_Businesses", "stringValue": "E-Commerce/ Online Retail Businesses" }, { "id": "5", "name": "Health_Care_Travel_Insurance", "stringValue": "Health Care and Travel Insurance" }, { "id": "6", "name": "Holding_Company", "stringValue": "Holding Company" }, { "id": "7", "name": "Investment_Firm", "stringValue": "Investment Firm" }, { "id": "8", "name": "Law_Firms_Accounting_Firms", "stringValue": "Law Firms/Accounting Firms" }, { "id": "9", "name": "Multi_Level_Marketing_MLMs", "stringValue": "Multi-Level Marketing (MLMs)" }, { "id": "10", "name": "Payment_Processor", "stringValue": "Payment Processor" }, { "id": "11", "name": "Payroll_Processor", "stringValue": "Payroll Processor" }, { "id": "12", "name": "Precious_Metals_High_Value_Dealer", "stringValue": "Precious Metals/ High Value Dealer" }, { "id": "13", "name": "Real_Estate", "stringValue": "Real Estate" }, { "id": "14", "name": "Travel_and_Tour", "stringValue": "Travel and Tour" }, { "id": "15", "name": "Used_Vehicle_Dealer", "stringValue": "(Used) Vehicle Dealer" }, { "id": "16", "name": "Vendor_In_Amazon_Or_Equivalent", "stringValue": "Vendor in Amazon/ Equivalent Website" }, { "id": "17", "name": "Not_Applicable", "stringValue": "Not Applicable" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20BusinessType", "method": "GET" } ] }
      • [Client Intends To Use Corpay Account To](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/client-intends-to-use-corpay-account-to.md): Retrieve values indicating the intended use of the Corpay account for transactions JSON { "content": { "clientIntendsToUseCorpayAccountTo": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "SendPaymentsOnly", "stringValue": "Send payments only" }, { "id": "2", "name": "ReceivePaymentsOnly", "stringValue": "Receive payments only" }, { "id": "3", "name": "Both", "stringValue": "Both" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ClientIntendsToUseCorpayAccountTo", "method": "GET" } ] } { "content": { "clientIntendsToUseCorpayAccountTo": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "SendPaymentsOnly", "stringValue": "Send payments only" }, { "id": "2", "name": "ReceivePaymentsOnly", "stringValue": "Receive payments only" }, { "id": "3", "name": "Both", "stringValue": "Both" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ClientIntendsToUseCorpayAccountTo", "method": "GET" } ] }
      • [Expected Frequency of Transactions](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/expected-frequency-of-transactions.md): Retrieve list of anticipated frequency of transactions. JSON { "content": { "expectedFrequencyOfTransactions": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "Weekly", "stringValue": "Weekly" }, { "id": "2", "name": "Monthly", "stringValue": "Monthly" }, { "id": "3", "name": "Quarterly", "stringValue": "Quarterly" }, { "id": "4", "name": "Annually", "stringValue": "Annually" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ExpectedFrequencyofTransactions", "method": "GET" } ] } { "content": { "expectedFrequencyOfTransactions": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "Weekly", "stringValue": "Weekly" }, { "id": "2", "name": "Monthly", "stringValue": "Monthly" }, { "id": "3", "name": "Quarterly", "stringValue": "Quarterly" }, { "id": "4", "name": "Annually", "stringValue": "Annually" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ExpectedFrequencyofTransactions", "method": "GET" } ] }
      • [Id Type](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/id-type.md): Retrieve the list of supported identification types. JSON { "content": { "idType": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "BirthCertificate", "stringValue": "Birth Certificate" }, { "id": "2", "name": "CitizenshipCard", "stringValue": "Citizenship Card" }, { "id": "3", "name": "DriversLicense", "stringValue": "Driver's License" }, { "id": "4", "name": "NationalizationCard", "stringValue": "Nationalization Card" }, { "id": "5", "name": "Passport", "stringValue": "Passport" }, { "id": "6", "name": "PhotoIdProofOfAge", "stringValue": "PhotoId / Proof of Age" }, { "id": "7", "name": "Photocard", "stringValue": "Photocard" }, { "id": "8", "name": "StateIdentityCard", "stringValue": "State Identity Card" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20IdType", "method": "GET" } ] } { "content": { "idType": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "BirthCertificate", "stringValue": "Birth Certificate" }, { "id": "2", "name": "CitizenshipCard", "stringValue": "Citizenship Card" }, { "id": "3", "name": "DriversLicense", "stringValue": "Driver's License" }, { "id": "4", "name": "NationalizationCard", "stringValue": "Nationalization Card" }, { "id": "5", "name": "Passport", "stringValue": "Passport" }, { "id": "6", "name": "PhotoIdProofOfAge", "stringValue": "PhotoId / Proof of Age" }, { "id": "7", "name": "Photocard", "stringValue": "Photocard" }, { "id": "8", "name": "StateIdentityCard", "stringValue": "State Identity Card" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20IdType", "method": "GET" } ] }
      • [Nature Of Business](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/nature-of-business.md): Retrieve classification of a business’s primary industry. JSON { "content": { "natureOfBusinessList": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "10", "name": "Aerospace and defense", "stringValue": "Aerospace and defense" }, { "id": "20", "name": "Agriculture and agric-food", "stringValue": "Agriculture and agric-food" }, { "id": "30", "name": "Apparel / Clothing", "stringValue": "Apparel / Clothing" }, { "id": "40", "name": "Automotive / Trucking", "stringValue": "Automotive / Trucking" }, { "id": "50", "name": "Books / Magazines", "stringValue": "Books / Magazines" }, { "id": "60", "name": "Broadcasting", "stringValue": "Broadcasting" }, { "id": "70", "name": "Building products", "stringValue": "Building products" }, { "id": "80", "name": "Chemicals", "stringValue": "Chemicals" }, { "id": "90", "name": "Dairy", "stringValue": "Dairy" }, { "id": "100", "name": "E-business", "stringValue": "E-business" }, { "id": "105", "name": "Educational Institutes", "stringValue": "Educational Institutes" }, { "id": "110", "name": "Environment", "stringValue": "Environment" }, { "id": "120", "name": "Explosives", "stringValue": "Explosives" }, { "id": "140", "name": "Fisheries and oceans", "stringValue": "Fisheries and oceans" }, { "id": "150", "name": "Food / Beverage distribution", "stringValue": "Food / Beverage distribution" }, { "id": "160", "name": "Footwear", "stringValue": "Footwear" }, { "id": "170", "name": "Forest industries", "stringValue": "Forest industries" }, { "id": "180", "name": "Furniture", "stringValue": "Furniture" }, { "id": "190", "name": "Giftware and crafts", "stringValue": "Giftware and crafts" }, { "id": "200", "name": "Horticulture", "stringValue": "Horticulture" }, { "id": "210", "name": "Hydroelectric energy", "stringValue": "Hydroelectric energy" }, { "id": "220", "name": "Information and communication technologies", "stringValue": "Information and communication technologies" }, { "id": "230", "name": "Intelligent systems", "stringValue": "Intelligent systems" }, { "id": "240", "name": "Livestock", "stringValue": "Livestock" }, { "id": "250", "name": "Medical devices", "stringValue": "Medical devices" }, { "id": "251", "name": "Medical treatment", "stringValue": "Medical treatment" }, { "id": "260", "name": "Minerals, metals and mining", "stringValue": "Minerals, metals and mining" }, { "id": "270", "name": "Oil and gas", "stringValue": "Oil and gas" }, { "id": "280", "name": "Pharmaceuticals and biopharmaceuticals", "stringValue": "Pharmaceuticals and biopharmaceuticals" }, { "id": "290", "name": "Plastics", "stringValue": "Plastics" }, { "id": "300", "name": "Poultry and eggs", "stringValue": "Poultry and eggs" }, { "id": "310", "name": "Printing /Publishing", "stringValue": "Printing /Publishing" }, { "id": "320", "name": "Product design and development", "stringValue": "Product design and development" }, { "id": "330", "name": "Railway", "stringValue": "Railway" }, { "id": "340", "name": "Retail", "stringValue": "Retail" }, { "id": "350", "name": "Shipping and industrial marine", "stringValue": "Shipping and industrial marine" }, { "id": "360", "name": "Soil", "stringValue": "Soil" }, { "id": "370", "name": "Sound recording", "stringValue": "Sound recording" }, { "id": "380", "name": "Sporting goods", "stringValue": "Sporting goods" }, { "id": "390", "name": "Telecommunications equipment", "stringValue": "Telecommunications equipment" }, { "id": "400", "name": "Television", "stringValue": "Television" }, { "id": "410", "name": "Textiles", "stringValue": "Textiles" }, { "id": "420", "name": "Tourism", "stringValue": "Tourism" }, { "id": "425", "name": "Trademarks / Law", "stringValue": "Trademarks / Law" }, { "id": "430", "name": "Water supply", "stringValue": "Water supply" }, { "id": "440", "name": "Wholesale", "stringValue": "Wholesale" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://catorapwbq01.cambridgefx.com:45443/api/clientonboarding/onboardingpicklists?pickListType=%20NatureOfBusiness", "method": "GET" } ] } { "content": { "natureOfBusinessList": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "10", "name": "Aerospace and defense", "stringValue": "Aerospace and defense" }, { "id": "20", "name": "Agriculture and agric-food", "stringValue": "Agriculture and agric-food" }, { "id": "30", "name": "Apparel / Clothing", "stringValue": "Apparel / Clothing" }, { "id": "40", "name": "Automotive / Trucking", "stringValue": "Automotive / Trucking" }, { "id": "50", "name": "Books / Magazines", "stringValue": "Books / Magazines" }, { "id": "60", "name": "Broadcasting", "stringValue": "Broadcasting" }, { "id": "70", "name": "Building products", "stringValue": "Building products" }, { "id": "80", "name": "Chemicals", "stringValue": "Chemicals" }, { "id": "90", "name": "Dairy", "stringValue": "Dairy" }, { "id": "100", "name": "E-business", "stringValue": "E-business" }, { "id": "105", "name": "Educational Institutes", "stringValue": "Educational Institutes" }, { "id": "110", "name": "Environment", "stringValue": "Environment" }, { "id": "120", "name": "Explosives", "stringValue": "Explosives" }, { "id": "140", "name": "Fisheries and oceans", "stringValue": "Fisheries and oceans" }, { "id": "150", "name": "Food / Beverage distribution", "stringValue": "Food / Beverage distribution" }, { "id": "160", "name": "Footwear", "stringValue": "Footwear" }, { "id": "170", "name": "Forest industries", "stringValue": "Forest industries" }, { "id": "180", "name": "Furniture", "stringValue": "Furniture" }, { "id": "190", "name": "Giftware and crafts", "stringValue": "Giftware and crafts" }, { "id": "200", "name": "Horticulture", "stringValue": "Horticulture" }, { "id": "210", "name": "Hydroelectric energy", "stringValue": "Hydroelectric energy" }, { "id": "220", "name": "Information and communication technologies", "stringValue": "Information and communication technologies" }, { "id": "230", "name": "Intelligent systems", "stringValue": "Intelligent systems" }, { "id": "240", "name": "Livestock", "stringValue": "Livestock" }, { "id": "250", "name": "Medical devices", "stringValue": "Medical devices" }, { "id": "251", "name": "Medical treatment", "stringValue": "Medical treatment" }, { "id": "260", "name": "Minerals, metals and mining", "stringValue": "Minerals, metals and mining" }, { "id": "270", "name": "Oil and gas", "stringValue": "Oil and gas" }, { "id": "280", "name": "Pharmaceuticals and biopharmaceuticals", "stringValue": "Pharmaceuticals and biopharmaceuticals" }, { "id": "290", "name": "Plastics", "stringValue": "Plastics" }, { "id": "300", "name": "Poultry and eggs", "stringValue": "Poultry and eggs" }, { "id": "310", "name": "Printing /Publishing", "stringValue": "Printing /Publishing" }, { "id": "320", "name": "Product design and development", "stringValue": "Product design and development" }, { "id": "330", "name": "Railway", "stringValue": "Railway" }, { "id": "340", "name": "Retail", "stringValue": "Retail" }, { "id": "350", "name": "Shipping and industrial marine", "stringValue": "Shipping and industrial marine" }, { "id": "360", "name": "Soil", "stringValue": "Soil" }, { "id": "370", "name": "Sound recording", "stringValue": "Sound recording" }, { "id": "380", "name": "Sporting goods", "stringValue": "Sporting goods" }, { "id": "390", "name": "Telecommunications equipment", "stringValue": "Telecommunications equipment" }, { "id": "400", "name": "Television", "stringValue": "Television" }, { "id": "410", "name": "Textiles", "stringValue": "Textiles" }, { "id": "420", "name": "Tourism", "stringValue": "Tourism" }, { "id": "425", "name": "Trademarks / Law", "stringValue": "Trademarks / Law" }, { "id": "430", "name": "Water supply", "stringValue": "Water supply" }, { "id": "440", "name": "Wholesale", "stringValue": "Wholesale" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://catorapwbq01.cambridgefx.com:45443/api/clientonboarding/onboardingpicklists?pickListType=%20NatureOfBusiness", "method": "GET" } ] }
      • [Purpose Of Transaction](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/purpose-of-transaction.md): Retrieve the list of supported payment transaction purposes. JSON { "content": { "purposeOfTransactionList": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "Purchase_Sale_Of_A_Good", "stringValue": "Purchase/Sale of a good(s)" }, { "id": "2", "name": "Sale_Service", "stringValue": "Purchase/Sale of a service(s)" }, { "id": "3", "name": "Fee_Payment", "stringValue": "Professional fees payment (e.g. legal, accountant)" }, { "id": "4", "name": "Payroll_Personnel", "stringValue": "Payroll/personnel payment" }, { "id": "5", "name": "Bill_Payment", "stringValue": "Bill payment" }, { "id": "6", "name": "Resear_Development", "stringValue": "Research and Development" }, { "id": "7", "name": "Business_Venture", "stringValue": "Business venture (e.g. merger, acquisition)" }, { "id": "8", "name": "Intercompany_Payment", "stringValue": "Intercompany payment" }, { "id": "9", "name": "Charitable_Payment", "stringValue": "Charitable and humanitarian related payment" }, { "id": "10", "name": "Real_Estate", "stringValue": "Purchase/Sale of property/real estate" }, { "id": "11", "name": "Government_Payment", "stringValue": "Government related payment (e.g. income tax return)" }, { "id": "12", "name": "Investment_Payment", "stringValue": "Investment related payment" }, { "id": "13", "name": "Other", "stringValue": "Other (please be specific)" }, { "id": "14", "name": "Charity_Donation", "stringValue": "Charity donation" }, { "id": "15", "name": "Divident_Payments", "stringValue": "Dividend payments" }, { "id": "16", "name": "Intercompany_Transfers", "stringValue": "Intercompany transfers" }, { "id": "17", "name": "Investment", "stringValue": "Investment" }, { "id": "18", "name": "Payment_Invoices", "stringValue": "Payment invoices" }, { "id": "19", "name": "Payroll", "stringValue": "Payroll" }, { "id": "20", "name": "Repatriating_Overseas", "stringValue": "Repatriating overseas" }, { "id": "21", "name": "Supplier_Payments", "stringValue": "Supplier payments" }, { "id": "22", "name": "Emigration", "stringValue": "Emigration" }, { "id": "23", "name": "Gift", "stringValue": "Gift" }, { "id": "24", "name": "Inheritance", "stringValue": "Inheritance" }, { "id": "25", "name": "Medical_Expenses", "stringValue": "Medical expenses" }, { "id": "26", "name": "Mortgage_Rental", "stringValue": "Mortgage/Rental Payments" }, { "id": "27", "name": "Overseas_Investment", "stringValue": "Overseas investment" }, { "id": "28", "name": "Overseas_Living", "stringValue": "Overseas living expenses" }, { "id": "29", "name": "Paying_Bills_Overseas", "stringValue": "Paying bills overseas" }, { "id": "30", "name": "Payments_Family_Friends", "stringValue": "Payments to family & Friends" }, { "id": "31", "name": "Pension", "stringValue": "Pension" }, { "id": "32", "name": "Property_Development", "stringValue": "Property Development" }, { "id": "33", "name": "Property_Maintenance", "stringValue": "Property Maintenance" }, { "id": "34", "name": "Property_Purchase", "stringValue": "Property Purchase" }, { "id": "35", "name": "PropertyRental_FeeIncome", "stringValue": "Property Rental/Fee income" }, { "id": "36", "name": "Property_Sale", "stringValue": "Property sale" }, { "id": "37", "name": "Repatriating_Overseas_Earnings", "stringValue": "Repatriating overseas earnings" }, { "id": "38", "name": "Salary", "stringValue": "Salary" }, { "id": "39", "name": "Transfer_Living", "stringValue": "Transfer of living expenses" }, { "id": "40", "name": "Transfer_Family_Friend", "stringValue": "Transfer to family or friend" }, { "id": "41", "name": "Transfer_Own_Account", "stringValue": "Transfer to own account" }, { "id": "42", "name": "Tuition_Fees", "stringValue": "Tuition fees" }, { "id": "43", "name": "Vehicle_Boat", "stringValue": "Vehicle or boat purchase" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20PurposeOfTransaction", "method": "GET" } ] } { "content": { "purposeOfTransactionList": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "Purchase_Sale_Of_A_Good", "stringValue": "Purchase/Sale of a good(s)" }, { "id": "2", "name": "Sale_Service", "stringValue": "Purchase/Sale of a service(s)" }, { "id": "3", "name": "Fee_Payment", "stringValue": "Professional fees payment (e.g. legal, accountant)" }, { "id": "4", "name": "Payroll_Personnel", "stringValue": "Payroll/personnel payment" }, { "id": "5", "name": "Bill_Payment", "stringValue": "Bill payment" }, { "id": "6", "name": "Resear_Development", "stringValue": "Research and Development" }, { "id": "7", "name": "Business_Venture", "stringValue": "Business venture (e.g. merger, acquisition)" }, { "id": "8", "name": "Intercompany_Payment", "stringValue": "Intercompany payment" }, { "id": "9", "name": "Charitable_Payment", "stringValue": "Charitable and humanitarian related payment" }, { "id": "10", "name": "Real_Estate", "stringValue": "Purchase/Sale of property/real estate" }, { "id": "11", "name": "Government_Payment", "stringValue": "Government related payment (e.g. income tax return)" }, { "id": "12", "name": "Investment_Payment", "stringValue": "Investment related payment" }, { "id": "13", "name": "Other", "stringValue": "Other (please be specific)" }, { "id": "14", "name": "Charity_Donation", "stringValue": "Charity donation" }, { "id": "15", "name": "Divident_Payments", "stringValue": "Dividend payments" }, { "id": "16", "name": "Intercompany_Transfers", "stringValue": "Intercompany transfers" }, { "id": "17", "name": "Investment", "stringValue": "Investment" }, { "id": "18", "name": "Payment_Invoices", "stringValue": "Payment invoices" }, { "id": "19", "name": "Payroll", "stringValue": "Payroll" }, { "id": "20", "name": "Repatriating_Overseas", "stringValue": "Repatriating overseas" }, { "id": "21", "name": "Supplier_Payments", "stringValue": "Supplier payments" }, { "id": "22", "name": "Emigration", "stringValue": "Emigration" }, { "id": "23", "name": "Gift", "stringValue": "Gift" }, { "id": "24", "name": "Inheritance", "stringValue": "Inheritance" }, { "id": "25", "name": "Medical_Expenses", "stringValue": "Medical expenses" }, { "id": "26", "name": "Mortgage_Rental", "stringValue": "Mortgage/Rental Payments" }, { "id": "27", "name": "Overseas_Investment", "stringValue": "Overseas investment" }, { "id": "28", "name": "Overseas_Living", "stringValue": "Overseas living expenses" }, { "id": "29", "name": "Paying_Bills_Overseas", "stringValue": "Paying bills overseas" }, { "id": "30", "name": "Payments_Family_Friends", "stringValue": "Payments to family & Friends" }, { "id": "31", "name": "Pension", "stringValue": "Pension" }, { "id": "32", "name": "Property_Development", "stringValue": "Property Development" }, { "id": "33", "name": "Property_Maintenance", "stringValue": "Property Maintenance" }, { "id": "34", "name": "Property_Purchase", "stringValue": "Property Purchase" }, { "id": "35", "name": "PropertyRental_FeeIncome", "stringValue": "Property Rental/Fee income" }, { "id": "36", "name": "Property_Sale", "stringValue": "Property sale" }, { "id": "37", "name": "Repatriating_Overseas_Earnings", "stringValue": "Repatriating overseas earnings" }, { "id": "38", "name": "Salary", "stringValue": "Salary" }, { "id": "39", "name": "Transfer_Living", "stringValue": "Transfer of living expenses" }, { "id": "40", "name": "Transfer_Family_Friend", "stringValue": "Transfer to family or friend" }, { "id": "41", "name": "Transfer_Own_Account", "stringValue": "Transfer to own account" }, { "id": "42", "name": "Tuition_Fees", "stringValue": "Tuition fees" }, { "id": "43", "name": "Vehicle_Boat", "stringValue": "Vehicle or boat purchase" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20PurposeOfTransaction", "method": "GET" } ] }
      • [Routing](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/routing.md): Retrieve the list of available payment routing options. JSON { "content": { "routing": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "Transit", "stringValue": "Transit" }, { "id": "2", "name": "ABA", "stringValue": "ABA" }, { "id": "3", "name": "Fedwire", "stringValue": "Fedwire" }, { "id": "4", "name": "SortCode", "stringValue": "Sort Code" }, { "id": "5", "name": "BSBNumber", "stringValue": "BSB Number" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20Routing", "method": "GET" } ] } { "content": { "routing": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "Transit", "stringValue": "Transit" }, { "id": "2", "name": "ABA", "stringValue": "ABA" }, { "id": "3", "name": "Fedwire", "stringValue": "Fedwire" }, { "id": "4", "name": "SortCode", "stringValue": "Sort Code" }, { "id": "5", "name": "BSBNumber", "stringValue": "BSB Number" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20Routing", "method": "GET" } ] }
      • [Settlement Method](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/settlement-method.md): Retrieve the list of available settlement method options. JSON { "content": { "settlementMethod": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "ACH", "stringValue": "ACH" }, { "id": "2", "name": "Debit", "stringValue": "Debit" }, { "id": "3", "name": "Wire", "stringValue": "Wire" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SettlementMethod", "method": "GET" } ] } { "content": { "settlementMethod": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "ACH", "stringValue": "ACH" }, { "id": "2", "name": "Debit", "stringValue": "Debit" }, { "id": "3", "name": "Wire", "stringValue": "Wire" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SettlementMethod", "method": "GET" } ] }
      • [Source Of Funds](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/source-of-funds.md): Retrieve the source of funds information list. { "content": { "sourceOfFunds": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "BusinessOperations", "stringValue": "Business Operations" }, { "id": "2", "name": "FromShareholders", "stringValue": "From Shareholders" }, { "id": "3", "name": "InvestmentProceeds", "stringValue": "Investment Proceeds" }, { "id": "4", "name": "Others", "stringValue": "Others, please specify" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SourceOfFunds", "method": "GET" } ] } { "content": { "sourceOfFunds": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "BusinessOperations", "stringValue": "Business Operations" }, { "id": "2", "name": "FromShareholders", "stringValue": "From Shareholders" }, { "id": "3", "name": "InvestmentProceeds", "stringValue": "Investment Proceeds" }, { "id": "4", "name": "Others", "stringValue": "Others, please specify" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SourceOfFunds", "method": "GET" } ] }
      • [Source Of Wealth](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/source-of-wealth.md): Retrieve the source of funds information list { "content": { "sourceOfWealth": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "AccumulatedBusinessEarnings", "stringValue": "Accumulated Business Earnings" }, { "id": "2", "name": "FromShareholders", "stringValue": "From Shareholders" }, { "id": "3", "name": "InvestmentPortfolio", "stringValue": "Investment Portfolio" }, { "id": "4", "name": "Others", "stringValue": "Others, please specify" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SourceOfWealth", "method": "GET" } ] } { "content": { "sourceOfWealth": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "AccumulatedBusinessEarnings", "stringValue": "Accumulated Business Earnings" }, { "id": "2", "name": "FromShareholders", "stringValue": "From Shareholders" }, { "id": "3", "name": "InvestmentPortfolio", "stringValue": "Investment Portfolio" }, { "id": "4", "name": "Others", "stringValue": "Others, please specify" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SourceOfWealth", "method": "GET" } ] }
      • [Total Assets or Net Worth](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/total-assets-or-net-worth.md): Retrieve entity’s total assets or net worth range. { "content": { "totalAssetsOrNetWorth": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "OneToOneMillion", "stringValue": "$1 to $1,000,000" }, { "id": "2", "name": "OneMillionOneToTenMillion", "stringValue": "$1,000,001 to $10,000,000" }, { "id": "3", "name": "TenMillionOneToFiftyMillion", "stringValue": "$10,000,001 to $50,000,000" }, { "id": "4", "name": "FiftyMillionOneToOneHundredMillion", "stringValue": "$50,000,001 to $100,000,000" }, { "id": "5", "name": "OtherEstimatedAmount", "stringValue": "Other estimated amount, please specify" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20TotalAssetsorNetWorth", "method": "GET" } ] } { "content": { "totalAssetsOrNetWorth": [ { "id": "0", "name": "Undefined", "stringValue": "Undefined" }, { "id": "1", "name": "OneToOneMillion", "stringValue": "$1 to $1,000,000" }, { "id": "2", "name": "OneMillionOneToTenMillion", "stringValue": "$1,000,001 to $10,000,000" }, { "id": "3", "name": "TenMillionOneToFiftyMillion", "stringValue": "$10,000,001 to $50,000,000" }, { "id": "4", "name": "FiftyMillionOneToOneHundredMillion", "stringValue": "$50,000,001 to $100,000,000" }, { "id": "5", "name": "OtherEstimatedAmount", "stringValue": "Other estimated amount, please specify" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20TotalAssetsorNetWorth", "method": "GET" } ] }
      • [Trade Volume Range](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists/trade-volume-range.md): R etrieve trade volume ranges. JSON { "content": { "tradeVolumeRangeList": [ { "id": "1", "name": "LessThan5000", "stringValue": "less than 5000" }, { "id": "2", "name": "FiveThousandToTenThousand", "stringValue": "5,000 – 10,000" }, { "id": "3", "name": "TenToTwentyFiveThousand", "stringValue": "10,000 – 25,000" }, { "id": "4", "name": "TwentyFiveToFiftyThousand", "stringValue": "25,000 – 50,000" }, { "id": "5", "name": "FiftyToOneHundredThousand", "stringValue": "50,000 – 100,000" }, { "id": "6", "name": "OneHundredToOneHundredFiftyThousand", "stringValue": "100,000 – 150,000" }, { "id": "7", "name": "OneHundredFiftyToTwoHundredFiftyThousand", "stringValue": "150,000 – 250,000" }, { "id": "8", "name": "TwoHundredFiftyToFiveHundredThousand", "stringValue": "250,000 – 500,000" }, { "id": "9", "name": "FiveHundredToSevenHundredFiftyThousand", "stringValue": "500,000 – 750,000" }, { "id": "10", "name": "SevenHundredFiftyThousandToOneMillion", "stringValue": "750,000 – 1 million" }, { "id": "11", "name": "GreaterThanOneMillion", "stringValue": "greater than 1 Mil" } ] }, "errors": [], "links": [ { "rel": "self", "uri": "https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20TradeVolumeRange", "method": "GET" } ] }
• [Legacy APIs](https://developer.crossborder.corpay.com/apidocscrossborder/legacy-api-reference/legacy-apis.md): Use these endpoints to manage and process transactions with backward compatibility while transitioning to newer API versions. Corpay continues to support these legacy APIs. A deprecation notice and date will be provided once the deprecation timeline is confirmed.
  • [Cancel Order](https://developer.crossborder.corpay.com/apidocscrossborder/legacy-api-reference/legacy-apis/cancel-order.md): Use this workflow to cancel a previously booked Spot or Forward transaction. When a cancellation is requested, Corpay creates a reverse transaction that offsets the original trade using the current market rate. For example, cancelling a USD/CAD Spot transaction creates a corresponding CAD/USD transaction. The Request Cancellation and Book Cancellation endpoints have an allotted window of time. Once a cancellation quote has been requested, it must be booked before the quote expires (default is 10 seconds ). If the quote expires, request a new cancellation quote. The cancellation workflow consists of two API calls: Request Cancellation - Retrieves the offset trade and returns the cancellation ID. Book Cancellation - Books the cancellation using the returned cancellation ID. A new version of the Cancel Order API is now available . No action is required for existing integrations. The current API remains fully supported and continues to operate through a compatibility layer. For new integrations, Corpay recommends using the Cancel Order v2 API.
    • [Request Cancellation](https://developer.crossborder.corpay.com/apidocscrossborder/legacy-api-reference/legacy-apis/cancel-order/request-cancellation.md): To use this endpoint, provide the original Spot/Forward order number. The API uses the order number to identify the transaction and automatically retrieves the associated details, including the currencies and amounts. You do not need to provide these values in the request. Unlike the POST Spot Rate endpoint, this request does not generate a new quote. Instead, it uses the exchange rate from the original Spot transaction to create the cancellation request. The response contains the link to the POST Book Cancellation . If the client is subject to the Regulation E (Reg E) remittance transfer rule as required by the Dodd-Frank Wall Street Reform and Consumer Protection Act (commonly referred to as Dodd-Frank), the entire order can be cancelled without any charges if the following conditions are met: There is at least one payment instruction in the deal with a remitter whose classification is 'Individual'. The payment is cancelled within 30 minutes of it being booked or instructed. An order can only be cancelled once. If a cancellation request is submitted for an order that has already been cancelled, the API returns a 400 Bad Request response with the error key NOT_CANCELLABLE .
    • [Book Cancellation](https://developer.crossborder.corpay.com/apidocscrossborder/legacy-api-reference/legacy-apis/cancel-order/book-cancellation.md): Before calling this endpoint, you must first submit a Request Cancellation request. The response includes the Book Cancellation link with the cancellation ID . A successful request returns the deal offset order number . This is a new order number assigned to the cancelled transaction, which offsets the original deal. An order can only be cancelled once. If a cancellation request is submitted for an order that has already been cancelled, the API returns a 400 Bad Request response with the error key NOT_CANCELLABLE . Subscribe to the Payment Events webhooks to receive real-time notifications when a payment is cancelled.
  • [Incoming Funds](https://developer.crossborder.corpay.com/apidocscrossborder/legacy-api-reference/legacy-apis/incoming-funds.md): This call returns details about incoming funds received by a Multi-Currency Account, including funds directed to any downstream client Multi-Currency Accounts. This endpoint will be deprecated on Friday, January 15, 2027 . Please use the new incoming-funds-v2 endpoint for all future integrations.
• [Common Terms (copy)](https://developer.crossborder.corpay.com/apidocscrossborder/common-terms-copy.md): Key identifiers and concepts used across Corpay Cross-Border APIs. Client Code - A unique 6-digit client identifier for each client account. Used in all endpoints as part of the URL. Partner ID - Links multiple client accounts together. Used during the authentication procedure. Client Integration ID - Unique beneficiary ID that you can use in other endpoints. Tracker ID - The unique tracker identifier assigned to a payment transaction. Payment - Outgoing cashflow to a beneficiary. Settlement - Incoming cashflow to Corpay. MCA - Multi-Currency Accounts (Formerly known as FXBalance/CLIAB)
  • [Supporting Information (copy)](https://developer.crossborder.corpay.com/apidocscrossborder/common-terms-copy/supporting-information-copy.md): This section provides essential reference information to help you validate and configure your transactions accurately. You can access up-to-date details on supported currencies, countries, and regions, ensuring compliance with Corpay’s API requirements. Current API Version - 1.8 Supported Currencies - Use GET /api/payCurrencies?product=Bene to retrieve valid values. Supported Countries - Use GET /api/countries to retrieve valid values. Supported States/Regions - Use GET /api/regions?Country=ISO2 country code to retrieve valid values. See GET Regions Download Postman Collection - Click the top right menu. To request Sandbox credentials, please contact your account representative. API documentation is available only on the Corpay Developer Portal to ensure you always have access to the latest version and is not offered as downloadable files. For assistance, please contact your Corpay Account Representative.
• [2026](https://developer.crossborder.corpay.com/apidocscrossborder/2026.md): Review release notes before each deployment to check for new features, behavior changes, and deprecations that may affect your integration.
  • [August](https://developer.crossborder.corpay.com/apidocscrossborder/2026/august.md): Release Date: August 21, 2026 Internal Payment Reference support added: Spot Instruct Deal and Lookup Orders APIs The Spot Instruct Deal and Lookup Orders APIs now support the internalPaymentReference field, allowing clients to pass and retrieve their own payment reference identifiers for easier reconciliation and transaction tracking. For more information, see: Spot Instruct Deal Lookup Orders Release Date: August 21, 2026 Cancel Order API v2 A new version of the Cancel Order API is now available. The new endpoints provide a more consistent and reliable integration experience while aligning with REST principles and HATEOAS . The v2 API introduces a RESTful cancellation workflow with three endpoints: Create Cancellation Quote Get Cancellation Quote Book Cancellation For more information, see Cancel Order v2 endpoints. No action is required for existing integrations. The current endpoints will continue to be supported and will operate through a compatibility layer until their planned deprecation in Q2 2027. We'll keep you informed on the exact deprecation date. For new integrations, Corpay recommends using the new Cancel Order v2 API.
  • [July](https://developer.crossborder.corpay.com/apidocscrossborder/2026/july.md): Release Date: July 27, 2026 New Beneficiary Verification Endpoints: Confirmation of Payee (CoP) and Verification of Payee (VoP) To comply with UK and EU payee verification mandates, we've introduced new Beneficiary verification endpoints that support Confirmation of Payee (CoP) and Verification of Payee (VoP) . When creating or updating a beneficiary, the new endpoint will validate the beneficiary name against the associated bank account details and return the screening results. You can correct the details, override the result, or cancel the payment. The response will include: Close Match (name is similar but not an exact match) No Match (name does not match the name on account) Unique copVopOverideKey to bypass the verification error New endpoints introduced: Create/Edit Beneficiary : POST /api/{clientCode}/0/ templates-v2 /clientIntegrationId} Beneficiary Validation : POST /api/{clientCode}/0/ templates-validate-v2 /{clientIntegrationId} For more information, see: Beneficiary Verification CoP/VoP FAQs Action Required If you have downloaded our API collection into your Postman collection or codebase, update your workflows to support the new verification endpoints. To meet regulatory requirements, complete your Production implementation by Friday, October 30, 2026 . 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. Release Date: July 10, 2026 New Endpoint: Incoming Funds v2 As part of ongoing enhancements to Corpay’s API suite, a new version of the Incoming Funds endpoint is now available: api/{clientCode}/{clientDivisionId}/ incoming-funds-v2 /{ordNum} . This new endpoint retrieves incoming funds for both Standard and Named MCAs . For more information, see Get Incoming Funds (v2) . Action Required The response format has changed and is now returned as an array . If you have downloaded our API collection into your Postman collection or codebase, please ensure it is updated. To ensure a smooth transition, the existing endpoint will remain available for six months and will be deprecated on Friday, January 15, 2027 .
  • [June](https://developer.crossborder.corpay.com/apidocscrossborder/2026/june.md): Release Date: June 16, 2026 Get Beneficiary Rules API The Get Beneficiary Rules endpoint now supports a new optional parameter country , to retrieve valid beneficiary rules. Release Date: June 9, 2026 Revert: Incoming Funds Details API We reverted the latest changes introduced in the previous release (Friday, May 29, 2026) to the Incoming Funds API to address reported functional issues. The API now returns a single record per order number, even when multiple deals are linked. A fix will be introduced in a future release.
  • [May](https://developer.crossborder.corpay.com/apidocscrossborder/2026/may.md): Release Date: May 29, 2026 Update: Incoming Funds Details API The Incoming Funds Details API now returns details of funds credited to the partner's Standard MCA (Multi-Currency Account), including funds directed to their downstream clients' Standard MCAs. Previously, this API provided details of funds received into their Named MCAs. For more information, see Incoming Funds Details API .
  • [April](https://developer.crossborder.corpay.com/apidocscrossborder/2026/april.md): Release Date: April 20, 2026 Update: Multi-Currency Account (MCA) Nickname The maximum length for the MCA nickname has been increased from 30 to 50 characters. All other validations remain unchanged. For more information, see Assign/Edit MCA Nickname . Release Date: April 3, 2026 Update: Client Onboarding and Create/Edit Bene API Client Onboarding API now supports a new Boolean parameter, DirectDebitAuthorization . When left blank, the value defaults to false . For more information, see Client Onboarding . Nonprofit Organization is now available as a beneficiary classification when creating beneficiaries. For more information, see Create/Edit Bene .
  • [March](https://developer.crossborder.corpay.com/apidocscrossborder/2026/march.md): Release Date: March 20, 2026 New: Subscribe to new Payment Webhooks Events We’ve expanded Webhooks to support new payment event types. Users can now subscribe to receive real-time notifications for the following events: Corpay cancels a payment. A client cancels a payment. Payment is returned to the client. For more information, see Webhooks . Release Date: March 9, 2026 Enhanced Validations for Canadian Bank Account Numbers Effective Monday, March 09, 2026 , the system will enforce the length of Canadian bank account numbers based on the bank’s routing code and payment method (Wire or EFT) used when creating or editing a bene template. If the account number length is invalid, the Create/Edit Bene API response will return a regex error. An optional routingCode parameter has been added to the Get Beneficiary Rules endpoint to return the required account number length based on the provided routing code. New Indicative Rate Endpoint Introduced We added a new GET Indicative Rates endpoint to return an indicative rate request for a Spot transaction. For more information, see GET Indicative Rates . Client Onboarding Request Update The BusinessConfirmationEmail2 parameter in the Client Onboarding request is now required. If no alternate email address is available, users must enter their primary registered email address. For more information, see Client Onboarding .
  • [January](https://developer.crossborder.corpay.com/apidocscrossborder/2026/january.md): ### **Release Date: January 9, 2026** #### **Update: Client Onboarding API** The Onboarding API email field parameters now support email addresses with domain suffixes exceeding three characters (e.g., support@enterprise.cloud). Previously, only three-character extensions were accepted. See [Client Onboarding](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding).
• [2025](https://developer.crossborder.corpay.com/apidocscrossborder/2025.md): Key 2025 feature releases and improvements.
  • [October](https://developer.crossborder.corpay.com/apidocscrossborder/2025/october.md): ### Release Date: October 31, 2025 #### Update: Client Onboarding API We made the following enhancements to the Client Onboarding API: * Added new fields to support regional onboarding (CA, US, UK, AU, NZ, SG, EEA). See [POST Client Onboarding](https://developer.crossborder.corpay.com/managepricing/client-onboarding-1/onboard-client/onboarding-new). * Introduced new picklist types for validating onboarding request values. See [GET Onboarding Picklists](https://ttps://developer.crossborder.corpay.com/managepricing/client-onboarding-1/reference-data/new-onboarding-picklists). See [Client Onboarding](https://developer.crossborder.corpay.com/managepricing/client-onboarding-1).
  • [September](https://developer.crossborder.corpay.com/apidocscrossborder/2025/september.md): ### Release Date: September 5, 2025 #### Update: Purpose of Payment API The [GET Purpose of Payment](https://developer.crossborder.corpay.com/managepricing/beneficiary-workflow/beneficiary-help/purpose-of-payment) endpoint now supports three additional values: * Royalties * Reimbursement payment * Winnings These values are returned in the standard purpose of payment response. Call the API to confirm the allowed POP values for unique currency and payment method combinations.
  • [August](https://developer.crossborder.corpay.com/apidocscrossborder/2025/august.md): Release Date: August 22, 2025 Starting the week of August 25, 2025, we will be rolling out the following changes: Purpose of Payment Enforcement As part of additional regulatory and banking requirements, a valid POP is now mandatory when instructing payments. A Corpay accepted POP value must be entered in the purposeOfPayment request field when submitting a payment via the following endpoints: POST Instruct Deal ; POST Multiple Payments ; POST Book Drawdown . If the purposeOfPayment field is left blank or populated with an invalid value, a 400 Bad Request error will be returned. Note : While the POP list is consistent for most currencies, certain currencies may have unique POP value lists. Please use the GET Purpose of Payment endpoint to retrieve the correct POP ID for the corresponding currency and payment method. Currency Edits on Existing Bene Template To maintain consistency with the Corpay Cross-Border platform, editing the currency field on existing beneficiary templates via the API is now restricted and will return a 400 Bad Request . To update a beneficiary’s currency, a new template must be created via the API. These updates were previously shared in our Upcoming Updates . Full details are available here.
  • [July](https://developer.crossborder.corpay.com/apidocscrossborder/2025/july.md): ### Release Date: July 31, 2025 #### New API Endpoints: Manage Multi-Currency Account Nickname You can now assign, update, and reset the nickname for your Multi-Currency Accounts via the API endpoints available [here](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/manage-multi-currency-accounts-nickname). ### Release Date: July 25, 2025 #### Updated: Incoming Funds Details API As part of our ongoing improvements to Corpay's API suite, we have renamed the Incoming Deals API endpoint from: `incoming-funds-details/{dealNumber}` to `incoming-funds/{ordNum}`. There are no changes to the returned response. **Note**: The old endpoint will be deprecated and made obsolete on **Friday, August 15, 2025**. If you have downloaded our API collection into your Postman instance or codebase, please ensure it is updated. See [GET: Incoming Funds Details](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/incoming-funds-details)
  • [June](https://developer.crossborder.corpay.com/apidocscrossborder/2025/june.md): ### Release Date: June 27, 2025 #### New: Subscribe to Incoming Funds Webhooks Events We’ve enhanced Webhooks to include new event types. Users can now subscribe to receive real-time notifications when: * Incoming funds are applied to their Multi-Currency Account. * A payment is held at Corpay. See [Webhooks](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/supported-events/incoming-funds-events). #### New API: Incoming Funds Details We've introduced a new API endpoint - [GET: Incoming Funds Details](https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/incoming-funds-details) that provides users with complete details of the incoming funds received into their MCA. #### Update: Onboarding Purpose of Transactions Picklist We've updated the [Onboarding Purpose of Transactions Picklist API](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists) to include additional values. Partners can now include specific Purpose of Transaction details to support compliance requirements. ### Release Date: June 13, 2025 #### Update: Payment Channel Information API Based on the payment method used, the [Payment Channel Information API](https://developer.crossborder.corpay.com/apidocscrossborder/payment-tracking/payment-channel-information) will now return either **SWIFT MT103** or **SWIFT MX Pacs.008.001.08** raw details in the response payload. The corresponding status in the response will be displayed as `MT103` or `Pacs.008.001.08`. For more information, read [here](https://cb.corpay.com/api-resources-documentation/#coming-change).
  • [April](https://developer.crossborder.corpay.com/apidocscrossborder/2025/april.md): ### **Release Date: April 25, 2025** #### **Update: Beneficiary API** The `defaultInternalComment` field, previously used in the [Create/Edit Bene API](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/create-edit-bene) to enter For Further Credit (FFC) details, has now been renamed to `furtherCreditDetails` to provide a more intuitive and descriptive label. The [Beneficiary Validation](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/beneficiary-validation) and the [Get Beneficiary Rules](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/beneficiary-rules) endpoints will also reflect this update. **Note**: The old field name is no longer supported. If the old field name is used, the API will return a `200 success` response, however, the FFC information will not be saved for that beneficiary. To ensure FFC details are saved correctly, partners must use the new field name `furtherCreditDetails`. ### **Release Date: April 7, 2025** #### **Beneficiary Region and Postal Code Enforcement** To comply with updated **FINTRAC** and related regulatory requirements, users are now required to **enter valid region and postal code information for bank and beneficiary addresses in payments made to the United States and Canada.** This update is enforced when creating or editing beneficiary information on Corpay Cross-Border via Beneficiary Templates, File Upload, or API. When using the [POST Create/Edit Bene](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/create-edit-bene) API, entering an invalid region or postal code for beneficiaries/bank addresses in the US and CA will return a `400 Bad Request` error. For more information, read [here](https://cross-border.corpay.com/api-resources-documentation/#lp-pom-block-959). Please refer to the [GET Region](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/regions) API to retrieve accepted region values for US and CA beneficiary/bank addresses, and the [GET Beneficiary Rules](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/beneficiary-rules) API for valid Reg-Ex for US and CA address zip codes.
  • [March](https://developer.crossborder.corpay.com/apidocscrossborder/2025/march.md): ### **Release Date: March 7, 2025** #### **Update: Beneficiary API** We added an optional `defaultInternalComment` field to [Create/Edit](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/create-edit-bene) and [Beneficiary Validation](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/beneficiary-validation) endpoints, enabling you to enter **For Further Credit (FFC)** information details. This field has a character limit of 50, and standard regex validations will apply. This field allows you to enter the details of the recipient who will receive the funds. For example, “FFC Tom Roe 000304756”.
• [2024](https://developer.crossborder.corpay.com/apidocscrossborder/2024.md): Key 2024 feature releases and improvements.
  • [November](https://developer.crossborder.corpay.com/apidocscrossborder/2024/november.md): Release Date: November 29,2024 New API: GET Regions To help prevent invalid region errors, we’ve introduced a dedicated GET Regions API endpoint. This endpoint allows our partners to retrieve valid region values. Release Date: November 14, 2024 Update: Settlement Accounts API Endpoints Renamed As part of our product rebranding, we renamed the following API endpoints under the Settlement Accounts , effective Thursday, November 14, 2024: View FXBalance Accounts is now renamed to View Multi-Currency Accounts FXBalance History is now renamed to Multi-Currency Accounts History Please note that only the API names have been renamed — the API URL remains unchanged . You can continue to access the API using the same endpoints as before. The View Multi-Currency Accounts API will now return both the Standard and Named Account related details and the corresponding SSIs in the response payload. For the most current list of fields, descriptions, and other details, please refer to the updated API documentation . Any references to FXBalance , Link Balances , or CLIAB in the payment/settlement methods, account type, and templates description have been updated to MCA Balance (Multi-Currency Accounts Balance) . However, the API URLs and the response payloads will return the old terminology. We are actively working to update this in our future API releases. Multi-Currency Accounts (MCA) cannot be created via API, please speak to your account representative for more details.
  • [October](https://developer.crossborder.corpay.com/apidocscrossborder/2024/october.md): ### **Release Date: October 2, 2024** #### **New API: Validate Beneficiary** * In response to feedback from our partners, we’ve introduced a dedicated beneficiary validation API endpoint, which allows our partners to validate their beneficiary details without creating a template. Previously, partners could only validate beneficiary data using the `POST Create/Edit Bene` endpoint. See [Beneficiary Validation](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/beneficiary-validation). #### **Update: Partner-level Token Login** * If you have downloaded our API collection to your instance and are currently passing the `CMG-AccessToken:toBeDiscontinued` in the `POST` [Partner-level Token Login](https://developer.crossborder.corpay.com/apidocscrossborder/2-token-auth/partner-level-token-login) header, **please ensure it is removed**. This token has been identified as a potential cause of recent timeout errors during API authentication and is no longer required to be included in the header.
  • [September](https://developer.crossborder.corpay.com/apidocscrossborder/2024/september.md): ### **Release Date: September 13, 2024** * To comply with **Fintrac** and other regulatory requirements, PO Box addresses and similar variations are now restricted in the address fields when creating or editing beneficiary information on Corpay Cross-Border through the API and UI. When using the `POST` [Create/Edit Bene](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/create-edit-bene) API, entering a PO Box address in the beneficiary address fields will return a `REGEX_MISMATCH` error. This restriction currently applies to **Australia**, **Canada**, and **Mexico** and is also reflected in the `GET` [Beneficiary Rules](https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/beneficiary-rules) endpoint. This update ensures that a complete physical address is provided, as required by regulatory standards.
  • [August](https://developer.crossborder.corpay.com/apidocscrossborder/2024/august.md): ### **Release Date: August 16, 2024** * We updated the [Mass Payments Quote](https://developer.crossborder.corpay.com/apidocscrossborder/mass-payments/multiple-payments) endpoint to return the `trackerId` in the response. With this update, our partners can retrieve the `trackerId` in the Mass Payment workflow immediately and avoid subsequent follow-up API requests to retrieve the payment tracker IDs. ### **Release Date: August 02, 2024** * We updated the [Partner](https://developer.crossborder.corpay.com/apidocscrossborder/2-token-auth/partner-level-token-login) and [Client](https://developer.crossborder.corpay.com/apidocscrossborder/2-token-auth/client-level-token-login) level token endpoints to return a 400 HTTPS error for null or invalid form data, instead of the previously returned 500 error. This update improves error handling.
• [2023](https://developer.crossborder.corpay.com/apidocscrossborder/2023.md): Key 2023 feature releases and improvements.
  • [October](https://developer.crossborder.corpay.com/apidocscrossborder/2023/october.md): ### **Release Date: October 02,2023** * Added new **Push Notifications via Webhooks** to allow our Partners to receive real-time notifications on events that occur within their client account and eliminates the need to regularly poll the APIs to know if there is a new update. Webhooks utilize an event-driven approach to promptly send a notification when the subscribed event occurs. * The Push Notifications are currently available for **Payment** and **Client Onboarding** events. For more information, see [Webhooks](https://developer.crossborder.corpay.com/apidocscrossborder/webhooks).
  • [August](https://developer.crossborder.corpay.com/apidocscrossborder/2023/august.md): ### **Update Date: August 26,2023** * Corpay’s `POST Accept Terms` API endpoint is **deprecated** as of **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 is 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](https://developer.crossborder.corpay.com/apidocscrossborder/forwards-and-drawdowns/forwards/3-complete-order) API endpoint.
  • [May](https://developer.crossborder.corpay.com/apidocscrossborder/2023/may.md): ### **Release Date: May 26,2023** * Added new authentication API to allow partners to securely access the **Secret Keys** for a newly onboarded client. This API will return an encrypted response containing the `ClientCode`, `AuthSecret`, and `UserNames` linked to the onboarded client. For more information, see `GET` [AuthSecret Keys.](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/authsecret-keys)
  • [March](https://developer.crossborder.corpay.com/apidocscrossborder/2023/march.md): ### **Release Date: March 31,2023** * Added new pickListType `**NatureOfBusiness**` to the client onboarding picklists API. This `pickListType` will return a predefined list of nature of business values and further expedite the client onboarding process. For more information, see [Onboarding Picklists](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists). **Note**: This list returns possible values that you can pass in the `NatureOfBusiness` field. You can enter any valid string value for this field.
  • [February](https://developer.crossborder.corpay.com/apidocscrossborder/2023/february.md): ### **Release Date: February 20,2023** * Added new [Onboarding endpoints](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding) to allow our Partners to submit a corporate client onboarding request. On successful submission of the request a unique `clientOnboardingId`is returned. They can then submit the required verification documents via the [Submit Onboarding request](https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/submit-onboarding-files) to complete the onboarding process for that client.
  • [January](https://developer.crossborder.corpay.com/apidocscrossborder/2023/january.md): ### Release Date: January 16, 2023 * Added new [Payment Tracking](https://developer.crossborder.corpay.com/apidocscrossborder/payment-tracking/payment-tracking-1) endpoints to allow our Partners to trace the details and status of their payments. This feature is available only for SWIFT Payments - Wires. EFT/iACH payments are currently not supported. For more information, see `GET` [Payment Tracking.](https://developer.crossborder.corpay.com/apidocscrossborder/payment-tracking/payment-tracking-1) * Added a new field `trackerId` in the `POST Instruct Deal` and `GET Lookup Orders` response. This field will return the unique trackerId for a specific payment that can be used to trace the payment details and status. For more information, see POST [Instruct Deal](https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/3-instruct-deal) and GET [Lookup Orders.](https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/lookup-orders)
• [Explore Corpay Cross-Border APIs](https://developer.crossborder.corpay.com/apidocscrossborder/explore-corpay-cross-border-apis.md): Authentication Authenticate your integration and obtain the access tokens required to call Corpay APIs. Beneficiaries Create, validate, and manage payment beneficiaries. FX Book Spot and Forward transactions and manage FX. Payments Send and track domestic and international payments. Accounts Access balances, accounts, incoming funds, and transaction data. Reporting Track and reconcile transactions Client Onboarding Onboard clients and submit supporting documentation Webhooks Receive real-time notifications for account events