Corpay

Corpay Cross-Border API uses HATEOAS (Hypertext As The Engine Of Application State) framework. This means all response copy with and element `links`. This provides a link on the current resource as well as all actions that can be taken from there.

Response to APIs, once authenticated, are displayed in the following model

``` javascript
  {
    "content": {},
    "errors": [],
    "links": [
        {
            "rel": "self",
            "uri":   "https://crossborder.corpay.com/api/{endpoint}}",
            "method": {POST GET or PUT}
        }
    ]
  }

```

where content and errors are provided in the appropriate lists. Links always contain a `SELF` link to the current endpoint, and any additional links, depending on the state of the resource. For example a beneficiary object can be viewed and modified.

# Common Terms

&lt;ul>&lt;li>&lt;p>Client Code - A unique 6-digit client identifier for each client account. Used in all endpoints as part of URL.&lt;/p>&lt;/li>&lt;li>&lt;p>Partner ID - Links multiple client accounts together. Used during authentication procedure.&lt;/p>&lt;/li>&lt;li>&lt;p>Payment - Outgoing cashflow to a beneficiary.&lt;/p>&lt;/li>&lt;li>&lt;p>Settlement - Incoming cashflow to Corpay.&lt;/p>&lt;/li>&lt;/ul>

# Base URL

