Corpay

2026

April

March

January

<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h4 class="slate-h4 " >Release Date: October 31, 2025</h4><h4 class="slate-h4 " >Update: Client Onboarding API</h4><p class="slate-p " >We made the following enhancements to the Client Onboarding API:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Added new fields to support regional onboarding (CA, US, UK, AU, NZ, SG, EEA). See <a href="https://developer.crossborder.corpay.com/managepricing/client-onboarding-1/onboard-client/onboarding-new" target="">POST Client Onboarding</a>.</div></li><li class="slate-li " ><div style="position:relative">Introduced new picklist types for validating onboarding request values. See <a href="https://ttps://developer.crossborder.corpay.com/managepricing/client-onboarding-1/reference-data/new-onboarding-picklists" target="">GET Onboarding Picklists</a>.</div></li></ul><p class="slate-p " >See <a href="https://developer.crossborder.corpay.com/managepricing/client-onboarding-1" target="">Client Onboarding</a>.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >September 2025</h3><h4 class="slate-h4 " >Release Date: September 5, 2025</h4><h4 class="slate-h4 " >Update: Purpose of Payment API</h4><p class="slate-p slate-indent-0" style="0px">The <a href="https://developer.crossborder.corpay.com/managepricing/beneficiary-workflow/beneficiary-help/purpose-of-payment" target="">GET Purpose of Payment</a> endpoint now supports three additional values:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Royalties </div></li><li class="slate-li " ><div style="position:relative">Reimbursement payment</div></li><li class="slate-li " ><div style="position:relative">Winnings</div></li></ul><p class="slate-p slate-indent-0" style="0px">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.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >August 2025</h3><h4 class="slate-h4 " >Release Date: August 22, 2025</h4><p class="slate-p slate-indent-0" style="0px">Starting the week of <strong class="slate-bold">August 25, 2025,</strong> we will be rolling out the following changes:</p><h4 class="slate-h4 " >Purpose of Payment Enforcement</h4><p class="slate-p slate-indent-0" style="0px">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 <code class="slate-code">purposeOfPayment</code> request field when submitting a payment via the following endpoints: <a href="https://developer.crossborder.corpay.com/managepricing/spot-workflow/3-instruct-deal" target="">POST Instruct Deal</a>; <a href="https://developer.crossborder.corpay.com/managepricing/mass-payments/multiple-payments" target="">POST Multiple Payments</a>; <a href="https://developer.crossborder.corpay.com/managepricing/forwards-and-drawdowns/drawdowns/book-drawdown" target="">POST Book Drawdown</a>.</p><p class="slate-p slate-indent-0" style="0px">If the <code class="slate-code">purposeOfPayment</code> field is left blank or populated with an invalid value, a <code class="slate-code">400 Bad Request error</code> will be returned.
<strong class="slate-bold">Note</strong>: While the POP list is consistent for most currencies, certain currencies may have unique POP value lists. Please use the <a href="https://developer.crossborder.corpay.com/managepricing/beneficiary-workflow/beneficiary-help/purpose-of-payment" target="">GET Purpose of Payment</a> endpoint to retrieve the correct POP ID for the corresponding currency and payment method.</p><h4 class="slate-h4 " >Currency Edits on Existing Bene Template</h4><p class="slate-p slate-indent-0" style="0px">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 <code class="slate-code">400 Bad Request</code>. To update a beneficiary’s currency, a new template must be created via the API.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px">These updates were previously shared as part of our <a href="https://developer.crossborder.corpay.com/managepricing/upcoming-updates" target="">Upcoming Updates</a>. Full details are available <a href="https://cb.corpay.com/api-resources-documentation/#coming-change" target="_blank">here.</a></p></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >July 2025</h3><h4 class="slate-h4 " >Release Date: July 31, 2025</h4><h4 class="slate-h4 " >New API Endpoints: Manage Multi-Currency Account Nickname</h4><p class="slate-p slate-indent-0" style="0px">You can now assign, update, and reset the nickname for your Multi-Currency Accounts via the API endpoints available <a href="https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/manage-multi-currency-accounts-nickname" target="">here</a>.</p><h4 class="slate-h4 " >Release Date: July 25, 2025</h4><h4 class="slate-h4 " >Updated: Incoming Funds Details API</h4><p class="slate-p slate-indent-0" style="0px">As part of our ongoing improvements to Corpay&apos;s API suite, we have renamed the Incoming Deals API endpoint from: <code class="slate-code">incoming-funds-details/{dealNumber}</code> to <code class="slate-code">incoming-funds/{ordNum}</code>. There are no changes to the returned response. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Note</strong>: The old endpoint will be deprecated and made obsolete on <strong class="slate-bold">Friday, August 15, 2025</strong>. If you have downloaded our API collection into your Postman instance or codebase, please ensure it is updated.</p><p class="slate-p slate-indent-0" style="0px">See <a href="https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/incoming-funds-details" target="">GET: Incoming Funds Details</a></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >June 2025</h3><h4 class="slate-h4 " >Release Date: June 27, 2025</h4><h4 class="slate-h4 " >New: Subscribe to Incoming Funds Webhooks Events</h4><p class="slate-p " >We’ve enhanced Webhooks to include new event types. Users can now subscribe to receive real-time notifications when:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Incoming funds are applied to their Multi-Currency Account.</div></li><li class="slate-li " ><div style="position:relative">A payment is held at Corpay.</div></li></ul><p class="slate-p " >See <a href="https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/supported-events/incoming-funds-events" target="">Webhooks</a>.</p><h4 class="slate-h4 " >New API: Incoming Funds Details</h4><p class="slate-p " >We&apos;ve introduced a new API endpoint - <a href="https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/incoming-funds-details" target="">GET: Incoming Funds Details</a> that provides users with complete details of the incoming funds received into their MCA.</p><h4 class="slate-h4 " >Update: Onboarding Purpose of Transactions Picklist</h4><p class="slate-p " >We&apos;ve updated the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists" target="">Onboarding Purpose of Transactions Picklist API</a> to include additional values. Partners can now include specific Purpose of Transaction details to support compliance requirements.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: June 13, 2025</strong></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Update: Payment Channel Information API</strong></p><p class="slate-p slate-indent-0" style="0px">Based on the payment method used, the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/payment-tracking/payment-channel-information" target="">Payment Channel Information API</a> will now return either <strong class="slate-bold">SWIFT MT103</strong> or <strong class="slate-bold">SWIFT MX Pacs.008.001.08</strong> raw details in the response payload. The corresponding status in the response will be displayed as <code class="slate-code">MT103</code> or <code class="slate-code">Pacs.008.001.08</code>. For more information, read <a href="https://cb.corpay.com/api-resources-documentation/#coming-change" target="_blank">here</a>.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"></p><h3 class="slate-h3 " ><strong class="slate-bold">April 2025</strong></h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: April  25, 2025</strong></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Update: Beneficiary API</strong></p><p class="slate-p slate-indent-0" style="0px">The <code class="slate-code">defaultInternalComment</code> field, previously used in the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/create-edit-bene" target="">Create/Edit Bene API </a>to enter For Further Credit (FFC) details, has now been renamed to <code class="slate-code">furtherCreditDetails</code> to provide a more intuitive and descriptive label. The <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/beneficiary-validation" target="">Beneficiary Validation</a> and the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/beneficiary-rules" target="">Get Beneficiary Rules</a> endpoints will also reflect this update.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Note</strong>: The old field name is no longer supported. If the old field name is used, the API will return a <code class="slate-code">200 success</code> 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 <code class="slate-code">furtherCreditDetails</code>.</p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: April 7, 2025</strong></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold"> Beneficiary Region and Postal Code Enforcement</strong></p><p class="slate-p slate-indent-0" style="0px">To comply with updated <strong class="slate-bold">FINTRAC</strong> and related regulatory requirements, users are now required to <strong class="slate-bold">enter valid region and postal code information for bank and beneficiary addresses in payments made to the United States and Canada.</strong> This update is enforced when creating or editing beneficiary information on Corpay Cross-Border via Beneficiary Templates, File Upload, or API. When using the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/create-edit-bene" target="">POST Create/Edit Bene </a>API, entering an invalid region or postal code for beneficiaries/bank addresses in the US and CA will return a <code class="slate-code">400 Bad Request</code> error. For more information, read <a href="https://cross-border.corpay.com/api-resources-documentation/#lp-pom-block-959" target="_blank">here</a>.</p><p class="slate-p slate-indent-0" style="0px">Please refer to the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/regions" target="">GET Region</a> API to retrieve accepted region values for US and CA beneficiary/bank addresses, and the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/beneficiary-rules" target="">GET Beneficiary Rules</a> API for valid Reg-Ex for US and CA address zip codes.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " ><strong class="slate-bold">March 2025</strong></h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: March 7, 2025</strong></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Update: Beneficiary API</strong></p><p class="slate-p slate-indent-0" style="0px">We added an optional <code class="slate-code">defaultInternalComment</code> field to <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/create-edit-bene" target="">Create/Edit</a> and <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/beneficiary-validation" target="">Beneficiary Validation</a> endpoints, enabling you to enter <strong class="slate-bold">For Further Credit (FFC)</strong> 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”.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p>