The documentation for each endpoint displays the HTTP method and the end path. Before you submit the request, you need to prepend the base path to get the full resource URL. All endpoints referenced in the documentation require the following base path: [https://https://crossborder.corpay.com](https://https://crossborder.corpay.com).

**Note:** Depending on the stage of your implementation, the base path may be slightly different. For staging, pre-production, QA, and testing, use [https://crossborder.beta.corpay.com](https://crossborder.beta.corpay.com) to point to the Beta environment.

Curly braces are used as a placeholder and indicate the type of value that you need to supply. For instance, where you see {clientCode} in the resource, you need to replace that string with your client code.

For example, in the documentation, endpoints look similar to this:

`GET /api/{clientCode}/0/benes/{beneID}`

When you add the base path, your client code, and any parameters, the result is a well-formed REST URL that looks something like this:

`GET https://crossborder.corpay.com/api/123456/0/benes/jsmith321`

# Response Codes

Most of the endpoints include examples for both successful and unsuccessful responses. In the Example Request, click the downward arrow beside the response code to view additional examples.

Corpay Cross-Border uses conventional HTTP response codes to indicate the success or failure of an API request.

&lt;table>&lt;tbody>&lt;tr>&lt;th>Response Code&lt;/th>&lt;th>Description&lt;/th>&lt;/tr>&lt;tr>&lt;td>2&lt;i>xx&lt;/i>&lt;/td>&lt;td>Success.&lt;/td>&lt;/tr>&lt;tr>&lt;td>4&lt;i>xx&lt;/i>&lt;/td>&lt;td>&lt;p>Client error. This is usually due to missing or incorrect information, for example, a missing or incorrect parameter or value.&lt;/p>&lt;ul>&lt;li>&lt;p>401 - Authorization issue. This usually means that the authorization token has expired and you need to refresh it.&lt;/p>&lt;/li>&lt;li>&lt;p>410 - Rate resource expired. Due to currency fluctations, quotes are valid for a very limited period of time. When you get a 410 error, it means that the rate resource you're trying to use has expired and you need to generate a new quote.&lt;/p>&lt;/li>&lt;ul>&lt;/ul>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>5&lt;i>xx&lt;/i>&lt;/td>&lt;td>Server error. If the error persists, contact Corpay Tier 2 support.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>

Introduction

What's New

2025 Updates

2024 Updates

2023 Updates

Common Terms

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

The endpoints in this section are used to create functional beneficiary templates that comply with all country-specific regulatory requirements.

Beneficiary Workflow

The first call, `Beneficiary Rules`, outlines _what_ is required for the beneficiary template, `Create/Edit Bene` creates the template, and `View Bene` allows you to view the template.

Beneficiary Core

These endpoints assist with the creation and lookup of beneficiary information.

IBAN Validation is recommended for use in IBAN enabled countries, while Bank Search is for countries that do not support IBAN.

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

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

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

Set up Webhooks

Subscribe to Webhooks

Receive Webhook notifications

Troubleshoot notifications

Supported events

Corpay Cross-Border API Documentation v1.8

PRODUCTION

SANDBOX

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

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.

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 

 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.

<p class="slate-p slate-indent-0" style="0px">Corpay Cross-Border&apos;s suite of API services and functionality is continuously growing in which we deploy multiple releases throughout the year. To discover what&apos;s new with Corpay&apos;s API, read our What&apos;s New section that detail the most recent API enhancements and updates.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p slate-indent-0" style="0px">Discover our latest product launches, in-depth API release notes, and additional resources by visiting our <a href="https://cross-border.corpay.com/api-resources/" target="_blank">API Resources</a> page. Stay informed about the newest updates and enhancements to make the most of our API offerings.</p></div></div><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px">
</p><p class="slate-p " ></p><p class="slate-p " ></p>

Corpay Cross-Border's suite of API services and functionality is continuously growing in which we deploy multiple releases throughout the year. To discover what's new with Corpay's API, read our What's New section that detail the most recent API enhancements and updates.

<p class="slate-p " ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Client Code</strong> - A unique 6-digit client identifier for each client account. Used in all endpoints as part of URL.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Partner ID</strong> - Links multiple client accounts together. Used during the authentication procedure.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Client Integration ID</strong>- Unique beneficiary ID that you can use in other endpoints.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Tracker ID</strong> - The unique tracker identifier assigned to a payment transaction.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Payment</strong> - Outgoing cashflow to a beneficiary.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Settlement</strong> - Incoming cashflow to Corpay.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">MCA</strong> - Multi-Currency Accounts (Formerly known as FXBalance/CLIAB)</div></li></ul><p class="slate-p " ></p></p><p class="slate-p " ></p>

<p class="slate-p " >The documentation for each endpoint displays the HTTP method and the end path. Before submitting the request, you must prepend the base path to get the full resource URL. All endpoints referenced in the documentation require the following base path: <a href="https://https://crossborder.corpay.com" target="_self"><code class="slate-code">https://crossborder.corpay.com</code></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 ><p class="slate-p " >Depending on the stage of your implementation, the base path may be slightly different. For staging, pre-production, QA, and testing, use <a href="https://crossborder.beta.corpay.com" target="_self"><code class="slate-code">https://crossborder.beta.corpay.com</code></a> to point to the Beta environment.</p></div></div><p class="slate-p " >Curly braces are used as a placeholder and indicate the type of value that you need to supply. For instance, where you see <code class="slate-code">{clientCode}</code> in the resource, you must replace that string with your client code.</p><p class="slate-p " >For example, in the documentation, endpoints look similar to this:</p><p class="slate-p slate-indent-0" style="0px"><code class="slate-code">GET /api/{clientCode}/0/benes/{beneID}</code></p><p class="slate-p " >When you add the base path, your client code, and any parameters, the result is a well-formed REST URL that looks something like this:</p><p class="slate-p slate-indent-0" style="0px"><code class="slate-code">GET https://crossborder.corpay.com/api/123456/0/benes/jsmith321</code></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The documentation for each endpoint displays the HTTP method and the end path. Before submitting the request, you must prepend the base path to get the full resource URL. All endpoints referenced in the documentation require the following base path: 

Curly braces are used as a placeholder and indicate the type of value that you need to supply. For instance, where you see 

 in the resource, you must replace that string with your client code.

For example, in the documentation, endpoints look similar to this:

When you add the base path, your client code, and any parameters, the result is a well-formed REST URL that looks something like this:

GET https://crossborder.corpay.com/api/123456/0/benes/jsmith321

<h1 class="slate-h1 " ></h1><p class="slate-p " >Most of the endpoints include examples of both successful and unsuccessful responses. In the Response window, click the response code to view additional examples. A Green dot indicates a successful response and a Red dot indicates an unsuccessful response.</p><p class="slate-p " >Corpay Cross-Border uses conventional HTTP response codes to indicate the success or failure of an API request.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Most of the endpoints include examples of both successful and unsuccessful responses. In the Response window, click the response code to view additional examples. A Green dot indicates a successful response and a Red dot indicates an unsuccessful response.

Corpay Cross-Border uses conventional HTTP response codes to indicate the success or failure of an API request.

The request was unacceptable, often due to missing or incorrect parameters or values.

4XX- Bad request

Authorization issue. This usually means that the authorization token has expired and you need to refresh it.

401 - Unauthorized

Due to currency fluctuation, quotes are valid for a very limited period of time. When you get a 410 error, it means that the rate resource you're trying to use has expired and you need to generate a new quote.

410 - Rate resource expired

If the error persists, contact Corpay Tier 2 support.

5XX - Server error

<p class="slate-p " >Our RESTful API suite employs an OAuth2 framework which consists of a two-part flow that involves exchanging an HS256-signed JWT token for a “CMG-AccessToken”.</p><p class="slate-p " >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).</p><p class="slate-p " >When creating the token, the "issued-at" and the "expiration" should be current, and advisably set apart at an interval of 20 minutes, respectively.</p><p class="slate-p " >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 the partner-level, there is no need to pass anything through "CMG-AccessToken" for the partner-level.</p><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>

Our RESTful API suite employs an OAuth2 framework which consists of a two-part flow that involves exchanging an 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 the partner-level, there is no need to pass anything through "CMG-AccessToken" for the partner-level.

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 properlythat can't be charged for some reason.

400 Bad Request - Invalid signature key

As a general rule, use 'time + 20 minutes' as your expiry date/time.
API endpoint and parameters.

400 Bad Request - JWT Token is expired

<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 " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >This set of endpoints deals with the <em class="slate-italic">exchange</em> of a currency pair and the <em class="slate-italic">transmission</em> of that exchanged currency to a beneficiary or a holding balance. The first three endpoints are the key elements of the Spot Workflow:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Spot Rate</div></li><li class="slate-li " ><div style="position:relative">Book Deal</div></li><li class="slate-li " ><div style="position:relative">Instruct Deal</div></li></ol><p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The other three endpoints are used to fetch rate and quote information:</p></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Lookup Orders</div></li><li class="slate-li " ><div style="position:relative">Rate Resource</div></li><li class="slate-li " ><div style="position:relative">Quotes</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

 of that exchanged currency to a beneficiary or a holding balance. The first three endpoints are the key elements of the Spot Workflow:

<p class="slate-p " >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&apos;s expiry date, the system will automatically book the deal. You can create Rate Orders for spot trades and for forward trades.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=error ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.08366 9.9801C9.25033 9.9801 9.39269 9.92107 9.51074 9.80302C9.6288 9.68496 9.68783 9.53566 9.68783 9.3551V5.31344C9.68783 5.14677 9.62533 5.00441 9.50033 4.88635C9.37533 4.7683 9.22949 4.70927 9.06283 4.70927C8.88227 4.70927 8.73296 4.7683 8.61491 4.88635C8.49685 5.00441 8.43783 5.15371 8.43783 5.33427V9.37594C8.43783 9.5426 8.50033 9.68496 8.62533 9.80302C8.75033 9.92107 8.9031 9.9801 9.08366 9.9801ZM9.00033 13.1676C9.19477 13.1676 9.35796 13.1016 9.48991 12.9697C9.62185 12.8377 9.68783 12.6745 9.68783 12.4801C9.68783 12.2857 9.62185 12.1225 9.48991 11.9905C9.35796 11.8586 9.19477 11.7926 9.00033 11.7926C8.80588 11.7926 8.64269 11.8586 8.51074 11.9905C8.3788 12.1225 8.31283 12.2857 8.31283 12.4801C8.31283 12.6745 8.3788 12.8377 8.51074 12.9697C8.64269 13.1016 8.80588 13.1676 9.00033 13.1676ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C10.9448 16.0843 12.6114 15.3898 14.0003 14.0009C15.3892 12.612 16.0837 10.9454 16.0837 9.00094C16.0837 7.05649 15.3892 5.38982 14.0003 4.00094C12.6114 2.61205 10.9448 1.9176 9.00033 1.9176C7.05588 1.9176 5.38921 2.61205 4.00033 4.00094C2.61144 5.38982 1.91699 7.05649 1.91699 9.00094C1.91699 10.9454 2.61144 12.612 4.00033 14.0009C5.38921 15.3898 7.05588 16.0843 9.00033 16.0843Z" fill="#E90005"></path></svg></div><div ><p class="slate-p " >Important: A Rate Order is not guaranteed to fill.</p></div></div><p class="slate-p " ></p><p class="slate-p " >
</p><p class="slate-p " ></p><p class="slate-p " ></p>

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.

<p class="slate-p " >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. </p><p class="slate-p " ></p>

<p class="slate-p " >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.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">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.</div></li><li class="slate-li " ><div style="position:relative">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.</div></li></ul><p class="slate-p " >The following identifiers are created for each completed forward:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">The <code class="slate-code">ordNum</code> is the alpha-numeric transaction identifier. It is the same as the deal number except that it is prefixed with 'OFD' (i.e. OFD40123456).</div></li><li class="slate-li " ><div style="position:relative">The <code class="slate-code">forwardId</code>/<code class="slate-code">paymentInstructionId</code> is the numeric forward identifier (i.e. 1386511).</div></li><li class="slate-li " ><div style="position:relative">The <code class="slate-code">quoteId</code> is the identifier of the forward quote rate resource (i.e. cc2999ba7eb84e19a158a8bf0f21296e).</div></li></ul><p class="slate-p " >These three endpoints are the key elements of the Forwards workflow. </p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Request Forward Quote</div></li><li class="slate-li " ><div style="position:relative">Book Forward Quote</div></li><li class="slate-li " ><div style="position:relative">Complete Order</div></li></ol><p class="slate-p " >The other two endpoints are optional to get more information: </p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Retrieve Forward Quote</div></li><li class="slate-li " ><div style="position:relative">Forward Instructions</div></li></ul><p class="slate-p " >





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

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.

The following identifiers are created for each completed forward:

These three endpoints are the key elements of the Forwards workflow. 

The other two endpoints are optional to get more information: 

<p class="slate-p " >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.</p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >This endpoint returns information about all your forwards. It displays forwards that are available now, those that will be available at a future date, and those that are incomplete. You can draw down funds from any of the forwards that have the status 'Available'.</p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><div class="slate-div"></div><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

This endpoint returns information about all your forwards. It displays forwards that are available now, those that will be available at a future date, and those that are incomplete. You can draw down funds from any of the forwards that have the status 'Available'.

Content-Type

CMG-AccessToken

clientCode

content

errors

links

<p class="slate-p " >The ‘Book Drawdown’ payload is very similar to the <code class="slate-code">POST</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/3-instruct-dealhttps://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/3-instruct-deal" target="_top">Instruct Deal</a> payload.</p><p class="slate-p " >The fee amount must reflect the contractual fee set up for the client. If fees are contractually $0 for this drawdown, then set <code class="slate-code">amount: 0</code>. If otherwise, set the amount accordingly.</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 " >Top-up of drawdown instruction amounts (when drawdown amount exceeds the value of the forward contract) is currently not supported on API.</p></div></div><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><p class="slate-p " ></p><div class="slate-div"></div><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p>

The ‘Book Drawdown’ payload is very similar to the 

The fee amount must reflect the contractual fee set up for the client. If fees are contractually $0 for this drawdown, then set 

. If otherwise, set the amount accordingly.

Book Drawdown

orders

payments

settlements

<p class="slate-p " >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).</p><p class="slate-p " >Orders created via Spot and Forward workflows can be cancelled.</p><p class="slate-p " >Just as the <code class="slate-code">POST</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/2-book-deal" target="_top">Spot Rate</a> and <code class="slate-code">POST</code> <a href="https://developer.crossborder.corpay.com/apidocscrossborder/spot-workflow/post-2-book-deal" target="_self">Book Deal</a> workflow has a timer, <code class="slate-code">Request Cancellation</code> and <code class="slate-code">Book Cancellation</code> also has an allotted window of time (the default is 10 seconds).</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div ><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 " ><strong class="slate-bold">Note:</strong> 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.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

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.

 also has an allotted window of time (the default is 10 seconds).

<p class="slate-p " >Similar to how the beneficiary template creates a record for the beneficiary and bank account to be paid, the settlement account template is for the bank account that is issuing the payment. The Settlement Account template is also known as the ‘Incoming Funds Template’. Once complete, these accounts can be used to settle transactions and payments. Accounts created through this workflow are non-Corpay bank accounts. Multi-Currency Accounts (previously called FXBalance) or Corpay holding account templates are not created in this same way.</p><p class="slate-p " ></p>

Similar to how the beneficiary template creates a record for the beneficiary and bank account to be paid, the settlement account template is for the bank account that is issuing the payment. The Settlement Account template is also known as the ‘Incoming Funds Template’. Once complete, these accounts can be used to settle transactions and payments. Accounts created through this workflow are non-Corpay bank accounts. Multi-Currency Accounts (previously called FXBalance) or Corpay holding account templates are not created in this same way.

<p class="slate-p slate-indent-0" style="0px">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.</p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >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.</p><p class="slate-p " >The only limitation is the currency-specific account limit of any currency being used for settlement (as outlined in the onboarding agreement).</p><p class="slate-p " ></p>

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

<p class="slate-p" placeholder="Type / for widgets">Clients/Partners can now trace the details and status of SWIFT payments after the payment has exited the Corpay bank account and is en route to the beneficiary&apos;s bank account.</p><p class="slate-p" placeholder="Type / for widgets">Currently, this feature is only available for payments travelling via the SWIFT Network - <em class="slate-italic">Wires</em> - (i.e. method is Wire). <strong class="slate-bold">EFT/iACH payments are not currently supported</strong>.</p><p class="slate-p" placeholder="Type / for widgets">