2025

October

September

August

July

June

<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " ><strong class="slate-bold">November 2024</strong></h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: November 29,2024</strong></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">New API: GET Regions</strong></p><p class="slate-p slate-indent-0" style="0px">To help prevent invalid region errors, we’ve introduced a dedicated <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/regions" target="">GET Regions</a> API endpoint. This endpoint allows our partners to retrieve valid region values.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: November 14, 2024</strong></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Update: Settlement Accounts API Endpoints Renamed</strong></p><p class="slate-p slate-indent-0" style="0px">As part of our product rebranding, we renamed the following API endpoints under the <strong class="slate-bold">Settlement Accounts</strong>, effective Thursday, November 14, 2024:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">View FXBalance Accounts is now renamed to View Multi-Currency Accounts</div></li><li class="slate-li " ><div style="position:relative">FXBalance History is now renamed to Multi-Currency Accounts History</div></li></ul><p class="slate-p slate-indent-0" style="0px">Please note that <strong class="slate-bold">only the API names have been renamed — the API URL remains unchanged</strong>. You can continue to access the API using the same endpoints as before.</p><p class="slate-p slate-indent-0" style="0px">The <a href="https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/view-multi-currency-accounts" target="">View Multi-Currency Accounts API</a> will now return both the <strong class="slate-bold">Standard </strong>and <strong class="slate-bold">Named </strong>Account related details and the corresponding SSIs in the response payload.</p><p class="slate-p slate-indent-0" style="0px">For the most current list of fields, descriptions, and other details, please refer to the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/settlement-accounts/view-multi-currency-accounts" target="">updated API documentation</a>.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Any references to <strong class="slate-bold">FXBalance</strong>, <strong class="slate-bold">Link Balances</strong>, or <strong class="slate-bold">CLIAB</strong> in the payment/settlement methods, account type, and templates description have been updated to <strong class="slate-bold">MCA Balance (Multi-Currency Accounts Balance)</strong>. 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.</div></li><li class="slate-li " ><div style="position:relative">Multi-Currency Accounts (MCA) cannot be created via API, please speak to your account representative for more details.</div></li></ul></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >October 2024</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: October 2, 2024</strong></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">New API: Validate Beneficiary</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">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 <code class="slate-code">POST Create/Edit Bene</code> endpoint. See <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-help/beneficiary-validation" target="_top">Beneficiary Validation</a>.</div></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Update: Partner-level Token Login</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">If you have downloaded our API collection to your instance and are currently passing the <code class="slate-code">CMG-AccessToken:toBeDiscontinued</code> in the <code class="slate-code">POST</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/2-token-auth/partner-level-token-login" target="_top">Partner-level Token Login</a> header, <strong class="slate-bold">please ensure it is removed</strong>. 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.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><h3 class="slate-h3 " >September 2024</h3><p class="slate-p slate-indent-0" style="0px">
<strong class="slate-bold">Release Date: September 13, 2024</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">To comply with <strong class="slate-bold">Fintrac </strong>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 <code class="slate-code">POST</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/create-edit-bene" target="_top">Create/Edit Bene</a> API, entering a PO Box address in the beneficiary address fields will return a <code class="slate-code">REGEX_MISMATCH</code> error. This restriction currently applies to <strong class="slate-bold">Australia</strong>, <strong class="slate-bold">Canada</strong>, and <strong class="slate-bold">Mexico </strong>and is also reflected in the <code class="slate-code">GET</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/beneficiary-workflow/beneficiary-core/beneficiary-rules" target="_top">Beneficiary Rules</a> endpoint. This update ensures that a complete physical address is provided, as required by regulatory standards.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >August 2024</h3><p class="slate-p slate-indent-0" style="0px">
<strong class="slate-bold">Release Date: August 16, 2024</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">We updated the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/mass-payments/multiple-payments" target="_top">Mass Payments Quote</a> endpoint to return the <code class="slate-code">trackerId</code> in the response. With this update, our partners can retrieve the <code class="slate-code">trackerId</code> in the Mass Payment workflow immediately and avoid subsequent follow-up API requests to retrieve the payment tracker IDs.</div></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: August 02, 2024</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">We updated the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/2-token-auth/partner-level-token-login" target="_top">Partner</a> and <a href="https://developer.crossborder.corpay.com/apidocscrossborder/2-token-auth/client-level-token-login" target="_top">Client</a> 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.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

2024

November

<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >October 2023</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: October 02,2023</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Added new <strong class="slate-bold">Push Notifications via Webhooks</strong> 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.</div></li><li class="slate-li " ><div style="position:relative">The Push Notifications are currently available for <strong class="slate-bold">Payment </strong>and <strong class="slate-bold">Client Onboarding</strong> events. For more information, see <a href="https://developer.crossborder.corpay.com/apidocscrossborder/webhooks" target="_top">Webhooks</a>.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >August 2023</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Update Date: August 26,2023</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Corpay’s <code class="slate-code">POST Accept Terms</code> API endpoint is <strong class="slate-bold">deprecated</strong> as of <strong class="slate-bold">August 26th, 2023</strong>. To streamline our Forward workflow and reduce the number of endpoints that need to be called to successfully complete a Forward order, the <code class="slate-code">POST Accept Terms API</code> 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 <code class="slate-code">POST</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/forwards-and-drawdowns/forwards/3-complete-order" target="_top">Complete Order</a> API endpoint.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >May 2023</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: May 26,2023</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Added new authentication API to allow partners to securely access the <strong class="slate-bold">Secret Keys</strong> for a newly onboarded client. This API will return an encrypted response containing the <code class="slate-code">ClientCode</code>, <code class="slate-code">AuthSecret</code>, and <code class="slate-code">UserNames</code> linked to the onboarded client. For more information, see <code class="slate-code">GET</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/authsecret-keys" target="_top">AuthSecret Keys.</a></div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >March 2023</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: March 31,2023</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Added new pickListType <code class="slate-code"><strong class="slate-bold">NatureOfBusiness</strong></code> to the client onboarding picklists API. This <code class="slate-code">pickListType</code> will return a predefined list of nature of business values and further expedite the client onboarding process. For more information, see <a href="https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/reference-data/onboarding-picklists" target="_top">Onboarding Picklists</a>.
<strong class="slate-bold">Note</strong>: This list returns possible values that you can pass in the <code class="slate-code">NatureOfBusiness</code> field. You can enter any valid string value for this field.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >February 2023</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: February 20,2023</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Added new <a href="https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding" target="_top">Onboarding endpoints</a> to allow our Partners to submit a corporate client onboarding request. On successful submission of the request a unique <code class="slate-code">clientOnboardingId</code>is returned. They can then submit the required verification documents via the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/client-onboarding/onboard-client/submit-onboarding-files" target="_top">Submit Onboarding request</a> to complete the onboarding process for that client.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h3 class="slate-h3 " >January 2023</h3><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Release Date: January 16,2023</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Added new <a href="https://developer.crossborder.corpay.com/apidocscrossborder/payment-tracking/payment-tracking-1" target="_top">Payment Tracking</a> 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 <code class="slate-code">GET</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/payment-tracking/payment-tracking-1" target="_top">Payment Tracking.</a></div></li><li class="slate-li " ><div style="position:relative">Added a new field <code class="slate-code">trackerId</code> in the <code class="slate-code">POST Instruct Deal </code>and <code class="slate-code">GET Lookup Orders</code> 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 <a href="https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/3-instruct-deal" target="_top">Instruct Deal</a> and GET <a href="https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/lookup-orders" target="_top">Lookup Orders.</a></div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

2023

February

<h2 class="slate-h2 " >Corpay Cross-Border API Documentation v1.8</h2><p class="slate-p " ></p><p class="slate-p " >Corpay Cross-Border API uses HATEOAS (Hypertext As The Engine Of Application State) framework. This means every response not only provides the requested data but also includes relevant links. This provides a link on the current resource as well as all actions that can be taken from there.</p><p class="slate-p " >Response to APIs, once authenticated, are displayed in the following model, where content and errors are provided in the appropriate lists. Links always contain a <code class="slate-code">SELF</code> link to the current endpoint, and any additional links, depending on the state of the resource. For example, a beneficiary object can be viewed and modified.<div class="slate-div"></div></p><p class="slate-p " ><div class="slate-div"></div></p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">  {</div><div class="slate-code_line">    &quot;content&quot;: {},</div><div class="slate-code_line">    &quot;errors&quot;: [],</div><div class="slate-code_line">    &quot;links&quot;: [</div><div class="slate-code_line">        {</div><div class="slate-code_line">            &quot;rel&quot;: &quot;self&quot;,</div><div class="slate-code_line">            &quot;uri&quot;:   &quot;https://crossborder.corpay.com/api/{{endpoint}}&quot;,</div><div class="slate-code_line">            &quot;method&quot;: {POST GET or PUT}</div><div class="slate-code_line">        }</div><div class="slate-code_line">    ]</div><div class="slate-code_line">  }</div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " ></h3><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Introduction

Upcoming Updates

Common Terms

Supporting Information

Base URL

Response Codes

Our RESTful API suite employs an OAuth2 framework which consists of a two part flow that involves exchanging a HS256-signed JWT token for a “CMG-AccessToken”. 

The partner-level and the client-level work in the following way:
Given “Issuer” - either the name of the Partner or the Client (contained in the Claim Set) - and the Signature, you create an encoded JWT Token (hashed via HS256); which is inserted into the body of the request of this call (in the "assertion" field). 

When creating the token, the "issued-at" and the "expiration" should be current, and advisably set apart at an interval of 20 minutes, respectively. 

Once the call is placed, the response provides an "access_code" which will be submitted to the "CMG-AccessToken" field in the header of the subsequent (Client-Level) requests. Since there is no call preceding partner-level, there is no need to pass anything through "CMG-AccessToken" for the partner-level.
&lt;br />

----
&lt;br />

##### AUTHENTICATION ERRORS

&lt;table style="width:100%">
  &lt;tr>
    &lt;th align="left">Error Code&lt;/th>
    &lt;th align="left">Description&lt;/th>
  &lt;/tr>
  &lt;tr>
    &lt;td>400 Bad Request - Invalid value for audience&lt;/td>
    &lt;td>JWT audience (aud) value of 'cambridgefx' was expected.  Make sure that the audience ("aud") is set to "cambridgefx" (in the JWT claimset)&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>400 Bad Request - 'exp' token is set too far into the future&lt;/td>
    &lt;td>This error is the result of setting the token too far into the future. The threshold is approximately 24 hours after issue.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>400 Bad Request - Invalid Issuer (either Partner or User)&lt;/td>
    &lt;td>User not found or partner access not configured. Check the "error_description" parameter for more information.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>400 Bad Request - Invalid signature key&lt;/td>
    &lt;td>The auth key or signature must be current; otherwise the token will not be signed properly.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>400 Bad Request - JWT Token is expired&lt;/td>
    &lt;td>As a general rule, use 'time + 20 minutes' as your expiry date/time.&lt;/td>
  &lt;/tr>
&lt;/table>


2-Token Auth

Sample payload for the JWT token generation:

```
{
"iss": "test",
"iat": 1480103915,
"exp": 1480105116,
"aud": "cambridgefx",
"sub": ""
}

```