</p>

Clients/Partners can now trace the details and status of SWIFT payments after the payment has exited the Corpay bank account and is en route to the beneficiary's bank account.

Currently, this feature is only available for payments travelling via the SWIFT Network - 

EFT/iACH payments are not currently supported

<p class="slate-p slate-indent-0" style="0px">The onboarding API allows our integrated partners to expedite the onboarding process of their downstream clients. Partners can submit the onboarding data and the required verification documents via the onboarding endpoints.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The onboarding API allows our integrated partners to expedite the onboarding process of their downstream clients. Partners can submit the onboarding data and the required verification documents via the onboarding endpoints.

<p class="slate-p " >Webhooks are user-defined HTTP callbacks and can be used to receive real-time updates on your transactions and their statuses. Webhooks automate the process of retrieving real-time data updates and eliminate the need to regularly poll the APIs to know if there is a new update.</p><h3 class="slate-h3 " >How do Webhooks work?</h3><p class="slate-p " >A webhook endpoint is the URL to which you will receive subscribed event notifications. Once you register your webhook endpoint and subscribe to events, Corpay will send real-time automated push notifications to that URL whenever an event occurs for your client account. The returned JSON payload will contain the event data. You can use the notifications webhooks to monitor specific events and sync the updates with your system.</p><p class="slate-p " >For example,</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">When a payment is booked with Corpay, you can track the latest status of the payment and the complete payment journey by calling the <a href="https://developer.crossborder.corpay.com/apidocscrossborder/payment-tracking/payment-tracking" target="_self">Payment Tracking API</a> GET /api/payment-tracking/{trackerId} at regular intervals.</div></li><li class="slate-li " ><div style="position:relative">With Webhooks, you can subscribe to different <a href="https://developer.crossborder.corpay.com/apidocscrossborder/webhooks/supported-events/payment-events" target="_self">payment events</a>. Corpay will send a push notification to your webhook endpoint via an HTTPS POST request when the subscribed event occurs without frequently polling the payment tracking API.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Webhooks Security - Signature verification</h3><p class="slate-p " >Corpay includes a unique digital signature in the header each time we send an event notification to your endpoint. This allows you to authenticate the payload and prevent man-in-the-middle (MITM) attacks.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/50cdf9a0-2a64-4b13-a80b-97b914222169.jpg" style="
              width:1342px;
	            height:404px;
	            aspect-ratio:1342 / 404"
         /></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">When an event occurs, the notification payload header will contain a timestamp (in Unix format) along with an encrypted key in SHA1 cryptographic hash format, created using HMAC.</div></li><li class="slate-li " ><div style="position:relative">You can verify the authenticity of the notification by decrypting this header with HMAC to confirm if it matches the key.</div></li></ul><p class="slate-p " ></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 " >Please verify v1 to authenticate the payload. The encryption method for v1 will be shared with you during implementation.</p></div></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>

Webhooks are user-defined HTTP callbacks and can be used to receive real-time updates on your transactions and their statuses. Webhooks automate the process of retrieving real-time data updates and eliminate the need to regularly poll the APIs to know if there is a new update.

A webhook endpoint is the URL to which you will receive subscribed event notifications. Once you register your webhook endpoint and subscribe to events, Corpay will send real-time automated push notifications to that URL whenever an event occurs for your client account. The returned JSON payload will contain the event data. You can use the notifications webhooks to monitor specific events and sync the updates with your system.

Webhooks Security - Signature verification

Corpay includes a unique digital signature in the header each time we send an event notification to your endpoint. This allows you to authenticate the payload and prevent man-in-the-middle (MITM) attacks.

Sections