[This link](http://jwtbuilder.jamiekurtz.com/) has a form to generate JWT token.

For the token, you must be current between the window of the issue and the expiry (`iat` and `exp`, respectively) of the Unix-Timestamp.

##### IMPLEMENTATION NOTES:

*   Algorithm has to be HS256.
*   Assertion needs to regenerated as it has expiry time.
*   Assertion value is an encoded JWT token that contain security key provided by Corpay.
*   `iss` is the Corpay-provided partner ID.

Partner-level Token Login

The authentication on the Client-level is similar to the authentication process at the partner-level. 
Two key differences in the JWT construction:
&lt;ul>
&lt;li>&lt;code>access_code&lt;/code> from Partner Auth goes in the header of this API.&lt;/li>
&lt;li>API username is the `iss` in the JWT token. &lt;/li>
&lt;/ul>

The `access_code` granted at the Client-level will be the session token for all subsequent calls in the current user session. 

Expiry of the `access_code` can accomodate different use cases.

Client-level Token Login

<p class="slate-p " >The endpoints in this section are used to create functional beneficiary templates that comply with all country-specific regulatory requirements.</p><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ><div class="slate-div"></div></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Beneficiary Workflow

<p class="slate-p " >The first call, <code class="slate-code">Beneficiary Rules</code>, outlines <em class="slate-italic">what</em> is required for the beneficiary template, <code class="slate-code">Create/Edit Bene</code> creates the template, and <code class="slate-code">View Bene</code> allows you to view the template.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Beneficiary Core

<p class="slate-p " >These endpoints assist with the creation and lookup of beneficiary information.</p><p class="slate-p " >IBAN Validation is recommended for use in IBAN-enabled countries, while Bank Search is for countries that do not support IBAN.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Beneficiary Help

This set of endpoints deals with the _exchange_ of a currency pair and the _transmission_ of that exchanged currency to a beneficiary or a holding balance. The first three endpoints are the key elements of the Spot Workflow:
&lt;ol>&lt;li>Spot Rate&lt;/li>&lt;li>Book Deal&lt;/li>&lt;li>Instruct Deal&lt;/li>&lt;/ol>
The other three endpoints are used to fetch rate and quote information:

* Lookup Orders
* Rate Resource
* Quotes

Spot Workflow

This is the first of two calls that are used to book a live rate as part of a Spot transaction. This call creates an impermanent resource based on a live exchange rate (between a currency pair). In order to secure the rate, you must book the deal (`POST` [Book Deal](https://docs.cambridgefx.com/#3bc872ce-26ad-45cb-8b70-b0a1e7e58434)).

The lockside determines which side of the pair will carry the base amount. For example, for a CAD/USD spot deal, if lockside is set to the 'payment' currency (which in this case is USD), then the quoted amount will be the 'settlement' currency (or CAD in this case).

As market rates are in flux, 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](https://docs.cambridgefx.com/#3bc872ce-26ad-45cb-8b70-b0a1e7e58434) endpoint.

**Note:** Corpay maintains a list of all available currencies, and ranks them from major to minor. This ranking is internal to Corpay and does not reflect any industry standard ordering. The internal ranking determines how the values for the 'rateType' and 'operation' parameters are expressed in the response.

* * *

##### REQUEST BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>paymentCurrency&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The three-letter ISO code for the payment currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>settlementCurrency&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The three-letter ISO code for the settlement currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>amount&lt;/td>&lt;td>&lt;b>number (required)&lt;/b>&lt;br>The amount on which to base the quote.&lt;/td>&lt;/tr>&lt;tr>&lt;td>lockSide&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Indicates which currency to lock when the rate calculation is performed = ['payment', 'settlement'].&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.rate.value&lt;/td>&lt;td>The result of applying the 'operation' type to the 'lockside' amount.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.rate.lockSide&lt;/td>&lt;td>The requested value for the 'lockside'.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.rate.rateType&lt;/td>&lt;td>The currency pair used in the rate calculation.&lt;br>&lt;b>Note:&lt;/b> The second currency in the pair is the more major of the two in Corpay's internal ranking.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.rate.operation&lt;/td>&lt;td>The operation that is used on the amount to get the quote. Possible values = ['Multiply' or 'Divide'].&lt;br>If the 'settlementCurrency' is higher in the Corpay ranking than the 'paymentCurrency', the operation is 'Multiply'. If the opposite is true, the operation is 'Divide'.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.quoteId&lt;/td>&lt;td>The unique ID assigned to the quote.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payment.currency&lt;/td>&lt;td>The three-letter ISO code for the payment currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payment.amount&lt;/td>&lt;td>Payment amount.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlement.currency&lt;/td>&lt;td>The three-letter ISO code for the settlement currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlement.amount&lt;/td>&lt;td>Amount of the settlement.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

##### IMPLEMENTATION NOTES:

Consider the rate to be available for 8 seconds, and 2 for latency and other network effects. Refresh after that period of time, or there will be time out error.

* * *

##### SPOT RATE ERRORS

&lt;table>&lt;tbody>&lt;tr>&lt;th>Error Code&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>400 Bad Request - Amount exceeds limit&lt;/td>&lt;td>This reflects the per-client threshold on allowed Spot transactions.&lt;/td>&lt;/tr>&lt;tr>&lt;td>400 Bad Request - Unexpected exception&lt;/td>&lt;td>Inputting an invalid currency code will return this error.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

[1] Spot Rate

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](https://docs.cambridgefx.com/#6499f440-a427-48df-b33a-825bec24de82) call to book a deal using the quoted rate.

**Important:** The quote obtained from `POST` [Spot Rate](https://docs.cambridgefx.com/#6499f440-a427-48df-b33a-825bec24de82) 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 '410 (Gone)', and you will need to generate a new quote.

* * *

##### IMPLEMENTATION NOTES:

Make sure to append the `/book` at the end of the resource.

The terms 'deal number' and 'order number' have the same meaning.

* * *

##### BOOK DEAL ERRORS

&lt;table>&lt;tbody>&lt;tr>&lt;th>Error Code&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>200 OK - Previously booked URL&lt;/td>&lt;td>The quoteID has already been booked so it can't be booked again. Returns: "token": "00000000-0000-0000-0000-000000000000"&lt;/td>&lt;/tr>&lt;tr>&lt;td>404 Not Found Invalid URL invoked&lt;/td>&lt;td>The 'Rate Resource' URL is incorrect. Either it has already been booked or it does not exist. This is the format: {{Rate Resource URL}}/book&lt;/td>&lt;/tr>&lt;tr>&lt;td>410 Gone - Call sent after rate expired&lt;/td>&lt;td>The rate generated by the &lt;b>POST&lt;/b> &lt;a href="https://docs.cambridgefx.com/#6499f440-a427-48df-b33a-825bec24de82">Spot Rate&lt;/a> request expires after 10 seconds.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

[2] Book Deal

Once the Spot Transaction has been booked, you can instruct the funds to a beneficiary or to 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 from 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.

**Note:** 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.

* * *

##### REQUEST BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>orderId&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Number of the deal to which the payment and settlement instructions should be applied.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.amount&lt;/td>&lt;td>&lt;b>number (required)&lt;/b>&lt;br>Payment amount.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.beneficiaryId&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Identifier of the beneficiary/FXBalance to whom the payment will be sent. Value can be either 'clientIntegrationId' or 'id' (which is returned by &lt;b>GET&lt;/b> &lt;a href="https://docs.cambridgefx.com/#834bd180-758c-45c2-80a0-073296e83946">View Bene&lt;/a>).&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.deliveryMethod&lt;/td>&lt;td>&lt;p>&lt;b>string (required)&lt;/b>&lt;br>Method to use to send the payment = ['W', 'E', 'C'].&lt;br>&lt;/p>&lt;ul>&lt;li>&lt;p>'W' = Wire&lt;/p>&lt;/li>&lt;li>&lt;p>'E' = EFT&lt;/p>&lt;/li>&lt;li>&lt;p>'C' = FXBalance&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.currency&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Three-letter ISO code for the payment currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.purposeOfPayment&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The purpose of payment. Can be found here: &lt;b>GET&lt;/b> &lt;a href="https://docs.cambridgefx.com/#39136fe2-5edc-4990-9010-ce4ea8354d9a">Purpose of Payment&lt;/a>&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.paymentReference&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>Reference to be included with the payment, for example, purchase order number or invoice number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.remitterId&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>Identifier of the remitter on whose behalf the payment is being made.&lt;/td>&lt;/tr>&lt;tr>&lt;td>settlements.accountId&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Settlement account identifier.&lt;/td>&lt;/tr>&lt;tr>&lt;td>settlements.deliveryMethod&lt;/td>&lt;td>&lt;p>&lt;b>string (required)&lt;/b>&lt;br>Method to use to settle the deal = ['W', 'E', 'C'].&lt;br>&lt;/p>&lt;ul>&lt;li>&lt;p>'W' = Wire&lt;/p>&lt;/li>&lt;li>&lt;p>'E' = EFT&lt;/p>&lt;/li>&lt;li>&lt;p>'C' = FXBalance&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>settlements.currency&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Three-letter ISO code for the settlement account currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>settlements.purpose&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The reason for the settlement = ['All', 'Allocation', 'Fee', 'Spot', 'SpotTrade', 'Drawdown'].&lt;/td>&lt;/tr>&lt;tr>&lt;td>orderDetail.entryDate&lt;/td>&lt;td>Timestamp of the deal when the order was entered.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.ordNum&lt;/td>&lt;td>Unique global identifier of the order.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.valueDate&lt;/td>&lt;td>Order value date.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.fees&lt;/td>&lt;td>Fee amount.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.paymentInstructionId&lt;/td>&lt;td>Internal Identifier of the Payment Instruction. Different from the Deal and/or Order Numbers.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.availableDate&lt;/td>&lt;td>The date when the payment will be received by the beneficiary.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.orderId&lt;/td>&lt;td>An internal identifier for the order. Different from the global 'ordNum'.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.amount&lt;/td>&lt;td>The amount paid to the beneficiary.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.currency&lt;/td>&lt;td>The currency in which the beneficiary will receive the payment.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.approvalStatus&lt;/td>&lt;td>&lt;p>An internal indicator of the payment status. Only relevant if there is an approval model set up with the account. Possible values:&lt;/p>&lt;ul>&lt;li>&lt;p>'A' - Approved&lt;/p>&lt;/li>&lt;li>&lt;p>'P' - Pending&lt;/p>&lt;/li>&lt;li>&lt;p>'D' - Declined&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.feeAmount&lt;/td>&lt;td>The amount of the fee levied on the payment.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.feeCurrency&lt;/td>&lt;td>Currency of the fee.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.estimateCostAmount&lt;/td>&lt;td>The cost of the settlement currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.estimateCostCurrency&lt;/td>&lt;td>The currency of the settlement part of the transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.beneId&lt;/td>&lt;td>The beneficiary's 'id' found in the &lt;b>GET&lt;/b> &lt;a href="https://docs.cambridgefx.com/#834bd180-758c-45c2-80a0-073296e83946">View Bene&lt;/a> endpoint.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.reference&lt;/td>&lt;td>Payment References carried on from the 'paymentReference' field in &lt;b>POST&lt;/b> &lt;a href="https://docs.cambridgefx.com/#f78752cf-6adf-4427-85a4-69dbc1288bc1">Instruct Deal&lt;/a>.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.method&lt;/td>&lt;td>&lt;p>Method to use to send the payment. Possible values returned = ['W', 'E', 'C'].&lt;/p>&lt;ul>&lt;li>&lt;p>'W' = Wire&lt;/p>&lt;/li>&lt;li>&lt;p>'E' = EFT&lt;/p>&lt;/li>&lt;li>&lt;p>'C' = FXBalance&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.payeeName&lt;/td>&lt;td>The name of the beneficiary/account to whom the payment will be sent.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.accountType&lt;/td>&lt;td>&lt;p>The out-going template type. Possible values returned:&lt;/p>&lt;ul>&lt;li>&lt;p>'bene' = Beneficiary&lt;/p>&lt;/li>&lt;li>&lt;p>'linkBalance' = FXBalance&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.payeeAccount&lt;/td>&lt;td>The account number of the payee account.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.accountId&lt;/td>&lt;td>Settlement account identifier.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.method&lt;/td>&lt;td>&lt;p>Method to use to settle the deal. Possible values returned = ['W', 'E', 'C'].&lt;/p>&lt;ul>&lt;li>&lt;p>'W' = Wire&lt;/p>&lt;/li>&lt;li>&lt;p>'E' = EFT&lt;/p>&lt;/li>&lt;li>&lt;p>'C' = FXBalance&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.methodDescription&lt;/td>&lt;td>&lt;p>The description for 'settlements.method'. Possible values returned = ['Wire', 'CLIAB', 'iACH'].&lt;/p>&lt;ul>&lt;li>&lt;p>'CLIAB' = FXBalance&lt;/p>&lt;/li>&lt;li>&lt;p>'iACH' = EFT&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.accountDetails&lt;/td>&lt;td>Displays the name on the account for the incoming template.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.paymentIdent&lt;/td>&lt;td>An internal identifier of the payment account. Not to be confused with the payment account identifier ('accountId') which is used when instructing the deal.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.settlementId&lt;/td>&lt;td>An internal identifier of the settlement account. Not to be confused with the settlement account identifier ('accountId') which is used when instructing the deal.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.isFee&lt;/td>&lt;td>Indicates whether the settlement account listed will also be used to settle the fee.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.amount&lt;/td>&lt;td>The settled amount of the transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.currency&lt;/td>&lt;td>Currency of the Settlement part of the transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.accountType&lt;/td>&lt;td>The template type used for settlement. Possible values returned = ['settlement'].&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetail.ordNum&lt;/td>&lt;td>The order number is the unique global identifier of the order.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetail.buy&lt;/td>&lt;td>ISO 3 currency code of the buy-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetail.buyAmount&lt;/td>&lt;td>Amount of the buy-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetail.sell&lt;/td>&lt;td>ISO 3 currency code of the sell-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetail.sellAmount&lt;/td>&lt;td>Amount of the sell-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetail.exchange&lt;/td>&lt;td>The quoted amount’s all-in rate as part of the spot transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetail.ourAction&lt;/td>&lt;td>Value is always set to 'Sell'. Denotes the action that Corpay undertakes to exchange the two currencies.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetail.token&lt;/td>&lt;td>The session token.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryAgencyName&lt;/td>&lt;td>Financial Institution responsible for investigating and resolving claims.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.transferFees&lt;/td>&lt;td>Transfer fee charged.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.transferFeesCurr&lt;/td>&lt;td>Transfer fee currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryPhone&lt;/td>&lt;td>Regulatory Financial Institution phone number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryEmail&lt;/td>&lt;td>Regulatory Financial Institution email address.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryWebsite&lt;/td>&lt;td>Regulatory Financial Institution website.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryAddressLine1&lt;/td>&lt;td>Regulatory Financial Institution address line 1.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryAddressLine2&lt;/td>&lt;td>Regulatory Financial Institution address line 2.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryAddressLine3&lt;/td>&lt;td>Regulatory Financial Institution address line 3.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedBy&lt;/td>&lt;td>The regulatory body that governs the Financial Institution. Possible values returned = ['State', 'Federal']&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedState&lt;/td>&lt;td>The regulatory state.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStatePhone&lt;/td>&lt;td>Phone number of the state regulator.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateEmail&lt;/td>&lt;td>Email address of the state regulator.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateWebsite&lt;/td>&lt;td>URL of the state regulator.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateAddressLine1&lt;/td>&lt;td>State regulator address line 1.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateAddressLine2&lt;/td>&lt;td>State regulator address line 2.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateAddressLine3&lt;/td>&lt;td>State regulator address line 3.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateAddressLine4&lt;/td>&lt;td>State regulator address line 4.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

##### INSTRUST DEAL ERRORS

&lt;table>&lt;tbody>&lt;tr>&lt;th>Error Code&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>400 Bad Request - Improper settlement account / wrong 'deliveryMethod'&lt;/td>&lt;td>Either the Client does not have the permission set to settle with this account type, or the account identifier invoked is incorrect.&lt;/td>&lt;/tr>&lt;tr>&lt;td>400 Bad Request - Improper bene / wrong 'deliveryMethod'&lt;/td>&lt;td>&lt;p>Could be one of the following:&lt;/p>&lt;ul>&lt;li>&lt;p>The identifier of the beneficiary invoked is incorrect (the 'clientIntegrationId' or 'id').&lt;/p>&lt;/li>&lt;li>&lt;p>The bene does not exist (therefore the 'id' or 'clientIntegrationId' that you are using is invalid).&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>400 Bad Request - Invalid / already-instructed Order Number&lt;/td>&lt;td>The order number has already been instructed or it doesn't belong to your account.&lt;/td>&lt;/tr>&lt;tr>&lt;td>400 Bad Request - Amount exceeds Spot balance&lt;/td>&lt;td>The order does not contain the funds available to pay the beneficiary. A top-up is not possible.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

[3] Instruct Deal

Allows you to view the following information for a specific order:

*   'regEDisclosure' - RegE Disclosure information (if applicable)
*   'payments' - beneficiary details
*   'settlements' - settlement details
*   'orderDetails' - rates, amounts, trade details, etc.
    

**Note:** If the order 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.

* * *

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryAgencyName&lt;/td>&lt;td>Financial Institution responsible for investigating and resolving claims.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.transferFees&lt;/td>&lt;td>Amount of transfer fees charged.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.transferFeesCurr&lt;/td>&lt;td>Transfer fee currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryPhone&lt;/td>&lt;td>Regulatory Financial Institution phone number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryEmail&lt;/td>&lt;td>Regulatory Financial Institution email address.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryWebsite&lt;/td>&lt;td>Regulatory Financial Institution website.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryAddressLine1&lt;/td>&lt;td>Regulatory Financial Institution address line 1.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryAddressLine2&lt;/td>&lt;td>Regulatory Financial Institution address line 2.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatoryAddressLine3&lt;/td>&lt;td>Regulatory Financial Institution address line 3.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedBy&lt;/td>&lt;td>The regulatory body that governs the Financial Institution. Possible values returned = ['State', 'Federal']&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedState&lt;/td>&lt;td>The regulatory state.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStatePhone&lt;/td>&lt;td>Phone number of the state regulator.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateEmail&lt;/td>&lt;td>Email address of the state regulator.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateWebsite&lt;/td>&lt;td>URL of the state regulator.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateAddressLine1&lt;/td>&lt;td>State regulator address line 1.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateAddressLine2&lt;/td>&lt;td>State regulator address line 2.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateAddressLine3&lt;/td>&lt;td>State regulator address line 3.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.regEDisclosure.regulatedStateAddressLine4&lt;/td>&lt;td>State regulator address line 4.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.paymentInstructionId&lt;/td>&lt;td>Internal Identifier of the Payment Instruction. Different from the Deal and/or Order Numbers.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.orderId&lt;/td>&lt;td>An internal identifier for the order. Different from the global 'ordNum'.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.amount&lt;/td>&lt;td>The amount paid to the beneficiary.&lt;/td>&lt;/tr>&lt;tr>&lt;/tr>&lt;tr>&lt;td>content.payments.currency&lt;/td>&lt;td>The currency in which the beneficiary will receive the payment.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.approvalStatus&lt;/td>&lt;td>&lt;p>An internal indicator of the payment status. Only relevant if there is an approval model set up with the account. Possible values:&lt;/p>&lt;ul>&lt;li>&lt;p>'A' - Approved&lt;/p>&lt;/li>&lt;li>&lt;p>'P' - Pending&lt;/p>&lt;/li>&lt;li>&lt;p>'D' - Declined&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.feeAmount&lt;/td>&lt;td>The amount of the fee levied on the payment.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.feeCurrency&lt;/td>&lt;td>Currency of the fee.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.estimateCostAmount&lt;/td>&lt;td>The cost of the settlement currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.estimateCostCurrency&lt;/td>&lt;td>The currency of the settlement part of the transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.beneId&lt;/td>&lt;td>The beneficiary's 'id' found in the &lt;b>GET&lt;/b> &lt;a href="https://docs.cambridgefx.com/#834bd180-758c-45c2-80a0-073296e83946">View Bene&lt;/a> endpoint.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.reference&lt;/td>&lt;td>Payment References carried on from the 'paymentReference' field in &lt;b>POST&lt;/b> &lt;a href="https://docs.cambridgefx.com/#f78752cf-6adf-4427-85a4-69dbc1288bc1">Instruct Deal&lt;/a>.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.method&lt;/td>&lt;td>&lt;p>Method to use to send the payment. Possible values returned = ['W', 'E', 'C'].&lt;/p>&lt;ul>&lt;li>&lt;p>'W' = Wire&lt;/p>&lt;/li>&lt;li>&lt;p>'E' = EFT&lt;/p>&lt;/li>&lt;li>&lt;p>'C' = FXBalance&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.payeeName&lt;/td>&lt;td>The name of the beneficiary/account to whom the payment will be sent.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.accountType&lt;/td>&lt;td>&lt;p>The out-going template type. Possible values returned:&lt;/p>&lt;ul>&lt;li>&lt;p>'bene' = Beneficiary&lt;/p>&lt;/li>&lt;li>&lt;p>'linkBalance' = FXBalance&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.payeeAccount&lt;/td>&lt;td>The account number of the payee account.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.clientIntegrationId&lt;/td>&lt;td>The unique beneficiary identifier.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payments.links&lt;/td>&lt;td>HATEOAS link to 'Bene Autocomplete Details'.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.accountId&lt;/td>&lt;td>Settlement account identifier.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.method&lt;/td>&lt;td>&lt;p>Method to use to settle the deal. Possible values returned = ['W', 'E', 'C'].&lt;/p>&lt;ul>&lt;li>&lt;p>'W' = Wire&lt;/p>&lt;/li>&lt;li>&lt;p>'E' = EFT&lt;/p>&lt;/li>&lt;li>&lt;p>'C' = FXBalance&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.methodDescription&lt;/td>&lt;td>&lt;p>The description for 'settlements.method'. Possible values returned = ['Wire', 'CLIAB', 'iACH'].&lt;/p>&lt;ul>&lt;li>&lt;p>'CLIAB' = FXBalance&lt;/p>&lt;/li>&lt;li>&lt;p>'iACH' = EFT&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.accountDetails&lt;/td>&lt;td>Displays the name on the account for the incoming template.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.paymentIdent&lt;/td>&lt;td>An internal identifier of the payment account. Not to be confused with the payment account identifier ('accountId') which is used when instructing the deal.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.settlementId&lt;/td>&lt;td>An internal identifier of the settlement account. Not to be confused with the settlement account identifier ('accountId') which is used when instructing the deal.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.isFee&lt;/td>&lt;td>Indicates whether the settlement account listed will also be used to settle the fee.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.amount&lt;/td>&lt;td>The settled amount of the transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.currency&lt;/td>&lt;td>Currency of the Settlement part of the transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.accountType&lt;/td>&lt;td>The template type used for settlement. Possible values returned = ['settlement'].&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlements.links&lt;/td>&lt;td>HATEOAS link to .Bene Autocomplete Details.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.entryDate&lt;/td>&lt;td>Timestamp of the deal when the order was entered.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.ordNum&lt;/td>&lt;td>The order number is the unique global identifier of the order.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.buy&lt;/td>&lt;td>ISO 3 currency code of the buy-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.buyAmount&lt;/td>&lt;td>Amount of the buy-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.sell&lt;/td>&lt;td>ISO 3 currency code of the sell-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.sellAmount&lt;/td>&lt;td>Amount of the sell-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.exchange&lt;/td>&lt;td>The quoted amount’s all-in rate as part of the spot transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.ourAction&lt;/td>&lt;td>Value is always set to 'Sell'. Denotes the action that Corpay undertakes to exchange the two currencies.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.orderDetails.token&lt;/td>&lt;td>The session token.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.rate.rateType&lt;/td>&lt;td>The currency pair used in the rate calculation.&lt;br>&lt;b>Note:&lt;/b> The second currency in the pair is the more major of the two in Corpay's internal ranking.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

Lookup Orders

When you run the Spot Rate call `POST` [Spot Rate](https://docs.cambridgefx.com/#6499f440-a427-48df-b33a-825bec24de82), a resource is created that contains the conversion and quote information. This endpoint returns the resource details.

* * *

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.id&lt;/td>&lt;td>The quote's resource identifier.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.expiry&lt;/td>&lt;td>The number of seconds before the quote expires.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.isOverLimit&lt;/td>&lt;td>Indicates whether the amount on the booked deal exceeds the trade limit allowed on the account.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.quoteTimestamp&lt;/td>&lt;td>Timestamp when the quote was called.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.expiryTimestamp&lt;/td>&lt;td>Timestamp when the quote expires ('quoteTimeStamp' + 'expiry').&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payment.currency&lt;/td>&lt;td>Currency of the payment.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.payment.amount&lt;/td>&lt;td>Amount of the payment.&lt;/td>&lt;/tr>&lt;tr>&lt;/tr>&lt;tr>&lt;td>content.settlement.currency&lt;/td>&lt;td>Currency of the settlement.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.settlement.amount&lt;/td>&lt;td>Amount of the settlement.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.rate.value&lt;/td>&lt;td>The result of the 'lockside' amount and the operation 'type' (as either a &lt;i>multiple&lt;/i> or a &lt;i>quotient&lt;/i>).&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.rate.lockSide&lt;/td>&lt;td>The base currency of the pair; the opposite of the quoted currency. The value can be 'payment' or 'settlement'.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.rate.rateType&lt;/td>&lt;td>The currency pair used in the rate calculation.&lt;br>&lt;b>Note:&lt;/b> The second currency in the pair is the more major of the two in Corpay's internal ranking.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.expiryRemaining&lt;/td>&lt;td>The number of seconds left between booking the rate and the rate expiry ('Book' - 'expiryTimestamp')&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.requestDuration&lt;/td>&lt;td>The duration of the call between the 'quoteTimestamp' and 'Booking'&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.rateDifferential&lt;/td>&lt;td>The differential in interest rates between the two currencies.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

Rate Resource

This call lists all of the 'Get Rate' requests – `POST` [Spot Rate](https://docs.cambridgefx.com/#6499f440-a427-48df-b33a-825bec24de82) – 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.

Quotes

Indicative Rate

A Rate Order is an order to buy or sell currency at a specific rate or better. If the target rate becomes available before the order's expiry date, the system will automatically book the deal. You can create Rate Orders for spot trades and for forward trades.&lt;br />&lt;br />
&lt;b>Important:&lt;/b> A Rate Order is not guaranteed to fill.

Rate Orders

Creates a new Rate Order. You can create Spot Rate Orders  and Forward Rate Orders. 
&lt;br />&lt;br />
Forward Rate Orders can be either Closed Forwards or Open Forwards.
&lt;br />
----
&lt;br />

##### REQUEST BODY 

&lt;table style="width:100%">
  &lt;tr>
    &lt;th align="left">Parameter&lt;/th>
    &lt;th align="left">Description&lt;/th>
  &lt;/tr>
  &lt;tr>
    &lt;td>buyCurrency&lt;/td>
    &lt;td>&lt;b>string (required)&lt;/b>&lt;br />The three-letter ISO code for the buy currency.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>sellCurrency&lt;/td>
    &lt;td>&lt;b>string (required)&lt;/b>&lt;br />The three-letter ISO code for the sell currency.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>amount&lt;/td>
    &lt;td>&lt;b>number (required)&lt;/b>&lt;br />The amount of the buy currency.&lt;/td>&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>rate&lt;/td>
    &lt;td>&lt;b>string (required)&lt;/b>&lt;br />The rate at which you want the Rate Order to be filled.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>expiryDate&lt;/td>
    &lt;td>&lt;b>string (required)&lt;/b>&lt;br />The date when the Rate Order expires.&lt;/td>
  &lt;/tr>
   &lt;tr>
    &lt;td>lockSide&lt;/td>
    &lt;td>&lt;b>string (required)&lt;/b>&lt;br />Indicates which currency to lock when the rate calculation is performed = ['Payment' or 'Settlement'].&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>limitOrderType&lt;/td>
    &lt;td>&lt;b>string (required)&lt;/b>&lt;br />The type of Rate Order = ['Spot' or 'Forward']. &lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>openDateFrom&lt;/td>
    &lt;td>&lt;b>string (required if 'limitOrderType' = 'Forward' and 'forwardType' = 'O')&lt;/b>&lt;br />The first date that you can draw down against the forward, formatted as &lt;i>yyyy-mm-dd&lt;/i>.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>maturityDate&lt;/td>
    &lt;td>&lt;b>string (required if 'limitOrderType' = Forward)&lt;/b>&lt;br />The last date the funds can be used, formatted as &lt;i>yyyy-mm-dd&lt;/i>.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>forwardType&lt;/td>
    &lt;td>&lt;b>string (required if 'limitOrderType' = 'Forward')&lt;/b>&lt;br />The type of Forward Rate Order = ['O' or 'C'].&lt;ul>&lt;li>'O' - Open&lt;/li>&lt;li>'C' - Closed&lt;/li>&lt;/ul>&lt;/td>
  &lt;/tr>
&lt;/table>


&lt;br />
&lt;br />

Create Rate Order

Retrieves complete information for all of your Rate Orders.&lt;br />

----
&lt;br />

##### RESPONSE BODY 

&lt;table style="width:100%">
  &lt;tr>
    &lt;th align="left">Parameter&lt;/th>
    &lt;th align="left">Description&lt;/th>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.id&lt;/td>
    &lt;td>The Rate Order identifier.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.productType&lt;/td>
    &lt;td>The type of Rate Order. Possible values = ['Spot' or 'Forward']&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.buy&lt;/td>
    &lt;td>The three-letter ISO code for the buy currency.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.sell&lt;/td>
    &lt;td>The three-letter ISO code for the sell currency.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.buyAmount&lt;/td>
    &lt;td>The amount of the buy currency.&lt;/td>
  &lt;/tr>
   &lt;tr>
    &lt;td>content.rows.sellAmount&lt;/td>
    &lt;td>The amount of the sellcurrency.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.status&lt;/td>
    &lt;td>The status of the Rate Order. Possible values = ['F', 'P', 'E', 'X'].&lt;ul>&lt;li>'F' - Filled&lt;/li>&lt;li>'P' - Pending&lt;/li>&lt;li>'E' - Expired&lt;/li>&lt;li>'X' - Deleted&lt;/li>&lt;/ul>
&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.entryDate&lt;/td>
    &lt;td>The date that the order was created, formatted as &lt;i>yyyy-mm-dd&lt;/i>.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.filledDate&lt;/td>
    &lt;td>The date the order was filled, formatted as &lt;i>yyyy-mm-dd&lt;/i>.&lt;br />If the order is pending, returns null.&lt;/td>
  &lt;/tr>
  &lt;tr>
    &lt;td>content.rows.targetRate&lt;/td>
    &lt;td>The rate at which the Rate Order can be filled.&lt;/td>
  &lt;/tr>
  &lt;tr>
     &lt;td>content.rows.expiryDate&lt;/td>
     &lt;td>The date when the Rate Order  expires.&lt;/td>
   &lt;/tr>
  
&lt;/table>

&lt;br />
&lt;br />

View Rate Orders

This endpoint permanently deletes the specified Rate Order. You cannot delete more than one Rate Order at the same time.

Delete Rate Order

Forward trades allow you to lock in to a specific exchange rate. You can then draw down against the forward to make payments at a future date. 

Forwards and Drawdowns

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 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')

Forwards

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.

Drawdowns

The cancellation workflow creates a ‘mirror-reverse’ transaction for the deal you are cancelling. For example, the cancellation of a USD/CAD spot deal is a CAD/USD transaction. When you provide the order number of the original Spot, the rest of the information is invoked (such as amounts and currencies).

Orders created via Spot and Forward workflows can be cancelled.

Just as the `POST` [Spot Rate](https://docs.cambridgefx.com/#6499f440-a427-48df-b33a-825bec24de82) and `POST` [Book Deal](https://docs.cambridgefx.com/#3bc872ce-26ad-45cb-8b70-b0a1e7e58434) workflow has a timer, `Request Cancellation` and `Book Cancellation` also has an allotted window of time (the default is 10 seconds).

**Note:** There is no timer between when you book a deal and when you can cancel it, however, we recommend that you request the cancellation within a reasonable time, taking into account currency fluctuations.

Cancel Order

To use this call, you need to have an 'orderNumber', that is, you need to have booked a quote.

The endpoint uses the order number in the URL to idenfity the currencies and amounts of the order you want to cancel. Unlike `POST` [Spot Rate](https://docs.cambridgefx.com/#6499f440-a427-48df-b33a-825bec24de82), there is no quote resource created by calling this endpoint. This is because the rate of the initial transaction is used.

The response contains the link to the `POST` [Book Cancellation](https://docs.cambridgefx.com/#8eab595d-28b4-4d1e-ad3c-9adb2fe5f9c0).

**Note:** If the client 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), 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.
    

* * *

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.trades.originalTrade.buyAmount&lt;/td>&lt;td>Amount of the buy-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.trades.originalTrade.buyCurrency&lt;/td>&lt;td>ISO currency code of the buy-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.trades.originalTrade.costAmount&lt;/td>&lt;td>Amount of the sell-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.trades.originalTrade.costCurrency&lt;/td>&lt;td>ISO currency code of the sell-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.trades.charge.amount&lt;/td>&lt;td>The amount that is charged for carrying out the cancellation transaction (if applicable).&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.trades.charge.currency&lt;/td>&lt;td>The currency of the charge levied on the cancellation. The currency is the settlement currency.&lt;br>Amount of the sell-side currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.trades.cancelRate.value&lt;/td>&lt;td>The value of the cancellation rate.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.trades.cancelRate.rateType&lt;/td>&lt;td>The currency pair used in the rate calculation.&lt;br>&lt;b>Note:&lt;/b> The second currency in the pair is the more major of the two in Corpay's internal ranking.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

Request Cancellation

The link for Book Cancellation is provided in the response body of the `POST` [Request Cancellation](https://docs.cambridgefx.com/#d3265839-363d-4606-9f87-f316089522ad). If this endpoint is successful, an order number is granted.

Book Cancellation

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. FXBalance Accounts or Corpay holding account templates are not created in this same way.

Settlement Accounts

This endpoint enables you to view all settlement accounts for this client.

View Template

This call returns a list of the Corpay FXBalances (also known as Holding Balances) for this client. FXBalances are internal holding balances for currency-specific deposits. They are an alternative settlement option.

**Note:** FXBalances cannot be created via API. They are created using a back-office procedure.

* * *

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.data.rows.account&lt;/td>&lt;td>Name of the account.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.currency&lt;/td>&lt;td>Three-letter ISO currency code.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.ledgerBalance&lt;/td>&lt;td>The amount that was in the FXBalance at the end of the previous business day.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.balanceHeld&lt;/td>&lt;td>The amount in the FXBalance that is allocated to cover payments that have been scheduled but are still incomplete or outstanding.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.availableBalance&lt;/td>&lt;td>The amount that is available to use. Ledger Balance value minus Balance Held value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.accountNumber&lt;/td>&lt;td>Holding account number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.clientCode&lt;/td>&lt;td>Identifies the client in a client/division hierarchy.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.clientDivisionId&lt;/td>&lt;td>Identifies the division in a client/division hierarchy.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.links&lt;/td>&lt;td>HATEOAS links to the Corpay Cross-Border Account Details page.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.id&lt;/td>&lt;td>FXBalance account number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.text&lt;/td>&lt;td>FXBalance account number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.curr&lt;/td>&lt;td>Three-letter ISO currency code.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.currText&lt;/td>&lt;td>Currency code and currency name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.account&lt;/td>&lt;td>Name of the account.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.ledgerBalance&lt;/td>&lt;td>The amount that was in the FXBalance at the end of the previous business day.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.balanceHeld&lt;/td>&lt;td>The amount in the FXBalance that is allocated to cover payments that have been scheduled but are still incomplete or outstanding.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.availableBalance&lt;/td>&lt;td>The amount that is available to use. Ledger Balance value minus Balance Held value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.allowedPayment&lt;/td>&lt;td>The amount that is available to use.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.client&lt;/td>&lt;td>Identifies the client in a client/division hierarchy.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.branchld&lt;/td>&lt;td>Identifies the division in a client/division hierarchy.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.accountName&lt;/td>&lt;td>Name of the account.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.items.links&lt;/td>&lt;td>HATEOAS links to the Corpay Cross-Border Account Details page.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

View Multi-Currency Accounts

This call returns the transaction history of the specified FXBalance.

* * *

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.data.pagination.total&lt;/td>&lt;td>Total number of transactions related to the specified FXBalance during the specified period.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.pagination.skip&lt;/td>&lt;td>Number of transactions skipped.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.pagination.take&lt;/td>&lt;td>Number of transactions returned.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.links&lt;/td>&lt;td>HATEOAS link to the Corpay Cross-Border Account Details page.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.orderNumber&lt;/td>&lt;td>The deal number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.date&lt;/td>&lt;td>Transaction date.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.amount&lt;/td>&lt;td>Amount deducted from the FXBalance.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.isPosted&lt;/td>&lt;td>&lt;p>Specifies whether the record has been posted.&lt;/p>&lt;ul>&lt;li>&lt;p>0 = Not posted&lt;/p>&lt;/li>&lt;li>&lt;p>1 = Posted&lt;/p>&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.balance&lt;/td>&lt;td>Amount remaining in the FXBalance.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.data.rows.links&lt;/td>&lt;td>HATEOAS link to the order.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.balance.rows.date&lt;/td>&lt;td>Business date(s) during the specified period.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.balance.rows.balance&lt;/td>&lt;td>FXBalance value at the end of the above date.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

Multi-Currency Accounts History

Incoming Funds Details

Manage Multi-Currency Accounts Nickname

Remitters are used when a payment is initiated by a third party. This endpoint allows you to create the remitters that can then be attached to payments.

Remitter

Remitters are used when a payment is initiated by a third party. This endpoint allows you to create the remitters that can then be attached to payments.

Similar to the `POST` [Create/Edit Bene](https://docs.cambridgefx.com/#36685106-4a23-48e8-b518-d98d869dbc85) call, the PUT method is used for better error handling due to idempotency of PUT requests. The URL query string contains the Remitter ID, which must be unique. You can either use [GUID](https://guidgenerator.com/) as it has very low chance of collision, your own hash, or some deterministic prefix in order to make sure it is unique.

**Note:** The only characters allowed in the 'uniqueRemitterId' are alphanumeric (a-zA-Z0-9), dash (-), and underscore (_).

* * *

##### REQUEST BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>classification&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Can be 'individual' or 'corporation'.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The full name of the remitter.&lt;/td>&lt;/tr>&lt;tr>&lt;td>dateOfBirth&lt;/td>&lt;td>&lt;b>string (required for individuals)&lt;/b>&lt;br>The remitter's date of birth. Use the format &lt;i>yyyy-mm-dd&lt;/i>.&lt;/td>&lt;/tr>&lt;tr>&lt;td>addressLine1&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The first line of the remitter's address.&lt;/td>&lt;/tr>&lt;tr>&lt;td>addressLine2&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>The second line of the remitter's address.&lt;/td>&lt;/tr>&lt;tr>&lt;td>city&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The remitter's city.&lt;/td>&lt;/tr>&lt;tr>&lt;td>province&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The remitter's province.&lt;/td>&lt;/tr>&lt;tr>&lt;td>countryISO2&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The remitter's two-letter ISO country code.&lt;/td>&lt;/tr>&lt;tr>&lt;td>postalCode&lt;/td>&lt;td>&lt;b>string (required for Canada or the United States)&lt;/b>&lt;br>The remitter's postal code.&lt;/td>&lt;/tr>&lt;tr>&lt;td>emailAddress&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>The remitter's email address.&lt;/td>&lt;/tr>&lt;tr>&lt;td>occupation&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>The remitter's occupation.&lt;/td>&lt;/tr>&lt;tr>&lt;td>relationshipToYourCompany&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>The remitter's relationship to your company.&lt;/td>&lt;/tr>&lt;tr>&lt;td>incorporationNumber&lt;/td>&lt;td>&lt;b>string (required for corporations)&lt;/b>&lt;br>The remitter's incorporation number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>incorporationPlaceOfIssue&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>The corporation's place of issue.&lt;/td>&lt;/tr>&lt;tr>&lt;td>incorporationType&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>The type of corporation.&lt;/td>&lt;/tr>&lt;tr>&lt;td>incorporationInstitutionNumber&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>The institution number for the corporation.&lt;/td>&lt;/tr>&lt;tr>&lt;td>bankName&lt;/td>&lt;td>&lt;b>string (required for FIs)&lt;/b>&lt;br>The remitter's bank name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>bankCode&lt;/td>&lt;td>&lt;b>string (required for FIs)&lt;/b>&lt;br>The remitter's bank code.&lt;/td>&lt;/tr>&lt;tr>&lt;td>phoneHome&lt;/td>&lt;td>&lt;b>integer (optional)&lt;/b>&lt;br>The remitter's home number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>phoneBusiness&lt;/td>&lt;td>&lt;b>integer (optional)&lt;/b>&lt;br>The remitter's business number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>phoneFax&lt;/td>&lt;td>&lt;b>integer (optional)&lt;/b>&lt;br>The remitter's fax number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>accountNumber&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The remitter's bank account number.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

Remitter Add/Edit

This call retrieves the details of a remitter.

**Note:** The URL is exactly the same as `PUT` [Remitter Add/Edit](https://docs.cambridgefx.com/#e3f0f5fb-c581-4eab-a485-fb0ed8bd9d33), which creates or modifies a remitter, but this is a `GET` call rather than a `PUT`.

Remitter Retrieve

The Mass Payment workflow is a two-step payment-aggregation workflow designed to make payments to multiple beneficiaries at the same time, using a single call. 

The only limitation is the currency-specific account limit of any currency being used for settlement (as outlined in the onboarding agreement).


Mass Payments

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.

In order to secure the rate(s), you must execute the next call, `POST` [Book Multiple Payments](https://docs.cambridgefx.com/#6a89e705-8a9a-4046-ba8e-1f62f916f55f), before the rate expires (usually 10 seconds).

* * *

##### REQUEST BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>payments.beneficiaryId&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The identifier of the beneficiary or the FXBalance to which the payment will be sent. For beneficiaries, use the 'persistentId' value which can be found by using the &lt;b>GET&lt;/b> &lt;a href="https://docs.cambridgefx.com/#834bd180-758c-45c2-80a0-073296e83946">View Bene&lt;/a> endpoint.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.paymentMethod&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Method to use to send the payment = ['Wire', 'EFT', 'StoredValue'].&lt;br>'StoredValue' = FXBalance&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.amount&lt;/td>&lt;td>&lt;b>number (required)&lt;/b>&lt;br>Payment amount.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.lockside&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Indicates the base currency (of the currency pair), on which the rate calculation is based = ['payment', 'settlement'].&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.paymentCurrency&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The three-letter ISO code for the payment currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.settlementCurrency&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The three-letter ISO code for the settlement currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.settlementAccountId&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Settlement account identifier.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.settlementMethod&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>Method to use to settle the deal = ['Wire', 'EFT', 'StoredValue'].&lt;br>'StoredValue' = FXBalance&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.paymentReference&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b>&lt;br>Reference to be included with the payment. For example, purchase order number or invoice number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.purposeOfPayment&lt;/td>&lt;td>&lt;b>string (required)&lt;/b>&lt;br>The purpose of payment. Can be found by using &lt;b>GET&lt;/b> &lt;a href="https://docs.cambridgefx.com/#39136fe2-5edc-4990-9010-ce4ea8354d9a">Purpose of Payment&lt;/a>.&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.remitterId&lt;/td>&lt;td>&lt;b>string (required if payment is initiated by a third party)&lt;/b>&lt;br>Remitter ID&lt;/td>&lt;/tr>&lt;tr>&lt;td>payments.deliveryDate&lt;/td>&lt;td>&lt;b>string (optional)&lt;/b> The date the payment will be delivered to the beneficiary, formatted as &lt;i>yyyy-mm-dd&lt;/i>.&lt;br>Note: The maximum delivery date is three months from the entry date.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.paymentSummary.paymentCurrency&lt;/td>&lt;td>The three-letter ISO code for the payment currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.paymentSummary.amountTotal&lt;/td>&lt;td>Total amount paid to the beneficiary.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.paymentSummary.settlementCurrency&lt;/td>&lt;td>The three-letter ISO code for the settlement account currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.paymentSummary.settlementAmount&lt;/td>&lt;td>Amount being settled.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.paymentSummary.rate&lt;/td>&lt;td>The rate figure provided is the factor between the lockside and the quote currency.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.paymentSummary.rateType&lt;/td>&lt;td>The currency pair used in the rate calculation.&lt;br>&lt;b>Note:&lt;/b> The second currency in the pair is the more major of the two in Corpay's internal ranking.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.paymentSummary.count&lt;/td>&lt;td>The total number of payments going to the same beneficiary within this call.&lt;/td>&lt;/tr>&lt;tr>&lt;td>content.paymentSummary.lockSide&lt;/td>&lt;td>The currency on which the rate calculation is based = ['payment', 'settlement']&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

Multiple Payments

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](https://docs.cambridgefx.com/#f270a6e2-a6c4-4e6a-973e-de5702fc5e4e)) under 'BOOK_PAYMENT'.

**Important:** The quote obtained from `POST` [Multiple Payments](https://docs.cambridgefx.com/#f270a6e2-a6c4-4e6a-973e-de5702fc5e4e) 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 '410 (Gone)'. If that happens, you will need to generate a new quote.

**Note:** The 'quoteKey', and 'loginSessionId' params are contained in the URL, which is a unique feature to this workflow.

* * *

##### REQUEST BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>combineSettlements&lt;/td>&lt;td>&lt;b>boolean (optional)&lt;/b>&lt;br>Specifies whether to combine any associated fees into a single deduction. The default is 'false'.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

##### RESPONSE BODY

&lt;table>&lt;tbody>&lt;tr>&lt;th>Parameter&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>content.orderNumber&lt;/td>&lt;td>The unique global identifier for the order.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

Book Multiple Payments

Payment Tracking

Payment Channel Information

Payment Tracking Lookup

Client Onboarding

Onboard Client

Reference Data

Webhooks

Subscribe to Webhooks

Receive Webhooks Notifications

Troubleshoot Notifications

Supported Events

Guides

Release Notes

Corpay Cross-Border API Documentation v1.8

v1.8

PRODUCTION

SANDBOX

Annual Volume Range

Applicant Type

Assign/Edit Multi-Currency Account Nickname

Bank Search

Beneficiary Rules

Beneficiary Validation

Create/Edit Bene

Delete Bene

Search Benes

View Bene

IBAN Validation

Purpose of Payment

Regions

Business Type

AuthSecret Keys

Onboarding Parameters Reference

Submit Onboarding Files

Mandatory Documents Required for Onboarding

Onboarding Picklists

Client Intends To Use Corpay Account To

Expected Frequency of Transactions

Id Type

Nature Of Business

Purpose Of Transaction

Routing

Settlement Method

Source Of Funds

Source Of Wealth

Total Assets or Net Worth

Trade Volume Range

Exceptions Events

Book Drawdown

Forward Guidelines

Forward Instructions

Retrieve Forward Quote

[1] Request Forward Quote

[2] Book Forward Quote

[3] Complete Order

Incoming Funds Events

Multi-Currency Account Nickname

Payment Events

Payment Tracking Response

Reference Section

View Rate Order Response

Reset Multi-Currency Account Nickname

Client Onboarding Events

<p class="slate-p slate-indent-0" style="0px">Our RESTful API suite employs <strong class="slate-bold">OAuth2.0</strong> standard authorization framework, which consists of a two-part flow that involves exchanging an HS256-signed JWT token for a <code class="slate-code">CMG-AccessToken</code>.</p><p class="slate-p " >The partner-level and the client-level work in the following way: </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Given <code class="slate-code">Issuer</code> - either the name of the Partner/Client ID (contained in the Claim Set) - and the Signature, you create an encoded JWT Token (hashed via HS256), which is inserted into the body of the request of this call (in the <code class="slate-code">assertion </code>field).</div></li><li class="slate-li " ><div style="position:relative">When creating the token, the <code class="slate-code">issued-at</code> and the <code class="slate-code">expiration </code>should be current and advisably set apart at an interval of 20 minutes, respectively. The <code class="slate-code">aud</code> value must always be set to <code class="slate-code">cambridgefx</code>.</div></li><li class="slate-li " ><div style="position:relative">Once the call is placed, the response provides an <code class="slate-code">access_code</code> which will be submitted to the <code class="slate-code">CMG-AccessToken</code> field in the header of the subsequent (Client-Level) requests. Since there is no call preceding the partner-level, there is no need to pass anything through <code class="slate-code">CMG-AccessToken</code> for the partner-level.</div></li></ul><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><p class="slate-p " ></p><h5 class="slate-h5 " ></h5><p class="slate-p " ></p><p class="slate-p " >

</p><p class="slate-p " ></p>

 standard authorization framework, which consists of a two-part flow that involves exchanging an HS256-signed JWT token for a 

The partner-level and the client-level work in the following way: 

JWT audience (aud) value of 'cambridgefx' was expected. Make sure that the audience ("aud") is set to "cambridgefx" (in the JWT claimset).

400 Bad Request - Invalid value for audience

This error is the result of setting the token too far into the future. The threshold is approximately 24 hours after the issue.


400 Bad Request - 'exp' token is set too far into the future

User not found or partner access not configured. Check the "error_description" parameter for more information.

400 Bad Request - Invalid Issuer (either Partner or User)

The auth key or signature must be current; otherwise, the token will not be signed properly that can't be charged for some reason.

400 Bad Request - Invalid signature key

Token expired. 
Regenerate token, and as a general rule, it is recommended to use 'current time + 20 minutes' as your expiry date/time.


400 Bad Request - JWT Token is expired

<p class="slate-p " >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:</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:#252c3e"><code class="slate-code">access_code</code></span><span style="color:#252c3e"> from the Partner Auth goes in the </span><span style="color:#252c3e"><code class="slate-code">CMG-AccessToken</code></span><span style="color:#252c3e"> Header of this API.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:#252c3e">API user ID is the </span><span style="color:#252c3e"><code class="slate-code">iss</code></span><span style="color:#252c3e">  (issuer) in the JWT token. </span></div></li></ul></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="color:#252c3e">The </span><span style="color:#252c3e"><code class="slate-code">access_code</code></span><span style="color:#252c3e"> granted at the Client-level will be submitted to the </span><span style="color:#252c3e"><code class="slate-code">CMG-AccessToken</code></span><span style="color:#252c3e"> field in the Header of the subsequent calls in the current user session. </span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:#252c3e"><code class="slate-code">access_code</code></span><span style="color:#252c3e"> expiry time is indicated by the parameter </span><span style="color:#252c3e"><code class="slate-code">expires_in</code></span><span style="color:#252c3e"> (in seconds) in the response body. </span></div></li><li class="slate-li " ><div style="position:relative"><span style="color:#252c3e">Expiry of the </span><span style="color:#252c3e"><code class="slate-code">access_code</code></span><span style="color:#252c3e"> can accommodate different use cases.</span></div></li></ul></div></div><p class="slate-p " ></p>

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:

assertion

`urn:ietf:params:oauth:grant-type:jwt-bearer`

grant_type

Content-Type

CMG-AccessToken

Session token for all subsequent calls in the current user session

Sections

Client-level Token Login

Header Parameters

Body Parameters

What made this section unhelpful for you?

Response

What made this section unhelpful for you?