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.
\nResponse to APIs, once authenticated, are displayed in the following model where content and errors are provided in the appropriate lists. Links always contain a SELF link to the current endpoint, and any additional links, depending on the state of the resource. For example, a beneficiary object can be viewed and modified.
{\n \"content\": {},\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/{endpoint}\",\n \"method\": {POST GET or PUT}\n }\n ]\n }\n\nStay informed about our upcoming API changes and enhancements. We’ll announce these updates as they become available. If you have any questions, please contact your Corpay Account Manager.
\nFor a more detailed preview of what’s coming, please visit the Upcoming Updates page.
\nFor full details on enhancements and sample responses, please visit the API Release Notes page.
\nEstimated release timelines shared here are subject to change. We’ll keep you informed as we progress.
\nETA: Q1 2026
\nWe are enhancing IP Whitelisting to improve security, flexibility, and performance across our API services.
\nKey updates include:
\nWhitelisting at both client and partner levels
\nSupport for IPv4, IPv6, and valid CIDR ranges (for example, 192.0.2.0/24)
\nRemoval of SQL LIKE syntax (wildcards such as % will no longer be supported)
\nImproved access control with cached authentication for faster performance
\nETA: Q1 2026
\nUK and EU payment regulatory bodies have introduced new name-checking protocols requiring banks, financial institutions, and payment service providers like Corpay to validate that payee details are correct and exactly match the associated bank account information. On Corpay's internal workflow, we have now enabled:
\nUK’s Confirmation of Payee (CoP) protocol for all incoming and outgoing GBP payments made via FPS, Bacs, and CHAPS.
\nEU’s Verification of Payee (VoP) protocol for all incoming and outgoing EUR payments made via SEPA Credit Transfer (CT) or SEPA Instant eligible BICs (for clients whose payment accounts are governed under our Ireland entity and its branches).
\nWe are now integrating CoP and VoP protocols into our REST API workflows. Key updates include:
\nMigration to updated versions of our existing beneficiary creation endpoints.
\nIntroduce new verification endpoints.
\nWe'll keep you informed about the new endpoints and sample responses as we roll out the updates.
\nNote: CoP and VoP are regulatory mandates, not optional services. These checks are enforced at the regulatory level, and no exceptions are permitted. Please direct any questions to your Corpay representative.
\nETA: Q2 2026
\nAn updated version of the GET Beneficiary Rules endpoint will be released. Key updates include:
\nIntroduce new endpoints - api/template-guide-rules and api/{clientCode}/{clientDivisionId}/template-guide-rules
The API response will now return a list of accepted region values based on the specified destinationCountry and bankCountry parameters, ensuring compliance when creating or editing beneficiaries via the POST Create/Edit Bene.
A new optional routingCode parameter will support accurate beneficiary rule retrieval for CAD (Canada), addressing issues caused by varying account number digit lengths across Canadian banks and institutions.
We'll keep you informed about the new endpoints and sample responses as we roll out the updates.
\nETA: Q2 2026
\nTo improve our MCA reporting, we'll introduce new bank-style statements via an MCA Statement endpoint, which will eventually replace the existing GET Multi-Currency Accounts History endpoint. Both endpoints will run in parallel during the transition period to support integration updates. We'll keep you informed about the detailed specifications, sample responses, and API deprecation timelines as we roll out the updates.
\nCorpay Cross-Border's suite of API services and functionality is continuously growing in which we deploy multiple releases throughout the year. To discover what's new with Corpay's API, you can read our What's New section that detail the most recent API enhancements and updates.
\nThe documentation for each endpoint displays the HTTP method and the end path. Before you submit the request, you need to prepend the base path to get the full resource URL. All endpoints referenced in the documentation require the following base path: https://crossborder.corpay.com.
\nNote: 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 to point to the Beta environment.
\nCurly braces are used as a placeholder and indicate the type of value that you need to supply. For instance, where you see {clientCode} in the resource, you need to replace that string with your client code.
\nFor example, in the documentation, endpoints look similar to this:
\nGET /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:
\nGET https://crossborder.corpay.com/api/123456/0/benes/jsmith321
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.
\nCorpay Cross-Border uses conventional HTTP response codes to indicate the success or failure of an API request.
\n| Response Code | Description |
|---|---|
2xx | Success. |
4xx | Client error. This is usually due to missing or incorrect information, for example, a missing or incorrect parameter or value.
|
5xx | Server error. If the error persists, contact Corpay Tier 2 support. |
The maximum length for the MCA nickname has been increased from 30 to 50 characters. All other validations remain unchanged. For more information, see Assign/Edit MCA Nickname.
\nUpdate: Client Onboarding and Create/Edit Bene API
\nClient Onboarding API now supports a new Boolean parameter, DirectDebitAuthorization. When left blank, the value defaults to false. For more information, see Client Onboarding.
Nonprofit Organization is now available as a beneficiary classification when creating beneficiaries. For more information, see Create/Edit Bene.
\nNew: Subscribe to new Payment Webhooks Events
\nWe’ve expanded Webhooks to support new payment event types. Users can now subscribe to receive real-time notifications for the following events:
\nCorpay cancels a payment.
\nA client cancels a payment.
\nPayment is returned to the client.
\nFor more information, see Webhooks.
\nEnhanced Validations for Canadian Bank Account Numbers
\nroutingCode parameter has been added to the Get Beneficiary Rules endpoint to return the required account number length based on the provided routing code.New API Endpoint Introduced
\nGET Indicative Rates endpoint to return an indicative rate request for a Spot transaction. For more information, see GET Indicative Rates.Client Onboarding Request Update
\nBusinessConfirmationEmail2 parameter in the Client Onboarding request is now required. If no alternate email is available, users must enter their primary registered email. For more information, see Client Onboarding.The Onboarding API email field parameters now support email addresses with domain suffixes exceeding three characters (e.g., support@enterprise.cloud). Previously, only three-character extensions were accepted. See Client Onboarding
\n","_postman_id":"36464bd1-4aba-458d-bdec-5d9f9b0fcd4d"},{"name":"2025 Updates","item":[{"name":"October 2025","item":[],"id":"553bec09-5ed8-486a-89dd-9c1175793b20","description":"We made the following enhancements to the Client Onboarding API:
\nAdded new fields to support regional onboarding (CA, US, UK, AU, NZ, SG, EEA). See POST Client Onboarding.
\nIntroduced new picklist types for validating onboarding request values. See GET Onboarding Picklists.
\nThe following enhancements have been made to the GET View Multi-Currency Accounts and GET Multi-Currency Accounts History endpoints:
\nThe GET View Multi-Currency Accounts endpoint now supports an optional query parameter: showOnlyActive(boolean)
When true: Returns only active accounts, including their SSI details.
When false: Returns both active and deactivated accounts. SSI details are excluded for deactivated accounts.
A new boolean field, isActive, will be returned in both the response payloads to indicate whether an account is active (true) or deactivated (false).
The GET Purpose of Payment endpoint now supports three additional values:
• Royalties
• Reimbursement payment
• Winnings
These values are returned in the standard purpose of payment response. Call the API to confirm the allowed POP values for unique currency and payment method combinations.
Starting the week of August 25, 2025, we will be rolling out the following changes:
\nAs part of additional regulatory and banking requirements, a valid POP is now mandatory when instructing payments. A Corpay accepted POP value must be entered in the purposeOfPayment request field when submitting a payment via the following endpoints:
• POST Instruct Deal
• POST Multiple Payments
• POST Book Drawdown
If the purposeOfPayment field is left blank or populated with an invalid value, a 400 Bad Request error will be returned.
Note: While the POP list is consistent for most currencies, certain currencies may have unique POP value lists. Please use the GET Purpose of Payment endpoint to retrieve the correct POP ID for the corresponding currency and payment method.
To maintain consistency with the Corpay Cross-Border platform, editing the currency field on existing beneficiary templates via the API is now restricted and will return a 400 Bad Request. To update a beneficiary’s currency, a new template must be created via the API.
These updates were previously shared as part of our Upcoming Updates. Full details are available here.
\n","_postman_id":"309cea9e-264b-46ba-ae42-323d443aae65"},{"name":"July 2025","item":[],"id":"cb6dfa61-9a68-4379-8b55-0ab8083282ae","description":"You can now assign, update, and reset the nickname for your Multi-Currency Accounts via the API endpoints available here.
\nAs part of our ongoing improvements to Corpay's API suite, we have renamed the Incoming Deals API endpoint from: incoming-funds-details/{dealNumber} to incoming-funds/{ordNum}. There are no changes to the returned response.
Note: The old endpoint will be deprecated and made obsolete on Friday, August 15, 2025. If you have downloaded our API collection into your Postman instance or codebase, please ensure it is updated.
\nSee GET: Incoming Funds Details
\n","_postman_id":"cb6dfa61-9a68-4379-8b55-0ab8083282ae"},{"name":"June 2025","item":[],"id":"3bf38139-950b-4358-b45c-fd011f6eb34a","description":"We’ve enhanced Webhooks to include new event types. Users can now subscribe to receive real-time notifications when:
\nIncoming funds are applied to their Multi-Currency Account.
\nA payment is held at Corpay.
\nSee Webhooks.
\nWe've introduced a new API endpoint - GET: Incoming Funds Details that provides users with complete details of the incoming funds received into their MCA.
\nWe've updated the Onboarding Purpose of Transactions Picklist API to include additional values. Partners can now include specific Purpose of Transaction details to support compliance requirements.
\nBased on the payment method used, the Payment Channel Information API will now return either SWIFT MT103 or SWIFT MX Pacs.008.001.08 raw details in the response payload. The corresponding status in the response will be displayed as MT103 or Pacs.008.001.08. For more information, read here.
The defaultInternalComment field, previously used in the Create/Edit Bene API to enter For Further Credit (FFC) details, has now been renamed to furtherCreditDetails to provide a more intuitive and descriptive label.
The Beneficiary Validation and the Get Beneficiary Rules endpoints will also reflect this update.
\nNote: The old field name is no longer supported. If the old field name is used, the API will return a 200 success response, however, the FFC information will not be saved for that beneficiary. To ensure FFC details are saved correctly, partners must use the new field name furtherCreditDetails.
To comply with updated FINTRAC and related regulatory requirements, users are now required to enter valid region and postal code information for bank and beneficiary addresses in payments made to the United States and Canada. This update is enforced when creating or editing beneficiary information on Corpay Cross-Border via Beneficiary Templates, File Upload, or API. When using the POST Create/Edit Bene API, entering an invalid region or postal code for beneficiaries/bank addresses in the US and CA will return a 400 Bad Request error. For more information, read here.
Please refer to the GET Region API to retrieve accepted region values for US and CA beneficiary/bank addresses, and the GET Beneficiary Rules API for valid regex for US and CA address zip codes.
\n","_postman_id":"d562a018-f942-4f24-af6a-55b1e445f553"},{"name":"March 2025","item":[],"id":"4ce50bc1-277d-4df7-a22c-f6253666491e","description":"We added an optional defaultInternalComment field to Create/Edit Bene and Beneficiary Validation endpoints, enabling you to enter For Further Credit (FFC) information details. This field has a character limit of 50, and standard regex validations will apply. This field allows you to enter the details of the recipient who will receive the funds. For example, “FFC Tom Roe 000304756”.
ETA: Currently in progress and expected to be available soon.
\nAs part of Corpay’s ongoing investment in payment modernization and compliance, we’re introducing ISO 20022-aligned enhancements to both our UI and API, enabling richer, standardized data formats. The Payment Channel Information endpoint will now return either the SWIFT MT103 or the ISO equivalent MX messaging. Updated API docs with example responses will be published soon.
\nReleased On: June 27, 2025
\nETA: Deployment planned for the week of August 25, 2025.
\nAs part of additional regulatory and banking requirements, a valid POP will be mandatory when instructing payments. A Corpay accepted POP value must be entered in the purposeOfPayment request field when submitting a payment via the following endpoints:
Released On: August 22, 2025
\nETA: Deployment planned for the week of August 25, 2025.
\nTo maintain consistency with the Corpay Cross-Border platform, editing the currency field on existing beneficiary templates via the API will be restricted. After this restriction is enforced, to change a beneficiary’s currency, a new template must be created via the API.
\nReleased On: August 22, 2025
\nETA: Rollout planned for the end of Q2 2025. We’ll keep you informed as we progress.
\nAs part of our product development roadmap, we are introducing two new webhook subscription types:
\nIncoming Fund Notifications: Receive push notifications when funds are applied to your Multi-Currency Account (MCA) or a pending payment.
\nPayments on Hold: Receive a push notification if one of your payments is placed on hold by our Compliance or Problem Investigation teams.
\nIf you’d like to be one of our pilot clients and gain early access to these webhook features, please contact your Corpay Account Manager.
\nReleased On: June 27, 2025
\nETA: October 2025. We’ll keep you informed as we progress.
\nWe’re enhancing our Onboarding API with additional picklist values (e.g., purpose of transaction) and new data fields. These enhancements help ensure our partners and Corpay digitally capture all of the required information to meet global Compliance KYC requirements.
\nReleased On: October 31, 2025
\n","_postman_id":"00e10ce8-0775-49e7-af18-a5a2c7934318"}],"id":"3d99edaf-8da7-4a84-a406-1ffc02f70d19","description":"Updates introduced in 2025.
\n","_postman_id":"3d99edaf-8da7-4a84-a406-1ffc02f70d19"},{"name":"2024 Updates","item":[{"name":"November 2024","item":[],"id":"395c5d83-13a4-42c4-9303-4506e6faf598","description":"To help prevent invalid region errors, we’ve introduced a dedicated GET Regions API endpoint. This endpoint allows our partners to retrieve valid region values.
\nAs part of our product rebranding, we renamed the following API endpoints under the Settlement Accounts, effective Thursday, November 14, 2024:
\nView FXBalance Accounts is now renamed to View Multi-Currency Accounts
\nFXBalance History is now renamed to Multi-Currency Accounts History
\nPlease note that only the API names have been renamed — the API URL remains unchanged. You can continue to access the API using the same endpoints as before.
\nThe View Multi-Currency Accounts API will now return both the Standard and the Named Account related details and the corresponding SSIs in the response payload.
\nFor the most current list of fields, descriptions, and other details, please refer to the updated API documentation.
\nNote:
\nAny references to FXBalance, Link Balances, or CLIAB in the payment/settlement methods, account type, and templates description have been updated to MCA Balance (Multi-Currency Accounts Balance). However, the API URLs and the response payloads will return the old terminology. We are actively working to update this in our future API releases.
\nMulti-Currency Accounts cannot be created via API, please speak to your account representative for more details.
\nPOST Create/Edit Bene endpoint. See Beneficiary Validation.CMG-AccessToken:toBeDiscontinued in the POST Partner-level Token Login header, please ensure it is removed. This token has been identified as a potential cause of recent timeout errors during API authentication and is no longer required to be included in the header.REGEX_MISMATCH error. This restriction currently applies to Australia, Canada, and Mexico and is also reflected in the GET Beneficiary Rules endpoint. This update ensures that a complete physical address is provided, as required by regulatory standards.trackerId in the response. With this update, our partners can retrieve the trackerId in the Mass Payment workflow immediately and avoid subsequent follow-up API requests to retrieve the payment tracker IDs.Updates introduced in 2024.
\n","_postman_id":"9c072618-a5b1-44cc-9ca6-d23f47539ae0"},{"name":"2023 Updates","item":[{"name":"October 2023","item":[],"id":"42bffbb2-01b3-4666-8187-c32a6600b2e3","description":"Added new Push Notifications via Webhooks to allow our Partners to receive real-time notifications on events that occur within their client account and eliminates the need to regularly poll the APIs to know if there is a new update. Webhooks utilize an event-driven approach to promptly send a notification when the subscribed event occurs.
\nThe Push Notifications are currently available for Payment and Client Onboarding events. For more information, see Webhooks.
\nUpdate Date: August 26, 2023
\nCorpay’s POST Accept Terms API endpoint is deprecated as of August 26th, 2023.
To streamline our Forward workflow and reduce the number of endpoints that need to be called to successfully complete a Forward order, the POST Accept Terms API endpoint for the v1.8 suite is made obsolete as of the advised date.
Partner’s are no longer required to send an ‘Accept Terms’ API request and instead, will complete their Forward booking with the existing POST Complete Order API endpoint.
GET AuthSecret Keys.clientOnboardingId is returned. They can then submit the required verification documents via the Submit Onboarding request to complete the onboarding process for that client.GET Payment Tracking.trackerId in the POST Instruct Deal and GET Lookup Orders response. This field will return the unique trackerId for a specific payment that can be used to trace the payment details and status. For more information, see POST Instruct Deal and GET Lookup Orders.Updates introduced in 2023.
\n","_postman_id":"6123a934-2c8b-485f-b497-338efba15a99"}],"id":"7cf5b90c-3b0b-4ca8-9c3b-b4a8cc51e4a3","description":"This section provides information about any bug fixes and enhancements introduced with a release for Corpay API.
\n","_postman_id":"7cf5b90c-3b0b-4ca8-9c3b-b4a8cc51e4a3"},{"name":"2-Token Auth ","item":[{"name":"Partner-level Token Login","id":"232a15a1-71d3-4dda-bad6-a232bb5a3a05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"assertion\": \"insert_JWT_token\",\r\n \"grant_type\": \"urn:ietf:params:oauth:grant-type:jwt-bearer\"\r\n}\r\n"},"url":"/api/partner/oauth2/token","description":"Sample payload for the JWT token generation:
\n{\n\"iss\": \"test\",\n\"iat\": 1480103915,\n\"exp\": 1480105116,\n\"aud\": \"cambridgefx\",\n\"sub\": \"\"\n}\n\nThis link has a form to generate JWT token.
\nFor the token, you must be current between the window of the issue and the expiry (iat and exp, respectively) of the Unix-Timestamp.
iss is the Corpay-provided partner ID.The authentication on the Client-level is similar to the authentication process at the partner-level. \nTwo key differences in the JWT construction:
\naccess_code from Partner Auth goes in the header of this API.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.
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.
| Error Code | Description |
|---|---|
400 Bad Request - Invalid value for audience | 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 - 'exp' token is set too far into the future | This error is the result of setting the token too far into the future. The threshold is approximately 24 hours after issue. |
400 Bad Request - Invalid Issuer (either Partner or User) | User not found or partner access not configured. Check the error_description parameter for more information. |
400 Bad Request - Invalid signature key | The auth key or signature must be current; otherwise the token will not be signed properly. |
400 Bad Request - JWT Token is expired | As a general rule, use time + 20 minutes as your expiry date/time. |
This endpoint specifies the information needed to create a beneficiary in a particular country. (See POST Create/Edit Bene)
The URL is a query string that requires five parameters to obtain all the information needed to create the beneficiary:
\nNotes:
\nFor Canadian Banks, the routingCode must be a 9-digit value combining a 4-digit institution number and the 5-digit transit (branch) number.
The API does not return an error if any of the five required parameters are omitted from the request URL. However, missing parameters may result in incomplete or less accurate response data.
\nThe provide element in the returned response will list any missing information. If provide is an empty array, no additional data is required.
If successful, the response contains a list of the fields required to successfully create a beneficiary. These rules are guidelines for the payload of the POST Create/Edit Bene endpoint.
The clientIntegrationId value is a unique beneficiary ID that you can use in other endpoints. The first time it is provided, it creates a new resource, which is later used to reference that beneficiary.
The clientIntegrationId must be unique as Corpay uses global values in this field.
Note: The only characters allowed in the clientIntegrationId are:
Alphanumeric (a-zA-Z0-9)
\nDash (-)
\nUnderscore (_)
\nYou can use GUID which has a very low chance of collision, your own hash, or some determinstic prefix to make it unique.
\nChanging the clientIntegrationId creates a new beneficiary template.
Note: The only special characters allowed in the accountHolder name and address fields, and the bank name and address fields are:
\nPeriod (.)
\nComma (,)
\nAmpersand (&)
\nDash (-)
\nTip: Before creating a beneficiary, you can validate the beneficiary details using the POST Beneficiary Validation endpoint without creating a template.
\nIn the following table, unless otherwise noted, required means that the field is required for ALL beneficiaries, regardless of destination. Some destinations require additional information.
\n| Parameter | Description |
|---|---|
accountHolderName | string (required) Full name of the account holder. Maximum 100 characters. |
templateIdentifier | string (required) The client-assigned template identifier. This value should match the 'clientIntegrationId' in the URL. The value in this field is returned in the 'beneIdentifier' field when you run GET View Bene. Maximum 50 characters. |
destinationCountry | string (required) Two-letter ISO code for the country where the beneficiary's bank is located. |
bankCurrency | string (required) Three-letter ISO code for the bank account currency. |
classification | string (required) Beneficiary classification = 'Individual' or 'Business'. Most of the other values shown in GET Beneficiary Rules. |
paymentMethods | array (required)
|
preferredMethod | string (required) Method of payment preferred by this beneficiary. |
accountNumber | string (required) Bank account number. |
localAccountNumber | string (optional) Bank account number. |
routingCode | string (required for Wires) Bank routing code - used to identify a specific financial institution. In some countries, the routing code is known by another name, such as ABA Number, Transit Number, Sort Code, BSB Number, IFSC Code, or Branch Code. |
localRoutingCode | string (optional) Bank routing code. |
accountHolderCountry | string (required) The account holder's two-letter ISO country code. |
accountHolderRegion | string (required for Canada or the United States) The account holder's province or state. Maximum 30 characters. Note: Value can be either id or code returned by GET Regions. |
accountHolderAddress1 | string (required) First line of the account holder's address. Maximum 50 characters. Note: PO Box addresses not allowed for Australia, Canada, or Mexico. |
accountHolderAddress2 | string (optional) Second line of the account holder's address. Maximum 50 characters. Note: PO Box addresses not allowed for Australia, Canada, or Mexico. |
accountHolderCity | string (required) The account holder's city. Maximum 100 characters. |
accountHolderPostal | string (required for Canada or the United States) The account holder's postal or zip code. Maximum 50 characters. |
accountHolderPhoneNumber | integer (required if mandatory for destination country) The account holder's phone number. |
accountHolderEmail | string (required if 'SendPayTracker' = 'true') Email address. |
sendPayTracker | boolean (optional) Specifies whether to send an email alert to the beneficiary whenever a payment is released = ['true', 'false']. |
swiftBicCode | string (required for Wires) The unique identifier for the bank or financial institution. |
bankName | string (required) Name of the financial institution. Maximum 250 characters. |
bankCountry | string (required) The bank's two-letter ISO country code. |
bankRegion | string (required for Canada or the United States) The bank's province or state. Maximum 100 characters. Note: Value can be either id or code returned by GET Regions. |
bankCity | string (required) The bank's city. Maximum 100 characters. |
bankAddressLine1 | string (required) First line of the bank's address. Maximum 100 characters. |
bankAddressLine2 | string (optional) Second line of the bank's address. Maximum 100 characters. |
bankPostal | string (required for Canada or the United States) The bank's postal or zip code. Maximum 50 characters. |
paymentReference | string (optional) Default payment reference that will be used if a reference is not provided on a payment. The payment reference is transmitted with the payment, subject to banking constraints. |
internalPaymentAlert | string (optional) Internal email addresses to notify when a payment is made to this beneficiary. |
externalPaymentAlert | string (optional) External email addresses to notify when a payment is made to this beneficiary. |
furtherCreditDetails | string (optional) Enter the details of the recipient who will receive the funds — For Further Credit (FFC). E.g., FFC Tom Roe 000304756 Must start with 'FFC' followed by name and account number. Maximum 50 characters, no special characters. |
regulatory | array (required if mandatory for destination country) The fields and corresponding values needed to satisfy regulatory requirements for the destination country. Valid values can be retrieved via GET Bene Rules endpoint. |
| Parameter | Description |
|---|---|
content.templateId | The id that is used to reference the most recent iteration of a beneficiary template (since the template is mutable, it generates a new id everytime there is a change); this string is used in the POST Instruct Deal call in the 'beneficiaryId' field. |
| Error Code | Description |
|---|---|
400 Bad Request - Value provided doesn't match the RegEx | The value in the specified field does not contain the required number of characters or contains characters that are not allowed. |
400 Bad Request - Field is mandatory | One or more required field values are missing. |
400 Bad Request - Value provided is not in the set of valid values | The value provided is not an allowed value for the specified field. |
400 Bad Request - Beneficiary Identifier has already been assigned | The 'templateIdentifier' already exists and cannot be used again. |
By inputting the clientIntegrationId of the bene you have already created, this endpoint retrieves complete template information for the specified beneficiary. \n
This endpoint permanently deletes a single beneficiary. You cannot delete more than one beneficiary at the same time.
\nImportant: Deleted beneficiary cannot be viewed or reactivated.
\n","urlObject":{"path":["api","{clientCode}","0","templates","{clientIntegrationId}"],"query":[],"variable":[]}},"response":[{"id":"9391fc53-68a0-45a5-ac6b-58e2bab9face","name":"200 Delete Bene","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}","type":"text"}],"url":"https://crossborder.corpay.com/api/{clientCode}/0/templates/{clientIntegrationId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/7.5","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Access-Control-Allow-Origin","value":"https://beta.cambridgelink.com","enabled":true},{"key":"Date","value":"Wed, 13 Mar 2019 14:17:16 GMT","enabled":true},{"key":"Content-Length","value":"173","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"advanced\": {}\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/templates/{clientIntegrationId}\",\n \"method\": \"DELETE\"\n }\n ]\n}"},{"id":"0399e0d3-9b2d-4886-9a3f-b6c22406971d","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}","type":"text"}],"url":"https://crossborder.corpay.com/api/{clientCode}/0/templates/{clientIntegrationId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/7.5","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Access-Control-Allow-Origin","value":"https://beta.cambridgelink.com","enabled":true},{"key":"Date","value":"Wed, 13 Mar 2019 14:18:22 GMT","enabled":true},{"key":"Content-Length","value":"160","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {},\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/templates/{clientIntegrationId}\",\n \"method\": \"DELETE\"\n }\n ]\n}"}],"_postman_id":"157d6f16-a663-4821-a508-a399a6a23615"},{"name":"Search Benes","id":"48ec3938-a374-4ae7-9549-916546b5700e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"CMG-AccessToken","type":"text","value":"{insert Client-level \"access_code\"}"}],"url":"/api/{clientCode}/0/benes?q={query}","description":"This endpoint retrieves a list of all your bene templates that meet the specified criteria. See \"Employ Query String\" below. These parameters will assist in narrowing your search.
\nTo perform a parameterized search, use one or more of these parameters in the query string:
\n| Parameter | Description | Example |
|---|---|---|
| q=Curr | The ISO-4217 Currency Code | /api/{clientCode}/0/benes?q=Curr:EUR |
| q=PayeeCountryISO | The ISO2 Country Code | /api/{clientCode}/0/benes?q=PayeeCountryISO:AD |
| q=Methods | The method of payment = ['W' or 'E']
| /api/{clientCode}/0/benes?q=Methods:E |
| q=Status | The status of the benficiary template - 'Active', or 'Inactive' = ['A' or 'I'] | /api/{clientCode}/0/benes?q=Status:A |
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.
This call searches a database of global banks and returns results that meet your search criteria.
The query parameters can be any relevant information, such as name, city, routing code, etc.
There are two optional parameters that you can include in the query string: 'take' specifies how many results you want returned, and 'skip' specifies how many search results you want to skip. For very broad search results, we recommend that you use 'take' and 'skip' to minimize page load times.
\n","urlObject":{"path":["api","banks"],"query":[{"key":"country","value":"{country ISO2}"},{"key":"query","value":"{search string}"},{"key":"skip","value":"{number of objects to skip; optional}"},{"key":"take","value":"{number of objects to retrieve; optional}"}],"variable":[]}},"response":[{"id":"1f1cf3e7-b822-4ecc-b521-7c04fe4e8614","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":{"raw":"?query=nashville tennessee synovus&take=5&country=US","query":[{"key":"query","value":"nashville tennessee synovus"},{"key":"take","value":"5"},{"key":"","value":"","disabled":true},{"key":"country","value":"US"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"data\": {\n \"pagination\": {\n \"total\": 8,\n \"skip\": 0,\n \"take\": 5\n },\n \"links\": [\n {\n \"rel\": \"DATA\",\n \"uri\": \"https://crossborder.corpay/api/banks?country=US&query=nashville tennessee synovus&skip=0&take=5&sort=&facets=False\",\n \"method\": \"GET\"\n }\n ],\n \"sorting\": [],\n \"rows\": [\n {\n \"primaryKey\": \"000000000513102\",\n \"institutionName\": \"THE BANK OF NASHVILLE, A DIVISION OF SYNOVUS BANK\",\n \"address1\": \"481 SAM RIDLEY PKWY WEST\",\n \"address2\": \"\",\n \"city\": \"SMYRNA\",\n \"region\": \"TENNESSEE\",\n \"country\": \"UNITED STATES OF AMERICA\",\n \"countryISO\": \"US\",\n \"postalCode\": \"37167\",\n \"swiftBIC\": \"FICOUS44XXX\",\n \"nationalBankCode\": \"064003881\",\n \"nationalBankCodeType\": \"USBC\",\n \"officeType\": \"Branch\",\n \"branchName\": \"BELL PLACE SHOPPING CENTER\",\n \"phone\": \"+1 615 2712058\",\n \"fax\": \"\"\n },\n {\n \"primaryKey\": \"000000000524666\",\n \"institutionName\": \"THE BANK OF NASHVILLE, A DIVISION OF SYNOVUS BANK\",\n \"address1\": \"890 RIVERGATE PKWY\",\n \"address2\": \"\",\n \"city\": \"GOODLETTSVILLE\",\n \"region\": \"TENNESSEE\",\n \"country\": \"UNITED STATES OF AMERICA\",\n \"countryISO\": \"US\",\n \"postalCode\": \"37072\",\n \"swiftBIC\": \"FICOUS44XXX\",\n \"nationalBankCode\": \"064003881\",\n \"nationalBankCodeType\": \"USBC\",\n \"officeType\": \"Branch\",\n \"branchName\": \"RIVERGATE\",\n \"phone\": \"+1 615 2712058\",\n \"fax\": \"\"\n },\n {\n \"primaryKey\": \"000000000524667\",\n \"institutionName\": \"THE BANK OF NASHVILLE, A DIVISION OF SYNOVUS BANK\",\n \"address1\": \"2022 WEST END AVE\",\n \"address2\": \"\",\n \"city\": \"NASHVILLE\",\n \"region\": \"TENNESSEE\",\n \"country\": \"UNITED STATES OF AMERICA\",\n \"countryISO\": \"US\",\n \"postalCode\": \"37203\",\n \"swiftBIC\": \"FICOUS44XXX\",\n \"nationalBankCode\": \"064003881\",\n \"nationalBankCodeType\": \"USBC\",\n \"officeType\": \"Branch\",\n \"branchName\": \"WEST END AVENUE\",\n \"phone\": \"+1 615 2712058\",\n \"fax\": \"\"\n },\n {\n \"primaryKey\": \"000000000449023\",\n \"institutionName\": \"THE BANK OF NASHVILLE, A DIVISION OF SYNOVUS BANK\",\n \"address1\": \"3770 HILLSBORO RD\",\n \"address2\": \"\",\n \"city\": \"NASHVILLE\",\n \"region\": \"TENNESSEE\",\n \"country\": \"UNITED STATES OF AMERICA\",\n \"countryISO\": \"US\",\n \"postalCode\": \"37215\",\n \"swiftBIC\": \"FICOUS44XXX\",\n \"nationalBankCode\": \"064003881\",\n \"nationalBankCodeType\": \"USBC\",\n \"officeType\": \"Branch\",\n \"branchName\": \"GREEN HILLS\",\n \"phone\": \"+1 615 2712058\",\n \"fax\": \"\"\n },\n {\n \"primaryKey\": \"000000000449024\",\n \"institutionName\": \"THE BANK OF NASHVILLE, A DIVISION OF SYNOVUS BANK\",\n \"address1\": \"5105 MARYLAND WAY\",\n \"address2\": \"\",\n \"city\": \"BRENTWOOD\",\n \"region\": \"TENNESSEE\",\n \"country\": \"UNITED STATES OF AMERICA\",\n \"countryISO\": \"US\",\n \"postalCode\": \"37027\",\n \"swiftBIC\": \"FICOUS44XXX\",\n \"nationalBankCode\": \"064003881\",\n \"nationalBankCodeType\": \"USBC\",\n \"officeType\": \"Branch\",\n \"branchName\": \"\",\n \"phone\": \"+1 615 2712058\",\n \"fax\": \"\"\n }\n ]\n },\n \"facets\": {\n \"regions\": [\n {\n \"id\": \"TENNESSEE\",\n \"text\": \"TENNESSEE\",\n \"count\": 8\n }\n ],\n \"cities\": [\n {\n \"id\": \"BRENTWOOD\",\n \"text\": \"BRENTWOOD\",\n \"count\": 1\n },\n {\n \"id\": \"FRANKLIN\",\n \"text\": \"FRANKLIN\",\n \"count\": 1\n },\n {\n \"id\": \"GOODLETTSVILLE\",\n \"text\": \"GOODLETTSVILLE\",\n \"count\": 1\n },\n {\n \"id\": \"HENDERSONVILLE\",\n \"text\": \"HENDERSONVILLE\",\n \"count\": 1\n },\n {\n \"id\": \"NASHVILLE\",\n \"text\": \"NASHVILLE\",\n \"count\": 3\n },\n {\n \"id\": \"SMYRNA\",\n \"text\": \"SMYRNA\",\n \"count\": 1\n }\n ]\n }\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/banks?country=US&query=nashville tennessee synovus&take=5&sort=asc\",\n \"method\": \"GET\"\n }\n ]\n}"}],"_postman_id":"c66e3d38-0529-4f9d-98bd-60149b2b85e8"},{"name":"IBAN Validation","id":"d6ffaeb4-0cc0-4f49-aecf-51b6bc3d1126","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"body":{"mode":"raw","raw":"{ \r\n \"iban\":\"ES0200495878612416015745\"\r\n}\r\n"},"url":"/api/ibanvalidation","description":"Validates the IBAN number submitted in the ‘Body’ of the request, and returns the banking details parsed from the IBAN string.
\nResponse provides two important data points:
\nNote: IBAN can be invalid but bank information can still be extracted.
\n","urlObject":{"path":["api","ibanvalidation"],"query":[],"variable":[]}},"response":[{"id":"4d7f7360-c526-416b-bd8c-fc6ab8ca7a37","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"body":{"mode":"raw","raw":"{ \r\n \"iban\":\"ES0200495878612416015745\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://crossborder.corpay.com/api/ibanvalidation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin →","value":"*","description":"","enabled":true,"type":"text"},{"key":"cache-control →","value":"no-cache","description":"","enabled":true,"type":"text"},{"key":"content-length →","value":"344","description":"","enabled":true,"type":"text"},{"key":"content-type →","value":"application/json; charset=utf-8","description":"","enabled":true,"type":"text"},{"key":"date →","value":"Mon, 11 Sep 2017 14:44:00 GMT","description":"","enabled":true,"type":"text"},{"key":"expires →","value":"-1","description":"","enabled":true,"type":"text"},{"key":"pragma →","value":"no-cache","description":"","enabled":true,"type":"text"},{"key":"server →","value":"Microsoft-IIS/7.5","description":"","enabled":true,"type":"text"},{"key":"x-aspnet-version →","value":"4.0.30319","description":"","enabled":true,"type":"text"},{"key":"x-powered-by →","value":"ASP.NET","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"isValid\": true,\n \"isWarning\": false,\n \"iban\": \"ES0200495878612416015745\",\n \"branchCode\": \"004958786\",\n \"routingNumber\": \"004958786\",\n \"accountNumber\": \"2416015745\",\n \"swiftBIC\": \"BSCHESMMXXX\",\n \"bankName\": \"Banco Santander SA\",\n \"branchName\": \"Banco Santander SA\",\n \"bankAddress\": \"Al Jandia, S/n\",\n \"postalCode\": \"35625\",\n \"countryName\": \"SPAIN\",\n \"country\": \"ES\",\n \"bankCity\": \"Morro-Jable\",\n \"validationMessages\": [\n {\n \"message\": \"Valid IBAN Structure\"\n }\n ],\n \"responses\": [\n {\n \"message\": \"Valid IBAN Structure\"\n }\n ],\n \"recommendedAcct\": \"ES0200495878612416015745\"\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/ibanValidation\",\n \"method\": \"POST\"\n }\n ]\n}"}],"_postman_id":"d6ffaeb4-0cc0-4f49-aecf-51b6bc3d1126"},{"name":"Purpose of Payment","id":"39136fe2-5edc-4990-9010-ce4ea8354d9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":"/api/{clientCode}/0/paymentPurpose?q={searchText}&countryISO={countryISO}&curr={currencyISO}&method={'W' or 'E'}","description":"Returns a list of Purpose of Payment (POP) options that are unique to certain countries, such as India (INR via EFT), China or Hong Kong (CNH via Wire). For countries with no unique list, returns the standard purpose of payments list.
\nNote: Always refer to the latest version of the response returned by this endpoint to stay aligned with our current API validation rules and supported data formats. We may add new values or modify existing ones as required. Please refer to our API release notes to stay informed of changes.
\n","urlObject":{"path":["api","{clientCode}","0","paymentPurpose"],"query":[{"key":"q","value":"{searchText}"},{"key":"countryISO","value":"{countryISO}"},{"key":"curr","value":"{currencyISO}"},{"description":{"content":"payment method
\n","type":"text/plain"},"key":"method","value":"{'W' or 'E'}"}],"variable":[]}},"response":[{"id":"88422a64-7ae4-40e9-a840-d84b4535a200","name":"200 POP Standard List","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":{"raw":"https://crossborder.corpay.com/api/{clientCode}/0/paymentPurpose?q={searchText}&countryISO={countryISO}&curr={currencyISO}&method={'W' or 'E'}","protocol":"https","host":["crossborder","corpay","com"],"path":["api","{clientCode}","0","paymentPurpose"],"query":[{"key":"q","value":"{searchText}"},{"key":"countryISO","value":"{countryISO}"},{"key":"curr","value":"{currencyISO}"},{"key":"method","value":"{'W' or 'E'}","description":"payment method"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"content\": {\n\t\t\"items\": [\n\t\t\t{\n\t\t\t\t\"id\": \"PURCHASE OF GOOD(S)\",\n\t\t\t\t\"text\": \"Purchase of Good(s)\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PURCHASE PROFESSIONAL SERVICE\",\n\t\t\t\t\"text\": \"Purchase of Professional Service(s)\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PROFESSIONAL FEES PAYMENT\",\n\t\t\t\t\"text\": \"Professional fees payment (i.e. legal, accountant)\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PAYROLL/PERSONNEL PAYMENT\",\n\t\t\t\t\"text\": \"Payroll/Personnel payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PAYMENT FOR A LOAN OR DEPOSIT\",\n\t\t\t\t\"text\": \"Payment for a loan or deposit\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"BILL PAYMENT\",\n\t\t\t\t\"text\": \"Bill payment (i.e. credit card, utility)\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"RESEARCH AND DEVELOPMENT\",\n\t\t\t\t\"text\": \"Research and Development\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"BUSINESS VENTURE\",\n\t\t\t\t\"text\": \"Business venture (i.e. merger, acquisition)\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"INTERCOMPANY PAYMENT\",\n\t\t\t\t\"text\": \"Intercompany payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"CHARITABLE DONATION\",\n\t\t\t\t\"text\": \"Charitable donation\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PURCHASE OF PROPERTY / REAL ESTATE\",\n\t\t\t\t\"text\": \"Purchase of property / real estate\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"ESTATE SETTLEMENT / INHERITANCE\",\n\t\t\t\t\"text\": \"Estate settlement / Inheritance\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"GOVERNMENT RELATED PAYMENT\",\n\t\t\t\t\"text\": \"Government related payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"INVESTMENT RELATED PAYMENT\",\n\t\t\t\t\"text\": \"Investment related payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PAYMENT,FAMILY ASSISTANCE\",\n\t\t\t\t\"text\": \"Payment,Family Assistance\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"MEDICAL ASSISTANCE\",\n\t\t\t\t\"text\": \"Medical Assistance\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"MEDICAL CLAIM REIMBURSEMENT\",\n\t\t\t\t\"text\": \"Medical Claim Reimbursement\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"REMITTANCE OF FUNDS FROM E-COMMERCE\",\n\t\t\t\t\"text\": \"Remittance of funds from e-commerce\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"IP TRADEMARK PATENT WORK\",\n\t\t\t\t\"text\": \"IP Trademark Patent Work\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"TRAVEL HOSPITALITY\",\n\t\t\t\t\"text\": \"Travel/Hospitality\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PUBLISHER\",\n\t\t\t\t\"text\": \"Publisher\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"ROYALTIES\",\n\t\t\t\t\"text\": \"Royalties\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"REIMBURSEMENT PAYMENT\",\n\t\t\t\t\"text\": \"Reimbursement payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"WINNINGS\",\n\t\t\t\t\"text\": \"Winnings\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"ACCOMMODATION\",\n\t\t\t\t\"text\": \"Accommodation\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"ALLOWANCES\",\n\t\t\t\t\"text\": \"Allowances\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"COMMISSIONS OR FEES\",\n\t\t\t\t\"text\": \"Commissions or Fees\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"CONCEPT INSURANCE\",\n\t\t\t\t\"text\": \"Concept Insurance\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"CONSTRUCTION SERVICES\",\n\t\t\t\t\"text\": \"Construction Services\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"CONSULTING FEES\",\n\t\t\t\t\"text\": \"Consulting fees\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"DIVIDEND PAYOUTS\",\n\t\t\t\t\"text\": \"Dividend payouts\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"EMPLOYEE EXPENSES\",\n\t\t\t\t\"text\": \"Employee Expenses\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"EXPERT TESTIMONY\",\n\t\t\t\t\"text\": \"Expert Testimony\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"FAMILY ASSISTANCE\",\n\t\t\t\t\"text\": \"Family Assistance\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"FINAL SETTLEMENT\",\n\t\t\t\t\"text\": \"Final Settlement\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"FINANCIAL SUPPORT AND AID\",\n\t\t\t\t\"text\": \"Financial Support and Aid\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"GIFTS\",\n\t\t\t\t\"text\": \"Gifts\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"HONORARIUM\",\n\t\t\t\t\"text\": \"Honorarium\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"INCOME TAX PAYMENT\",\n\t\t\t\t\"text\": \"Income Tax payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"INTEREST PAYMENT\",\n\t\t\t\t\"text\": \"Interest payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"MINISTRY SUPPORT\",\n\t\t\t\t\"text\": \"Ministry Support\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"OTHER DISBURSEMENT\",\n\t\t\t\t\"text\": \"Other Disbursement\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PARTNER PAYMENT\",\n\t\t\t\t\"text\": \"Partner payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PERSONAL PAYMENT\",\n\t\t\t\t\"text\": \"Personal payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"PURCHASE OF TEXTILE & UPHOLSTERY\",\n\t\t\t\t\"text\": \"Purchase of Textile & Upholstery\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"RELOCATION EXPENSES\",\n\t\t\t\t\"text\": \"Relocation expenses\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"RENT PAYMENT\",\n\t\t\t\t\"text\": \"Rent payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"RESEARCH FEES\",\n\t\t\t\t\"text\": \"Research Fees\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"RETURN DEPOSIT\",\n\t\t\t\t\"text\": \"Return Deposit\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"SALARY ADVANCE\",\n\t\t\t\t\"text\": \"Salary Advance\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"TEACHING SERVICES\",\n\t\t\t\t\"text\": \"Teaching services\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"TEST PAYMENT\",\n\t\t\t\t\"text\": \"Test payment\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"TRANSLATION SERVICES\",\n\t\t\t\t\"text\": \"Translation services\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"TRAVEL EXPENSES\",\n\t\t\t\t\"text\": \"Travel Expenses\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": \"TUITION PAYMENT OR REFUND\",\n\t\t\t\t\"text\": \"Tuition Payment or Refund\",\n\t\t\t\t\"searchText\": \"\"\n\t\t\t}\n\t\t]\n\t},\n\t\"errors\": [],\n\t\"links\": [\n\t\t{\n\t\t\t\"rel\": \"self\",\n\t\t\t\"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/paymentPurpose?countryISO=CA&curr=CAD&method=E\",\n\t\t\t\"method\": \"GET\"\n\t\t}\n\t]\n}"},{"id":"0b7b46e1-e6c4-4a2b-ae09-1ff0164960fa","name":"200 POP INR","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":{"raw":"https://crossborder.corpay.com/api/{clientCode}/0/paymentPurpose?countryISO=IN&curr=INR&method=W","protocol":"https","host":["crossborder","corpay","com"],"path":["api","{clientCode}","0","paymentPurpose"],"query":[{"key":"countryISO","value":"IN"},{"key":"curr","value":"INR"},{"key":"method","value":"W"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*","name":"access-control-allow-origin","description":"","enabled":true},{"key":"cache-control","value":"no-cache","name":"cache-control","description":"","enabled":true},{"key":"content-length","value":"1414","name":"content-length","description":"","enabled":true},{"key":"content-type","value":"application/json; charset=utf-8","name":"content-type","description":"","enabled":true},{"key":"date","value":"Mon, 16 Oct 2017 18:59:47 GMT","name":"date","description":"","enabled":true},{"key":"expires","value":"-1","name":"expires","description":"","enabled":true},{"key":"pragma","value":"no-cache","name":"pragma","description":"","enabled":true},{"key":"server","value":"Microsoft-IIS/7.5","name":"server","description":"","enabled":true},{"key":"x-aspnet-version","value":"4.0.30319","name":"x-aspnet-version","description":"","enabled":true},{"key":"x-powered-by","value":"ASP.NET","name":"x-powered-by","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"beta.cambridgelink.com","path":"/","secure":true,"session":true,"value":"22744E6A353E5A5B93C9E75612EDAAB38655D452F1EFD2A0AE34BACDB13389144CCFC03B5DB2AAC8DE41F328D0C06E444FB9D5AA139CE24EACBA09E48BE33F5BA750B06AE03D8BD9309D929A44076CBF5770A1D3F22DE6911F77C4F27FF7C3350D3659AE03ACDEFA517934AE4C8AF3F2E9D752D7417FE56DE6636CE561BFE942DF285DE9FF70832D271ACA586E4B6C466839BE23E713D68AC2298646E48849F44DE45B3ABD51AB88096F8CED8EAF1278","key":"CMG-AccessToken"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"beta.cambridgelink.com","path":"/","secure":true,"session":true,"value":"en","key":"CMG-Language"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"beta.cambridgelink.com","path":"/","secure":true,"session":true,"value":"B578F09A221901DE8146DDEFE9127D4EE38B14C42C745F5407383CB18A8C1BCB0257235525AB97FC1C6B1838A75FC972414C377A37CF1827B31CD30AEA0E6B5E723D10E93AAE4D5A132FF3F2F59C6DE149F32EF99AF083721F688DD51089975B2751E5A49163FFAD5ECF6EF5CD63DC7B9E346EE69D78630739C9A533B6A97DBE0AA5A64EFA5497983EB3377A51936CE099BB82F7595664D656F37BD259594D25","key":".ASPXAUTH"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"beta.cambridgelink.com","path":"/","secure":true,"session":true,"value":"[\"UPLOAD\"]","key":"CMG-XP"}],"responseTime":null,"body":"{\n \"content\": {\n \"items\": [\n {\n \"id\": \"PURCHASE OF GOOD(S)\",\n \"text\": \"Purchase of Good(s)\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"PURCHASE OF SERVICE(S)\",\n \"text\": \"Purchase of Service(s)\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"PROFESSIONAL FEES PAYMENT\",\n \"text\": \"Professional fees payment (i.e. legal, accountant)\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"PAYROLL/PERSONNEL PAYMENT\",\n \"text\": \"Payroll/Personnel payment\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"PAYMENT FOR A LOAN OR DEPOSIT\",\n \"text\": \"Payment for a loan or deposit\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"BILL PAYMENT\",\n \"text\": \"Bill payment (i.e. credit card, utility)\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"RESEARCH AND DEVELOPMENT\",\n \"text\": \"Research and Development\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"BUSINESS VENTURE\",\n \"text\": \"Business venture (i.e. merger, acquisition)\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"INTERCOMPANY PAYMENT\",\n \"text\": \"Intercompany payment\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"CHARITABLE DONATION\",\n \"text\": \"Charitable donation\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"PURCHASE OF PROPERTY / REAL ESTATE\",\n \"text\": \"Purchase of property / real estate\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"ESTATE SETTLEMENT / INHERITANCE\",\n \"text\": \"Estate settlement / Inheritance\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"GOVERNMENT RELATED PAYMENT\",\n \"text\": \"Government related payment\",\n \"searchText\": \"\"\n },\n {\n \"id\": \"INVESTMENT RELATED PAYMENT\",\n \"text\": \"Investment related payment\",\n \"searchText\": \"\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/paymentPurpose?countryISO=IN&curr=INR&method=W\",\n \"method\": \"GET\"\n }\n ]\n}"}],"_postman_id":"39136fe2-5edc-4990-9010-ce4ea8354d9a"},{"name":"Beneficiary Validation","id":"fa671faf-6fa6-4b62-b4d1-ed9e4e9d660e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"accountHolderName\": \"Jim Tyson\",\r\n\t\"templateIdentifier\": \"Jim Tyson_CAD\",\r\n\t\"destinationCountry\": \"CA\",\r\n\t\"bankCurrency\": \"CAD\",\r\n\t\"classification\": \"Individual\",\r\n\t\"paymentMethods\": [\r\n\t\t\"W\"\r\n\t],\r\n\t\"settlementMethods\": [],\r\n\t\"preferredMethod\": \"W\",\r\n\t\"accountHolderCountry\": \"CA\",\r\n\t\"accountHolderRegion\": \"ONTARIO\",\r\n\t\"accountHolderAddress1\": \"New Street1\",\r\n\t\"accountHolderAddress2\": \"\",\r\n\t\"accountHolderCity\": \"TORONTO\",\r\n\t\"accountHolderPostal\": \"M5H1K5\",\r\n\t\"accountHolderPhoneNumber\": \"\",\r\n\t\"ibanDigits\": \"0\",\r\n\t\"ibanEnabled\": \"false\",\r\n\t\"iban\": \"CA\",\r\n\t\"swiftBicCode\": \"CGAACAMBXXX\",\r\n\t\"bankName\": \"CIBC ASSET MANAGEMENT INC\",\r\n\t\"bankCountry\": \"CA\",\r\n\t\"bankRegion\": \"ONTARIO\",\r\n\t\"bankCity\": \"TORONTO\",\r\n\t\"bankAddressLine1\": \"18 YORK ST, STE 1400\",\r\n\t\"bankAddressLine2\": \"\",\r\n\t\"bankPostal\": \"M5J 2T8\",\r\n\t\"accountNumber\": \"456456456\",\r\n\t\"localAccountNumber\": \"\",\r\n\t\"routingCode\": \"001033613\",\r\n\t\"localRoutingCode\": \"\",\r\n\t\"paymentReference\": \"\",\r\n\t\"internalPaymentAlert\": \"\",\r\n\t\"externalPaymentAlert\": \"\",\r\n\t\"furtherCreditDetails\":\"\",\r\n\t\"sendPayTracker\": \"\",\r\n\t\"accountHolderEmail\": \"tyson@corpay.com\",\r\n\t\"regulatory\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"/api/{clientCode}/0/templates-validate/{clientIntegrationId}","description":"This endpoint validates the beneficiary data submitted in the request body and the response returns whether the beneficiary template is valid. If successful, you can use this payload to successfully create a beneficiary.
\nNote: This endpoint will only validate the beneficiary information without creating a new template. To create a new beneficiary template see POST Create/Edit Bene.
\nIn the following table, unless otherwise noted, required means that the field is required for ALL beneficiaries, regardless of destination. Some destinations require additional information.
\n| Parameter | Description |
|---|---|
accountHolderName | string (required) Full name of the account holder. Maximum 100 characters. |
templateIdentifier | string (required) The client-assigned template identifier. This value should match the 'clientIntegrationId' in the URL. The value in this field is returned in the 'beneIdentifier' field when you run GET View Bene. Maximum 50 characters. |
destinationCountry | string (required) Two-letter ISO code for the country where the beneficiary's bank is located. |
bankCurrency | string (required) Three-letter ISO code for the bank account currency. |
classification | string (required) Beneficiary classification = 'Individual' or 'Business'. |
paymentMethods | array (required)
|
preferredMethod | string (required) Method of payment preferred by this beneficiary. |
accountNumber | string (required) Bank account number. |
localAccountNumber | string (required for EFTs) Bank account number. |
routingCode | string (required for Wires) Bank routing code - used to identify a specific financial institution. In some countries, the routing code is known by another name, such as ABA Number, Transit Number, Sort Code, BSB Number, IFSC Code, or Branch Code. |
localRoutingCode | string (required for EFTs) Bank routing code. |
accountHolderCountry | string (required) The account holder's two-letter ISO country code. |
accountHolderRegion | string (required for Canada or the United States) The account holder's province or state. Maximum 30 characters. |
accountHolderAddress1 | string (required) First line of the account holder's address. Maximum 50 characters. Note: PO Box address not allowed for Canada, Australia, or Mexico |
accountHolderAddress2 | string (optional) Second line of the account holder's address. Maximum 50 characters. Note: PO Box address not allowed for Canada, Australia, or Mexico |
accountHolderCity | string (required) The account holder's city. Maximum 100 characters. |
accountHolderPostal | string (required for Canada or the United States) The account holder's postal or zip code. Maximum 50 characters. |
accountHolderPhoneNumber | integer (optional) The account holder's phone number. |
accountHolderEmail | string (required if 'SendPayTracker' = 'true') Email address. |
sendPayTracker | boolean (optional) Specifies whether to send an email alert to the beneficiary whenever a payment is released = ['true', 'false']. |
iban | string (required for IBAN countries) The bank's IBAN number. The IBAN accurately identifies the correct bank and bank account. |
swiftBicCode | string (required for Wires) The unique identifier for the bank or financial institution. |
bankName | string (required) Name of the financial institution. Maximum 250 characters. |
bankCountry | string (required) The bank's two-letter ISO country code. |
bankRegion | string (required for Canada or the United States) The bank's province or state. Maximum 100 characters. |
bankCity | string (required) The bank's city. Maximum 100 characters. |
bankAddressLine1 | string (required) First line of the bank's address. Maximum 100 characters. |
bankAddressLine2 | string (optional) Second line of the bank's address. Maximum 100 characters. |
bankPostal | string (required for Canada or the United States) The bank's postal or zip code. Maximum 50 characters. |
paymentReference | string (optional) Default payment reference that will be used if a reference is not provided on a payment. The payment reference is transmitted with the payment, subject to banking constraints. |
internalPaymentAlert | string (optional) Internal email addresses to notify when a payment is made to this beneficiary. |
externalPaymentAlert | string (optional) External email addresses to notify when a payment is made to this beneficiary. |
furtherCreditDetails | string (optional) Enter the details of the recipient who will receive the funds — For Further Credit (FFC). E.g., FFC Tom Roe 000304756 |
regulatory | array (required if mandatory for destination country) The fields and corresponding values needed to satisfy regulatory requirements for the destination country. |
| Parameter | Description |
|---|---|
content.sucessValidateMessage | Confirms the beneficiary information is successfully validated and no errors were encountered. |
| Error Code | Description |
|---|---|
400 Bad Request - Value provided doesn't match the RegEx | The value in the specified field does not contain the required number of characters or contains characters that are not allowed. |
400 Bad Request - Field is mandatory | One or more required field values are missing. |
400 Bad Request - Value provided is not in the set of valid values | The value provided is not an allowed value for the specified field. |
400 Bad Request - Beneficiary Identifier has already been assigned | The 'templateIdentifier' already exists and cannot be used again. |
Returns a list of valid region values for the specified country. The response returns both the id and the code; either value is accepted in the region fields when creating/editing beneficiary template.
These endpoints assist with the creation and lookup of beneficiary information.
\nIBAN Validation is recommended for use in IBAN enabled countries, while Bank Search is for countries that do not support IBAN.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"367fb712-a159-48ec-b38a-5c1a3a1eeb8a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"92648052-3ec9-4254-868a-d4b29684f391"}}],"_postman_id":"069d60fa-409c-4068-9e84-da38771d97fd"}],"id":"83f02895-48b2-4333-8bd3-d0dd85328202","description":"The endpoints in this section are used to create functional beneficiary templates that comply with all country-specific regulatory requirements.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"18993c52-024b-4b20-b3cc-8ea7f9f939e3"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0e3ba684-04ca-4e7e-90f3-8963fd933b83"}}],"_postman_id":"83f02895-48b2-4333-8bd3-d0dd85328202"},{"name":"Spot Workflow ","item":[{"name":"[1] Spot Rate","id":"6499f440-a427-48df-b33a-825bec24de82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"body":{"mode":"raw","raw":"{\r\n \"lockSide\": \"Payment\", \r\n \"settlementCurrency\": \"CAD\", \r\n \"amount\": \"10000\", \r\n \"paymentCurrency\": \"USD\"\r\n}\r\n"},"url":"/api/{clientCode}/0/quotes/spot","description":"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).
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).
\nAs market rates are in flux, this quote may expire before you book the deal. By default, the rate expires in 10 seconds.
\nThe quote resource is in the response header under 'Location'. This URL is the precursor to executing the POST Book Deal 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.
\n| Parameter | Description |
|---|---|
| paymentCurrency | string (required) The three-letter ISO code for the payment currency. |
| settlementCurrency | string (required) The three-letter ISO code for the settlement currency. |
| amount | number (required) The amount on which to base the quote. |
| lockSide | string (required) Indicates which currency to lock when the rate calculation is performed = ['payment', 'settlement']. |
| Parameter | Description |
|---|---|
| content.rate.value | The result of applying the 'operation' type to the 'lockside' amount. |
| content.rate.lockSide | The requested value for the 'lockside'. |
| content.rate.rateType | The currency pair used in the rate calculation. Note: The second currency in the pair is the more major of the two in Corpay's internal ranking. |
| content.rate.operation | The operation that is used on the amount to get the quote. Possible values = ['Multiply' or 'Divide']. 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'. |
| content.quoteId | The unique ID assigned to the quote. |
| content.payment.currency | The three-letter ISO code for the payment currency. |
| content.payment.amount | Payment amount. |
| content.settlement.currency | The three-letter ISO code for the settlement currency. |
| content.settlement.amount | Amount of the settlement. |
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.
\n| Error Code | Description |
|---|---|
| 400 Bad Request - Amount exceeds limit | This reflects the per-client threshold on allowed Spot transactions. |
| 400 Bad Request - Unexpected exception | Inputting an invalid currency code will return this error. |
This is the second of two calls that are used to book a live rate as part of a Spot transaction. This call uses the 'quoteId' returned by the POST Spot Rate call to book a deal using the quoted rate.
Important: The quote obtained from POST Spot Rate is valid for 10 seconds, after which it expires. If you don't book the deal before the rate expires, the response status will be '400 (Quote expired)', and you will need to generate a new quote.
Make sure to append the /book at the end of the resource.
The terms 'deal number' and 'order number' have the same meaning.
\n| Error Code | Description |
|---|---|
200 OK - Previously booked URL | The quoteID has already been booked so it can't be booked again. Returns: \"token\": \"00000000-0000-0000-0000-000000000000\" |
404 Not Found Invalid URL invoked | 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 |
410 Gone - Call sent after rate expired | The rate generated by the POST Spot Rate request expires after 10 seconds. |
Once the Spot Transaction has been booked, you can instruct the funds to a beneficiary or an internal holding balance (this is specified in the 'payment' portion of this payload).
\nThe settlement funds (the 'settlement' portion) can come from a bank account or a holding balance. This call also specifies which settlement account to use for fees. In most cases, the account designated for fees contains the base currency (for example, if you are located in Canada, your fee settlement account will be a CAD account).
\nThe total instructed amount does not have to equal the amount exchanged during the Spot Transaction, but it cannot exceed that amount.
\nThis endpoint supports idempotency through the requestId parameter. If the request is repeated with the same idempotencyKey the endpoint will return the original booking result.
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.
\n| Parameter | Description |
|---|---|
requestId | string (optional) Client-generated unique idempotency key for the request |
orderId | string (required) Number of the deal to which the payment and settlement instructions should be applied. |
payments.amount | number (required) Payment amount. |
payments.beneficiaryId | string (required) Identifier of the beneficiary/account to whom the payment will be sent. Value can be either 'clientIntegrationId' or 'id' (which is returned by GETView Bene). |
payments.deliveryMethod | string (required)
|
payments.currency | string (required) Three-letter ISO code for the payment currency. |
payments.purposeOfPayment | string (required) The purpose of payment Can be found here: GETPurpose of Payment Allowed input limit: Max 50 characters. Returns 500 error if max input limit exceeded. |
payments.paymentReference | string (optional) Reference to be included with the payment, for example, purchase order number or invoice number. Allowed input limit: Max 120 characters. Returns 500 error if max input limit exceeded. |
payments.remitterId | string (optional) Identifier of the remitter on whose behalf the payment is being made. |
settlements.accountId | string (required) Settlement account identifier. |
settlements.deliveryMethod | string (required)
|
settlements.currency | string (required) Three-letter ISO code for the settlement account currency. |
settlements.purpose | string (required) The reason for the settlement = ['All', 'Allocation', 'Fee', 'Spot', 'SpotTrade', 'Drawdown']. |
| Parameter | Description |
|---|---|
content.ordNum | Unique global identifier of the order. |
content.valueDate | Order value date. |
content.fees | Fee amount. |
content.payments.paymentInstructionId | Internal Identifier of the Payment Instruction. Different from the Deal and/or Order Numbers. |
content.payments.availableDate | The date when the payment will be received by the beneficiary. |
content.payments.orderId | An internal identifier for the order. Different from the global 'ordNum'. |
content.payments.amount | The amount paid to the beneficiary. |
content.payments.currency | The currency in which the beneficiary will receive the payment. |
content.payments.approvalStatus | An internal indicator of the payment status. Only relevant if there is an approval model set up with the account. Possible values:
|
content.payments.feeAmount | The amount of the fee levied on the payment. |
content.payments.feeCurrency | Currency of the fee. |
content.payments.estimateCostAmount | The cost of the settlement currency. |
content.payments.estimateCostCurrency | The currency of the settlement part of the transaction. |
content.payments.beneId | The beneficiary's 'id' found in the GETView Beneendpoint. |
content.payments.reference | Payment References carried on from the 'paymentReference' field. |
content.payments.method | Method to use to send the payment. Possible values returned = ['W', 'E', 'C'].
|
content.payments.payeeName | The name of the beneficiary/account to whom the payment will be sent. |
content.payments.accountType | The out-going template type. Possible values returned:
|
content.payments.payeeAccount | The account number of the payee account. |
content.payments.clientIntegrationId | The unique identifier assigned to the beneficiary. |
content.payments.trackerId | The unique tracker identifier assigned to a payment transaction. |
content.settlements.accountId | Settlement account identifier. |
content.settlements.method | Method to use to settle the deal. Possible values returned = ['W', 'E', 'C'].
|
content.settlements.methodDescription | The description for 'settlements.method'. Possible values returned = ['Wire', 'CLIAB', 'iACH'].
|
content.settlements.accountDetails | Displays the name on the account for the incoming template. |
content.settlements.paymentIdent | An internal identifier of the payment account. Not to be confused with the payment account identifier ('accountId') which is used when instructing the deal. |
content.settlements.settlementId | An internal identifier of the settlement account. Not to be confused with the settlement account identifier ('accountId') which is used when instructing the deal. |
content.settlements.isFee | Indicates whether the settlement account listed will also be used to settle the fee. |
content.settlements.amount | The settled amount of the transaction. |
content.settlements.currency | Currency of the Settlement part of the transaction. |
content.settlements.accountType | The template type used for settlement. Possible values returned = ['settlement']. |
content.orderDetail.ordNum | The order number is the unique global identifier of the order. |
content.orderDetail.buy | ISO 3 currency code of the buy-side currency. |
content.orderDetail.buyAmount | Amount of the buy-side currency. |
content.orderDetail.sell | ISO 3 currency code of the sell-side currency. |
content.orderDetail.sellAmount | Amount of the sell-side currency. |
content.orderDetail.exchange | The quoted amount’s all-in rate as part of the spot transaction. |
content.orderDetail.ourAction | Value is always set to 'Sell'. Denotes the action that Corpay undertakes to exchange the two currencies. |
content.orderDetail.entryDate | Timestamp of the deal when the order was entered. |
content.orderDetail.token | The session token. |
content.regEDisclosure.regulatoryAgencyName | Financial Institution responsible for investigating and resolving claims. |
content.regEDisclosure.transferFees | Transfer fee charged. |
content.regEDisclosure.transferFeesCurr | Transfer fee currency. |
content.regEDisclosure.regulatoryPhone | Regulatory Financial Institution phone number. |
content.regEDisclosure.regulatoryEmail | Regulatory Financial Institution email address. |
content.regEDisclosure.regulatoryWebsite | Regulatory Financial Institution website. |
content.regEDisclosure.regulatoryAddressLine1 | Regulatory Financial Institution address line 1. |
content.regEDisclosure.regulatoryAddressLine2 | Regulatory Financial Institution address line 2. |
content.regEDisclosure.regulatoryAddressLine3 | Regulatory Financial Institution address line 3. |
content.regEDisclosure.regulatedBy | The regulatory body that governs the Financial Institution. Possible values returned = ['State', 'Federal'] |
content.regEDisclosure.regulatedState | The regulatory state. |
content.regEDisclosure.regulatedStatePhone | Phone number of the state regulator. |
content.regEDisclosure.regulatedStateEmail | Email address of the state regulator. |
content.regEDisclosure.regulatedStateWebsite | URL of the state regulator. |
content.regEDisclosure.regulatedStateAddressLine1 | State regulator address line 1. |
content.regEDisclosure.regulatedStateAddressLine2 | State regulator address line 2. |
content.regEDisclosure.regulatedStateAddressLine3 | State regulator address line 3. |
content.regEDisclosure.regulatedStateAddressLine4 | State regulator address line 4. |
| Error Code | Description |
|---|---|
400 Bad Request - Incorrect settlement account / Incorrect deliveryMethod | Either the client does not have the permission set to settle with this account type, or the account identifier provided in the request is incorrect. |
400 Bad Request - Incorrect bene / Incorrect deliveryMethod | Could be one of the following:
|
400 Bad Request - Invalid / already-instructed Order Number | The order number has already been instructed, or it doesn't belong to your account. |
400 Bad Request - Amount exceeds Spot balance | The order does not contain the funds available to pay the beneficiary. A top-up is not possible. |
Allows you to view the following information for a specific order:
\n'regEDisclosure' - RegE Disclosure information (if applicable)
\n'payments' - beneficiary details
\n'settlements' - settlement details
\n'orderDetails' - rates, amounts, trade details, etc.
\nNote: 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.
\n| Parameter | Description |
|---|---|
content.payments.paymentInstructionId | Internal Identifier of the Payment Instruction. Different from the Deal and/or Order Numbers. |
content.payments.orderId | An internal identifier for the order. Different from the global 'ordNum'. |
content.payments.amount | The amount paid to the beneficiary. |
content.payments.currency | The currency in which the beneficiary will receive the payment. |
content.payments.approvalStatus | An internal indicator of the payment status. Only relevant if there is an approval model set up with the account. Possible values:
|
content.payments.feeAmount | The amount of the fee levied on the payment. |
content.payments.feeCurrency | Currency of the fee. |
content.payments.estimateCostAmount | The cost of the settlement currency. |
content.payments.estimateCostCurrency | The currency of the settlement part of the transaction. |
content.payments.beneId | The beneficiary's 'id' found in the GET View Bene endpoint. |
content.payments.reference | Payment References carried on from the 'paymentReference' field in POST Instruct Deal. |
content.payments.method | Method to use to send the payment. Possible values returned = ['W', 'E', 'C'].
|
content.payments.payeeName | The name of the beneficiary/account to whom the payment will be sent. |
content.payments.accountType | The out-going template type. Possible values returned:
|
content.payments.payeeAccount | The account number of the payee account. |
content.payments.clientIntegrationId | The unique beneficiary identifier. |
content.payments.trackerId | The unique tracker identifier assigned to a payment transaction. |
content.payments.links | HATEOAS link to 'Bene Autocomplete Details'. |
content.settlements.accountId | Settlement account identifier. |
content.settlements.method | Method to use to settle the deal. Possible values returned = ['W', 'E', 'C'].
|
content.settlements.methodDescription | The description for 'settlements.method'. Possible values returned = ['Wire', 'CLIAB', 'iACH'].
|
content.settlements.accountDetails | Displays the name on the account for the incoming template. |
content.settlements.paymentIdent | An internal identifier of the payment account. Not to be confused with the payment account identifier ('accountId') which is used when instructing the deal. |
content.settlements.settlementId | An internal identifier of the settlement account. Not to be confused with the settlement account identifier ('accountId') which is used when instructing the deal. |
content.settlements.isFee | Indicates whether the settlement account listed will also be used to settle the fee. |
content.settlements.amount | The settled amount of the transaction. |
content.settlements.currency | Currency of the Settlement part of the transaction. |
content.settlements.accountType | The template type used for settlement. Possible values returned = ['settlement']. |
content.settlements.links | HATEOAS link to .Bene Autocomplete Details. |
content.orderDetails.entryDate | Timestamp of the deal when the order was entered. |
content.orderDetails.ordNum | The order number is the unique global identifier of the order. |
content.orderDetails.buy | ISO 3 currency code of the buy-side currency. |
content.orderDetails.buyAmount | Amount of the buy-side currency. |
content.orderDetails.sell | ISO 3 currency code of the sell-side currency. |
content.orderDetails.sellAmount | Amount of the sell-side currency. |
content.orderDetails.exchange | The quoted amount’s all-in rate as part of the spot transaction. |
content.orderDetails.ourAction | Value is always set to 'Sell'. Denotes the action that Corpay undertakes to exchange the two currencies. |
content.orderDetails.token | The session token. |
content.rate.rateType | The currency pair used in the rate calculation. Note: The second currency in the pair is the more major of the two in Corpay's internal ranking. |
content.regEDisclosure.regulatoryAgencyName | Financial Institution responsible for investigating and resolving claims. |
content.regEDisclosure.transferFees | Amount of transfer fees charged. |
content.regEDisclosure.transferFeesCurr | Transfer fee currency. |
content.regEDisclosure.regulatoryPhone | Regulatory Financial Institution phone number. |
content.regEDisclosure.regulatoryEmail | Regulatory Financial Institution email address. |
content.regEDisclosure.regulatoryWebsite | Regulatory Financial Institution website. |
content.regEDisclosure.regulatoryAddressLine1 | Regulatory Financial Institution address line 1. |
content.regEDisclosure.regulatoryAddressLine2 | Regulatory Financial Institution address line 2. |
content.regEDisclosure.regulatoryAddressLine3 | Regulatory Financial Institution address line 3. |
content.regEDisclosure.regulatedBy | The regulatory body that governs the Financial Institution. Possible values returned = ['State', 'Federal'] |
content.regEDisclosure.regulatedState | The regulatory state. |
content.regEDisclosure.regulatedStatePhone | Phone number of the state regulator. |
content.regEDisclosure.regulatedStateEmail | Email address of the state regulator. |
content.regEDisclosure.regulatedState | WebsiteURL of the state regulator. |
content.regEDisclosure.regulatedStateAddressLine1 | State regulator address line 1. |
content.regEDisclosure.regulatedStateAddressLine2 | State regulator address line 2. |
content.regEDisclosure.regulatedStateAddressLine3 | State regulator address line 3. |
content.regEDisclosure.regulatedStateAddressLine4 | State regulator address line 4. |
When you run the Spot Rate call POST Spot Rate, a resource is created that contains the conversion and quote information. This endpoint returns the resource details.
| Parameter | Description |
|---|---|
| content.id | The quote's resource identifier. |
| content.expiry | The number of seconds before the quote expires. |
| content.isOverLimit | Indicates whether the amount on the booked deal exceeds the trade limit allowed on the account. |
| content.quoteTimestamp | Timestamp when the quote was called. |
| content.expiryTimestamp | Timestamp when the quote expires ('quoteTimeStamp' + 'expiry'). |
| content.payment.currency | Currency of the payment. |
| content.payment.amount | Amount of the payment. |
| content.settlement.currency | Currency of the settlement. |
| content.settlement.amount | Amount of the settlement. |
| content.rate.value | The result of the 'lockside' amount and the operation 'type' (as either a multiple or a quotient). |
| content.rate.lockSide | The base currency of the pair; the opposite of the quoted currency. The value can be 'payment' or 'settlement'. |
| content.rate.rateType | The currency pair used in the rate calculation. Note: The second currency in the pair is the more major of the two in Corpay's internal ranking. |
| content.expiryRemaining | The number of seconds left between booking the rate and the rate expiry ('Book' - 'expiryTimestamp') |
| content.requestDuration | The duration of the call between the 'quoteTimestamp' and 'Booking' |
| content.rateDifferential | The differential in interest rates between the two currencies. |
This call lists all of the 'Get Rate' requests – POST Spot Rate – in chronological order. Even though the retrieved quotes may not have been booked, they still appear in this list.
To view the details of a particular quote, append the 'quoteId' to the URL.
\n","urlObject":{"path":["api","{clientCode}","0","quotes",""],"query":[],"variable":[]}},"response":[{"id":"9639e71c-32f4-4395-a156-4393be475da5","name":"200 GET Quotes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":"https://crossborder.corpay.com/api/{clientCode}/0/quotes/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"https://beta.cambridgelink.com","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource.","enabled":true},{"key":"CMG-AccessToken","value":"4B11A801360FCDE07CF4557886E66B3F62603D17041F8618CD87EE1F4C38B5253EEDAD57B27D83473B15E852B60125E9F984CC633D805E42A0D57CAF89E7F160EBD7CF202543AA96074EF5F0140B9EF1BD82BBF42F6A430CAC8BAB60504ED5F8EF3BC017625DAC3FD7EF4C79CC8EC39314002C2EA0BC11170D0440865D3D2FBA281EF523B4C0730727F6745F3DEE9879FC9C5A5256149B19B378A90F571588B682F3A476FEC158F42A45287E4FDE393D","description":"Custom header","enabled":true},{"key":"Cache-Control","value":"no-cache","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds","enabled":true},{"key":"Content-Length","value":"6246","description":"The length of the response body in octets (8-bit bytes)","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","description":"The mime type of this content","enabled":true},{"key":"Date","value":"Tue, 25 Sep 2018 19:18:54 GMT","description":"The date and time that the message was sent","enabled":true},{"key":"Expires","value":"-1","description":"Gives the date/time after which the response is considered stale","enabled":true},{"key":"Pragma","value":"no-cache","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain.","enabled":true},{"key":"Server","value":"Microsoft-IIS/7.5","description":"A name for the server","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","description":"Custom header","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": \"92227962ef1a4c8d9a7fe403125567ab\",\n \"userDisplayName\": \"John Doe\",\n \"quoteTimestamp\": \"2018-09-25T10:43:29.567\",\n \"paymentCurrency\": \"USD\",\n \"paymentAmount\": 10000,\n \"settlementCurrency\": \"CAD\",\n \"settlementAmount\": 13455.3,\n \"rate\": 1.34553,\n \"lockSide\": \"Payment\",\n \"status\": \"NA\",\n \"isOverLimit\": false,\n \"rateType\": \"USDCAD\"\n },\n {\n \"id\": \"13201ad274c84246b37208b2e6508f69\",\n \"userDisplayName\": \"John Doe\",\n \"quoteTimestamp\": \"2018-08-13T10:02:44.843\",\n \"paymentCurrency\": \"USD\",\n \"paymentAmount\": 10000,\n \"settlementCurrency\": \"CAD\",\n \"settlementAmount\": 13319,\n \"rate\": 1.3319,\n \"lockSide\": \"Payment\",\n \"status\": \"NA\",\n \"isOverLimit\": false,\n \"rateType\": \"USDCAD\" \n },\n {\n \"id\": \"c31955f585704e4f9fa95ac52ef6a992\",\n \"userDisplayName\": \"John Doe\",\n \"quoteTimestamp\": \"2018-08-07T15:27:31.933\",\n \"paymentCurrency\": \"USD\",\n \"paymentAmount\": 10000,\n \"settlementCurrency\": \"CAD\",\n \"settlementAmount\": 13325,\n \"rate\": 1.3325,\n \"lockSide\": \"Payment\",\n \"status\": \"NA\",\n \"isOverLimit\": false,\n \"rateType\": \"USDCAD\" \n },\n {\n \"id\": \"849ba0fec42049a0a27947487bb995b3\",\n \"userDisplayName\": \"John Doe\",\n \"quoteTimestamp\": \"2018-08-07T15:26:30.797\",\n \"paymentCurrency\": \"USD\",\n \"paymentAmount\": 10000,\n \"settlementCurrency\": \"CAD\",\n \"settlementAmount\": 13325,\n \"rate\": 1.3325,\n \"lockSide\": \"Payment\",\n \"status\": \"NA\",\n \"isOverLimit\": false,\n \"rateType\": \"USDCAD\" \n },\n {\n \"id\": \"0163b5d1e0284914984e4e0ba27a2f79\",\n \"userDisplayName\": \"John Doe\",\n \"quoteTimestamp\": \"2018-08-07T11:09:49.813\",\n \"paymentCurrency\": \"USD\",\n \"paymentAmount\": 10000,\n \"settlementCurrency\": \"CAD\",\n \"settlementAmount\": 13034,\n \"rate\": 1.3034,\n \"lockSide\": \"Payment\",\n \"status\": \"NA\",\n \"isOverLimit\": false,\n \"rateType\": \"USDCAD\" \n },\n {\n \"id\": \"8dd971d4bf7f4c09b9491de2d64174f0\",\n \"userDisplayName\": \"John Doe\",\n \"quoteTimestamp\": \"2018-08-07T11:09:11.47\",\n \"paymentCurrency\": \"USD\",\n \"paymentAmount\": 10000,\n \"settlementCurrency\": \"CAD\",\n \"settlementAmount\": 13034,\n \"rate\": 1.3034,\n \"lockSide\": \"Payment\",\n \"status\": \"NA\",\n \"isOverLimit\": false,\n \"rateType\": \"USDCAD\" \n },\n {\n \"id\": \"01c53959cdbe4163a6e6508fc66ffb03\",\n \"userDisplayName\": \"John Doe\",\n \"quoteTimestamp\": \"2018-07-25T14:11:22.12\",\n \"paymentCurrency\": \"USD\",\n \"paymentAmount\": 201,\n \"settlementCurrency\": \"CAD\",\n \"settlementAmount\": 261.98,\n \"rate\": 1.3034,\n \"lockSide\": \"Payment\",\n \"status\": \"NA\",\n \"isOverLimit\": false,\n \"rateType\": \"USDCAD\" \n },\n {\n \"id\": \"5daae705c4f6486b8ba8a0c89e1111bc\",\n \"userDisplayName\": \"John Doe\",\n \"quoteTimestamp\": \"2018-07-23T11:26:23.917\",\n \"paymentCurrency\": \"USD\",\n \"paymentAmount\": 12345,\n \"settlementCurrency\": \"MDL\",\n \"settlementAmount\": 211513.75,\n \"rate\": 0.058365,\n \"lockSide\": \"Payment\",\n \"status\": \"NA\",\n \"isOverLimit\": false,\n \"rateType\": \"MDLUSD\" \n }\n ],\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/quotes/\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"SESSION\",\n \"uri\": \"https://crossborder.corpay.com/api\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"CLIENT_DATA\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0\",\n \"method\": \"GET\"\n }\n ]\n}"}],"_postman_id":"4002b574-bc4a-428b-9107-0bf9ae7fab4b"},{"name":"Indicative Rates","id":"1f631268-0966-4314-929d-d89259e818c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":"https://crossborder.corpay.com/api/{clientCode}/0/indicative-rates/spot?paymentCurrency={currencyISO}&settlementCurrency={currencyISO}&amount={quoteamount}&lockSide={Payment or Settlement}","description":"This API returns an indicative rate and amount for a Spot transaction based on a live exchange rate (between a currency pair).
\nThe lockside determines which side of the pair will carry the base amount. For example, for a EUR/USD spot deal, if lockside is set to the payment currency (which in this case is EUR), then the quoted amount will be the settlement currency (or USD in this case).
Note: This rate is indicative only and may change when you get a quote from POST Spot Rate for booking a deal.
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:
\nCreates a new Rate Order. You can create Spot Rate Orders and Forward Rate Orders. Forward Rate Orders can be either Closed Forwards or Open Forwards.
\n| Parameter | Description |
|---|---|
| buyCurrency | string (required) The three-letter ISO code for the buy currency. |
| sellCurrency | string (required) The three-letter ISO code for the sell currency. |
| amount | number (required) The amount of the buy currency. |
| rate | string (required) The rate at which you want the Rate Order to be filled. |
| expiryDate | string (required) The date when the Rate Order expires. |
| lockSide | string (required) Indicates which currency to lock when the rate calculation is performed = ['Payment' or 'Settlement']. |
| limitOrderType | string (required) The type of Rate Order = ['Spot' or 'Forward']. |
| openDateFrom | string (required if 'limitOrderType' = 'Forward' and 'forwardType' = 'O') The first date that you can draw down against the forward, formatted as yyyy-mm-dd. |
| maturityDate | string (required if 'limitOrderType' = Forward) The last date the funds can be used, formatted as yyyy-mm-dd. |
| forwardType | string (required if 'limitOrderType' = 'Forward')
|
Retrieves complete information for all of your Rate Orders.
| Parameter | \nDescription | \n
|---|---|
| content.rows.id | \nThe Rate Order identifier. | \n
| content.rows.productType | \nThe type of Rate Order. Possible values = ['Spot' or 'Forward'] | \n
| content.rows.buy | \nThe three-letter ISO code for the buy currency. | \n
| content.rows.sell | \nThe three-letter ISO code for the sell currency. | \n
| content.rows.buyAmount | \nThe amount of the buy currency. | \n
| content.rows.sellAmount | \nThe amount of the sellcurrency. | \n
| content.rows.status | \nThe status of the Rate Order. Possible values = ['F', 'P', 'E', 'X'].
| \n
| content.rows.entryDate | \nThe date that the order was created, formatted as yyyy-mm-dd. | \n
| content.rows.filledDate | \nThe date the order was filled, formatted as yyyy-mm-dd. If the order is pending, returns null. | \n
| content.rows.targetRate | \nThe rate at which the Rate Order can be filled. | \n
| content.rows.expiryDate | \nThe date when the Rate Order expires. | \n
Optional
\n","type":"text/plain"},"key":"type","value":"{'LimitOrder'}"},{"description":{"content":"Optional
\n","type":"text/plain"},"key":"sort","value":"{'asc' or 'desc'}"}],"variable":[]}},"response":[{"id":"ee872cf4-52dd-4b2a-98f1-2933ade7bc93","name":"200 Get Rate Orders","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}","type":"text"}],"url":{"raw":"https://crossborder.corpay.com/api/{client code}/0/limitOrders?type=LimitOrder&sort=desc","protocol":"https","host":["crossborder","corpay","com"],"path":["api","{client code}","0","limitOrders"],"query":[{"key":"type","value":"LimitOrder"},{"key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*","description":"","type":"text","enabled":true},{"key":"cache-control","value":"no-cache","description":"","type":"text","enabled":true},{"key":"content-length","value":"13286","description":"","type":"text","enabled":true},{"key":"content-type","value":"application/json; charset=utf-8","description":"","type":"text","enabled":true},{"key":"date","value":"Wed, 13 Oct 2021 20:00:12 GMT","description":"","type":"text","enabled":true},{"key":"expires","value":"-1","description":"","type":"text","enabled":true},{"key":"pragma","value":"no-cache","description":"","type":"text","enabled":true},{"key":"server","value":"Microsoft-IIS/7.5","description":"","type":"text","enabled":true},{"key":"x-aspnet-version","value":"4.0.30319","description":"","type":"text","enabled":true},{"key":"x-powered-by","value":"ASP.NET","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"data\": {\n \"pagination\": {\n \"total\": 9,\n \"skip\": 0,\n \"take\": 9\n },\n \"links\": [\n {\n \"rel\": \"DATA\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders?type=LimitOrder&sort=entryDate desc\",\n \"method\": \"GET\"\n }\n ],\n \"sorting\": [\n {\n \"column\": \"entryDate\",\n \"dir\": \"desc\"\n }\n ],\n \"rows\": [\n {\n \"id\": \"LIM018125\",\n \"productType\": \"SPOT\",\n \"buy\": \"CAD\",\n \"sell\": \"USD\",\n \"buyAmount\": 110,\n \"sellAmount\": 82.71,\n \"status\": \"P\",\n \"entryDate\": \"2021-07-09T09:25:59.017\",\n \"filledDate\": null,\n \"targetRate\": 1.33,\n \"expiryDate\": \"2021-07-23T09:00:00\",\n \"links\": [\n {\n \"rel\": \"CANCEL_LIMIT_ORDER\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/LIM018125\",\n \"method\": \"DELETE\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018125\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"id\": \"LIM018118\",\n \"productType\": \"FORWARD\",\n \"buy\": \"GBP\",\n \"sell\": \"CAD\",\n \"buyAmount\": 55000.11,\n \"sellAmount\": 95023.69,\n \"status\": \"F\",\n \"entryDate\": \"2021-07-08T10:03:53.64\",\n \"filledDate\": \"2021-07-08T10:03:59.717\",\n \"targetRate\": 1.7277,\n \"expiryDate\": \"2021-07-09T09:00:00\",\n \"links\": [\n {\n \"rel\": \"ORDER\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/orders/OFD10156670\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018118\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"id\": \"LIM018117\",\n \"productType\": \"FORWARD\",\n \"buy\": \"GBP\",\n \"sell\": \"CAD\",\n \"buyAmount\": 44000.11,\n \"sellAmount\": 76018.99,\n \"status\": \"F\",\n \"entryDate\": \"2021-07-08T10:00:50.663\",\n \"filledDate\": \"2021-07-08T10:01:34.837\",\n \"targetRate\": 1.7277,\n \"expiryDate\": \"2021-07-09T09:00:00\",\n \"links\": [\n {\n \"rel\": \"ORDER\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/orders/OFD10156668\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018117\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"id\": \"LIM018116\",\n \"productType\": \"FORWARD\",\n \"buy\": \"GBP\",\n \"sell\": \"CAD\",\n \"buyAmount\": 33000.11,\n \"sellAmount\": 56941.69,\n \"status\": \"F\",\n \"entryDate\": \"2021-07-08T09:58:13.987\",\n \"filledDate\": \"2021-07-08T09:58:27.55\",\n \"targetRate\": 1.7255,\n \"expiryDate\": \"2021-07-09T09:00:00\",\n \"links\": [\n {\n \"rel\": \"ORDER\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/orders/eFD161586\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018116\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"id\": \"LIM018115\",\n \"productType\": \"FORWARD\",\n \"buy\": \"GBP\",\n \"sell\": \"CAD\",\n \"buyAmount\": 22000.11,\n \"sellAmount\": 37991.99,\n \"status\": \"F\",\n \"entryDate\": \"2021-07-08T09:56:40.53\",\n \"filledDate\": \"2021-07-08T09:56:49.67\",\n \"targetRate\": 1.7269,\n \"expiryDate\": \"2021-07-09T09:00:00\",\n \"links\": [\n {\n \"rel\": \"ORDER\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/orders/OFD10156666\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018115\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"id\": \"LIM018114\",\n \"productType\": \"FORWARD\",\n \"buy\": \"GBP\",\n \"sell\": \"CAD\",\n \"buyAmount\": 3000.11,\n \"sellAmount\": 5180.89,\n \"status\": \"F\",\n \"entryDate\": \"2021-07-08T09:54:50.95\",\n \"filledDate\": \"2021-07-08T09:55:02.01\",\n \"targetRate\": 1.7269,\n \"expiryDate\": \"2021-07-09T09:00:00\",\n \"links\": [\n {\n \"rel\": \"ORDER\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/orders/OFD10156664\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018114\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"id\": \"LIM018074\",\n \"productType\": \"SPOT\",\n \"buy\": \"gbp\",\n \"sell\": \"cad\",\n \"buyAmount\": 200100.11,\n \"sellAmount\": 344372.29,\n \"status\": \"X\",\n \"entryDate\": \"2021-07-01T12:56:59.55\",\n \"filledDate\": null,\n \"targetRate\": 1.721,\n \"expiryDate\": \"2021-11-01T09:00:00\",\n \"links\": [\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018074\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"id\": \"LIM018073\",\n \"productType\": \"SPOT\",\n \"buy\": \"GBP\",\n \"sell\": \"CAD\",\n \"buyAmount\": 200100.11,\n \"sellAmount\": 344372.29,\n \"status\": \"P\",\n \"entryDate\": \"2021-07-01T12:56:48.157\",\n \"filledDate\": null,\n \"targetRate\": 1.721,\n \"expiryDate\": \"2021-11-01T09:00:00\",\n \"links\": [\n {\n \"rel\": \"CANCEL_LIMIT_ORDER\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/LIM018073\",\n \"method\": \"DELETE\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018073\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"id\": \"LIM017269\",\n \"productType\": \"SPOT\",\n \"buy\": \"GBP\",\n \"sell\": \"CAD\",\n \"buyAmount\": 8955.22,\n \"sellAmount\": 15000,\n \"status\": \"F\",\n \"entryDate\": \"2021-04-26T20:04:07.217\",\n \"filledDate\": \"2021-04-28T09:51:22.973\",\n \"targetRate\": 1.675,\n \"expiryDate\": \"2021-06-01T09:00:00\",\n \"links\": [\n {\n \"rel\": \"ORDER\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/orders/10144378\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM017269\",\n \"method\": \"GET\"\n }\n ]\n }\n ]\n }\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders?type=LimitOrder\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"SESSION\",\n \"uri\": \"https://crossborder.corpay.com/api\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"CLIENT_DATA\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0\",\n \"method\": \"GET\"\n }\n ]\n}"}],"_postman_id":"bfd9d257-dade-434c-8f1d-0ec4e52d5533"},{"name":"Delete Rate Order","id":"aba1cc3a-1bff-4e0c-8327-0d51463d1b85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/api/{clientCode}/0/limitOrders/{id}","description":"This endpoint permanently deletes the specified Rate Order. You cannot delete more than one Rate Order at the same time.
\n","urlObject":{"path":["api","{clientCode}","0","limitOrders","{id}"],"query":[],"variable":[]}},"response":[{"id":"d2434af4-d3e9-4639-8f28-ae2e01a84904","name":"200 Delete Rate Order","originalRequest":{"method":"DELETE","header":[],"url":"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"errorCode\": 0,\n \"message\": \"Your order cancelled successfully.\"\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/LIM018045\",\n \"method\": \"DELETE\"\n },\n {\n \"rel\": \"LIMITORDER_CONFIRMATIONS\",\n \"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/limitOrders/confirmation/LIM018045\",\n \"method\": \"GET\"\n }\n ]\n}"}],"_postman_id":"aba1cc3a-1bff-4e0c-8327-0d51463d1b85"}],"id":"e6dd5124-b492-4ddf-a03a-af3832ca90f9","description":"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.
\nImportant: A Rate Order is not guaranteed to fill.
This endpoint and the following two calls (ordered [1] through [3]) must be submitted in quick succession within the allotted time (default, but adjustable, 10 second window). This call is the Request for Forward Contract information. If all information is provided correctly, the subsequent call - GET Retrieve Forward Quote – will return the quote details.
| Parameter | Description |
|---|---|
| amount | number (required) The amount of currency locked into the forward agreement. |
| buyCurrency | string (required) Three-letter ISO code for the currency being bought. |
| forwardType | string (required) Contract type is determined according to business needs. Possible values = ['C', closed contract; 'O', open contract]. |
| lockSide | string (required) Indicates which currency should be locked when the rate calculation is performed = ['payment', 'settlement']. |
| maturityDate | string (required) The date of forward maturity, formatted as yyyy-mm-dd. |
| OpenDateFrom | string (required if 'forwardType': 'O') Applies only to Open Forwards. |
| sellCurrency | string (required) Three-letter ISO code for the settlement-side currency. |
| Parameter | Description |
|---|---|
| content.rate.value | The result of applying the 'operation' type to the 'lockside' amount. |
| content.rate.lockSide | The requested value for the 'lockside'. |
| content.rate.rateType | The currency pair used in the rate calculation. Note: The second currency in the pair is the more major of the two in Corpay's internal ranking. |
| content.rate.operation | The operation that is used on the amount to get the quote. Possible values = ['Multiply' or 'Divide']. 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'. |
| content.quoteId | The unique ID assigned to the quote. |
| content.payment.currency | The three-letter ISO code for the payment currency. |
| content.payment.amount | Payment amount. |
| content.settlement.currency | The three-letter ISO code for the settlement currency. |
| content.settlement.amount | Amount of the settlement. |
| Error Code | Description |
|---|---|
| 400 Bad Request - Inputted Buy Currency is not available | \"buyCurrency\" is not available as a Corpay-offered currency. |
This is the final of three endpoints that books the rate and amount in question.
The URL for this endpoint is found in the Response Body of the previous endpoint as a HATEOAS link.
If you don't book the deal before the rate expires, the response status will be '400 (Quote expired)', and you will need to generate a new quote. The Response – if successful – includes the 'orderNumber'.
This is the final step of the forward process and it completes the order. The URL for this endpoint is found in the Response Body of the previous endpoint as a HATEOAS link.\n
| Parameter | \nDescription | \n
|---|---|
| settlementAccount | \nstring (required) The settlement account. | \n
| forwardReference | \nstring (optional) Any comments or reference information related to the forward. | \n
This call returns details about the forward quote requested in the previous call POST Request Forward Quote.
The URL for this endpoint is found in the Response Body of the previous endpoint as a HATEOAS link.
If the content in the Response is empty and the status code is '410 Gone', this means that the quote has expired.
| Parameter | Description |
|---|---|
| content.id | The quote’s unique resource identifier. |
| content.expiry | The allotted window of time, expressed in seconds. |
| content.isOverLimit | Indicates whether the amount exceeds the trade limit allowed on the account. |
| content.quoteTimeStamp | Timestamp when the quote was called. |
| content.expiryTimeStamp | Timestamp when the quote expires ('quoteTimeStamp' + 'expiry'). |
| content.payment.currency | Currency of the payment. |
| content.payment.amount | Amount of the payment. |
| content.settlement.currency | Currency of the settlement. |
| content.settlement.amount | Amount of the settlement. |
| content.rate.value | The result of taking the amount specified on the 'lockside' field and performing the operation indicated on the 'type' field (as either a multiple or a quotient). |
| content.rate.lockside | The base currency of the pair, opposite of the quoted currency. Either 'Payment' or 'Settlement'. |
| content.rate.type | Addresses the 'operation' that is performed on the base currency to obtain the quoted rate. Allowed values are ‘Multiply’ or ‘Divide’. |
| content.expiryRemaining | The number of seconds left before the rate expires. |
| content.requestDuration | The duration of the call between the 'quoteTimestamp' and 'Booking'. |
This call is used after you book the rate and amount in the forward agreement.
\nThe URL for this endpoint is found in the Response Body of the previous endpoint (POST [3] Book Forward Quote) as a HATEOAS link.
The URL now contains the 'forwardID', which is different from the 'orderNumber' (which is handed in the Response Body).
\n| Parameter | Description |
|---|---|
| content.ordNum | The order number of the forward. |
| content.contractType.id | Indicates the type of Forward Contract. Possible values = ['O', 'C']. |
| content.contractType.text | Indicates the type of Forward Contract. Possible values = ['Open', 'Closed']. |
| content.maturityDate | Timestamp of the maturity date. |
| content.amountBought.currency | The payment currency. |
| content.amountBought.amount | The payment amount. |
| content.amountSold.currency | The settlement currency. |
| content.amountSold.amount | The settlement amount. |
| content.rate.directive | Formula is 'amountBought.amount' ÷ 'amountSold.amount' |
| content.rate.inverse | The inverse of the above. The formula is 'amountBought.amount' x 'amountSold.amount' |
| content.deposit.currency | The currency the deposit is paid in; the settlement currency. |
| content.deposit.amount | The amount required for the deposit (in the 'content.deposit.currency' currency). |
| content.openDate | Timestamp of the Open Date. |
This endpoint returns the clauses in the Master Hedging Agreement contract. The Response Body lists the contractual restrictions when creating forwards.
\n| Parameter | Description |
|---|---|
| content.forwardMaturityDays | The minimum number of days allowed between the start date and the maturity date. |
| content.clientLimit.amount | The maximum amount that could be used as settlement as part of the forward agreement. |
| content.clientLimit.currency | The SELL currency applicable to the 'clientLimit.amount'. |
| content.bookdate | The earliest date the forward agreement will go into effect once the order is completed. |
| content.contractTypes | Possible values = ['C', closed contract; 'O', open contract]. Contract type is determined by business needs. |
| content.allowBookDeals | Indicates whether the client is allowed to book deals = [true, false]. |
| content.marginCallPercent | The allowed loan amount as a percentage of the initial investment. |
| content.marginCallPercentMessages | The Response message (displayed on the UI) stating the deposit percentage required to be placed with each booked forward. |
| content.baseCurrency | The sell currency. Same as the 'clientLimit.currency' field. |
| content.skipStep3 | Internal use only. |
| content.forwardAgreement.hedgingAgreement | Indicates whether the Hedging Agreement has been signed under the account. Possible values = [true, false]. |
| content.forwardAgreement.allowBook | Indicates whether the forward can be booked. Possible values = [true, false]. |
| content.forwardAgreement. forwardMasterAgreementWarning | Internal use only. |
| content.maxDays | The maximum number of days allowed between the start date and maturity. |
| content.forwardMaxOpenContractInterval | The maximum number of days that the forward can be open. |
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. \nThere are two types of forward agreements: Closed Forwards and Open Forwards.
\nThe following identifiers are created for each completed forward:
\nThis 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'.
\n| Parameter | Description |
|---|---|
| content.data.rows.forwardId | An ID assigned to the forward when it was booked. |
| content.data.rows.currency | The currency that you purchased. |
| content.data.rows.deal | The deal number of the completed forward. Note: Incomplete forwards do not have a deal number. |
| content.data.rows.ordNum | The system assigned deal number. |
| content.data.rows.statusDesc | Indicates whether the forward can be drawn down.
|
| content.data.rows.status | The status indicates whether the forward can be drawn down.
|
| content.data.rows.dealDate | The date you booked the forward. |
| content.data.rows.openFrom | The first date that you can start drawing down against the booked forward. |
| content.data.rows.maturityDate | For open forwards, this is the last date when you draw down funds. For closed forwards, this is the date when the funds become available for use. |
| content.data.rows.availableBalance | This is the amount of the forward that is available to use. If you have already drawn down funds against this forward, this is the remaining balance. |
| content.data.rows.rate | The rate of exchange at which the forward was booked. |
| content.data.rows.costCurrency | The currency with which the forward was settled. |
| content.data.rows.costAmount | The amount that was required to settle the forward. |
| content.data.rows.createdBy | The name of the person who created the forward. |
| content.data.rows.amount | The amount of the forward. |
| content.data.rows.links | Returned only for Incomplete forwards. |
The ‘Book Drawdown’ payload is very similar to the POST Instruct Deal payload.
The fee amount must reflect the contractual fee set up for the client. If fees are contractually $0 for this drawdown, then set 'amount': 0. If otherwise, set the amount accordingly. This endpoint supports idempotency through the requestId parameter. If the request is repeated with the same idempotencyKey the endpoint will return the original booking result.
Note: Top-up of drawdown instruction amounts (when drawdown amount exceeds the value of the forward contract) is currently not supported on API.
\n| Parameter | Description |
|---|---|
requestId | string (optional) Client-generated unique idempotency key for the request |
orders.orderId | string (required) The forward number (alphanumeric). |
orders.amount | number (required) The drawdown amount. |
payments.beneficiaryId | string (required) Identifier of the beneficiary (or MCA Balance) to whom the payment will be sent. Value can be either 'clientIntegrationId' or 'id' (which is returned by GET View Bene). |
payments.deliveryMethod | string (required)
|
payments.amount | number (required) The buy amount. |
payments.currency | string (required) Three-letter ISO code for the buy currency. |
payments.purposeOfPayment | string (required) The purpose of payment. Can be found here: GET Purpose of Payment |
payments.paymentReference | string (optional) Reference to be included with the payment, for example, purchase order number or invoice number. |
payments.fee.expectation | string (required) If you know the exact amount of the fee, set to 'ExactFee' and enter the fee amount in the 'payments.fee.amount' field. If you do not know the fee amount, set to 'AnyFee'. |
payments.fee.amount | number (required) The fee amount, paid in the 'payments.fee.currency'. If you do not know the fee amount, enter '0' and set 'payments.fee.expectation' to 'AnyFee'. |
payments.fee.currency | string (optional) Three-letter ISO code of the fee currency. |
payments.remitterId | string (optional) Identifier of the remitter on whose behalf the payment is being made. |
settlements.accountId | string (required) The account identifier of the settlement account template. |
settlements.deliveryMethod | string (required)
|
settlements.currency | string (required) Three-letter ISO code for the settlement account currency. |
settlements.purpose | string (required) Purpose should be 'All' or 'Drawdown'. |
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.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"859d5d80-1286-4dab-a082-c972dc36641b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9cb11cec-ce17-4336-aa5c-3c902ece5803"}}],"_postman_id":"24853d81-0058-4b3e-81a8-44e7aff1bb7e"}],"id":"39107577-4beb-4941-a154-89f10cde8628","description":"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.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dff41c17-2ade-4440-b893-aa1371dcc5b2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"0595a44e-1fbb-424e-aa49-cf3ac12f43ac"}}],"_postman_id":"39107577-4beb-4941-a154-89f10cde8628"},{"name":"Cancel Order","item":[{"name":"Request Cancellation","id":"d3265839-363d-4606-9f87-f316089522ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"body":{"mode":"formdata","formdata":[]},"url":"/api/{clientCode}/0/orders/{orderNumber}/request-cancellation","description":"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 identify the currencies and amounts of the order you want to cancel. Unlike POST Spot Rate, 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.
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:
\nThere is at least one payment instruction in the deal with a remitter whose classification is 'Individual'.
\nThe payment is cancelled within 30 minutes of it being booked or instructed.
\n| Parameter | Description |
|---|---|
content.trades.originalTrade.buyAmount | Amount of the buy-side currency. |
content.trades.originalTrade.buyCurrency | ISO currency code of the buy-side currency. |
content.trades.originalTrade.costAmount | Amount of the sell-side currency. |
content.trades.originalTrade.costCurrency | ISO currency code of the sell-side currency. |
content.trades.charge.amount | The amount that is charged for carrying out the cancellation transaction (if applicable). |
content.trades.charge.currency | The currency of the charge levied on the cancellation. The currency is the settlement currency. Amount of the sell-side currency. |
content.trades.cancelRate.value | The value of the cancellation rate. |
content.trades.cancelRate.rateType | The currency pair used in the rate calculation. Note: The second currency in the pair is the more major of the two in Corpay's internal ranking. |
The link for Book Cancellation is provided in the response body of the POST Request Cancellation. If this endpoint is successful, an order number is granted.
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 auto-retrieved (such as amounts and currencies).
\nOrders created via Spot and Forward workflows can be cancelled.
\nJust as the POST Spot Rate and POST Book Deal 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.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8729237e-b458-4bd5-87a7-8166ae541d08"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f8be090d-f888-449d-95f9-0a7707160637"}}],"_postman_id":"cee9907d-8581-4d6a-b5f4-d8f63c2cbbb0"},{"name":"Settlement Accounts","item":[{"name":"Manage Multi-Currency Accounts Nickname","item":[{"name":"Assign/Edit Multi-Currency Account Nickname","id":"2cf70ee8-e496-4340-9907-7584c0f979a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"nickname\": \"Nickname\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/api/{clientCode}/0/multi-currency-accounts-nicknames/{glNumber}","description":"This endpoint enables you to assign or update the nickname for a Multi-Currency Account. The glNumber in the request refers to the account number, which can be retrieved from the View Multi-Currency Accounts endpoint response.
| Parameter | Description |
|---|---|
nickname | string (required) Nickname to be assigned to your MCA. Maximum 50 characters. Standard regex validation will apply - only letters, numbers, spaces, hyphens, and underscores are allowed. |
This endpoint retrieves the account name details and nickname for the account (if any). The glNumber in the request refers to the account number, which can be retrieved from the View Multi-Currency Accounts endpoint response.
| Parameter | Description |
|---|---|
content.account.nickname | Nickname assigned to the Multi-Currency Account. |
content.account.lastUpdated | The last date and time at which the nickname was updated. |
content.account.curr | Three-letter ISO currency code for the Multi-Currency Account. |
content.rules.maxLength | Max character limit allowed for Multi-Currency Account nickname. |
content.rules.regexPattern | Standard regex validations for account nickname. |
This endpoint resets the account nickname to the original name, removing any previously assigned nickname. The glNumber in the request refers to the account number, which can be retrieved from the View Multi-Currency Accounts endpoint response.
| Parameter | Description |
|---|---|
content.account.curr | Three-letter ISO currency code for the Multi-Currency Account. |
content.rules.maxLength | Max character limit allowed for Multi-Currency Account nickname. |
content.rules.regexPattern | Standard regex validations for account nickname. |
The endpoints in this section are used to manage Multi-Currency Account nickname.
\n","_postman_id":"73b38620-f421-458a-985d-c69252a9e36b"},{"name":"View Template","id":"88d961df-6332-4adc-8bd4-86a34212e0db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":"/api/{clientCode}/0/settlement-accounts","description":"This endpoint enables you to view all settlement accounts for this client.
\n","urlObject":{"path":["api","{clientCode}","0","settlement-accounts"],"query":[],"variable":[]}},"response":[{"id":"a7120ff3-eb45-4908-8669-b06dcc722383","name":"200 View Templates","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":"https://crossborder.corpay.com/api/{clientCode}/0/settlement-accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*","description":"","enabled":true},{"key":"cache-control","value":"no-cache","description":"","enabled":true},{"key":"cmg-accesstoken","value":"{Client-level \"access_code\"}","description":"","enabled":true},{"key":"content-length","value":"2398","description":"","enabled":true},{"key":"content-type","value":"application/json; charset=utf-8","description":"","enabled":true},{"key":"date","value":"Mon, 02 Oct 2017 15:27:29 GMT","description":"","enabled":true},{"key":"expires","value":"-1","description":"","enabled":true},{"key":"pragma","value":"no-cache","description":"","enabled":true},{"key":"server","value":"Microsoft-IIS/7.5","description":"","enabled":true},{"key":"x-aspnet-version","value":"4.0.30319","description":"","enabled":true},{"key":"x-powered-by","value":"ASP.NET","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"beta.cambridgelink.com","path":"/","secure":true,"session":true,"value":"9F58B5872C9B5B6ED7D411CC5F8A033456302CB49B0F0D3FA4C5D0E8E511A17305F906B2E532D6CDDD5D185832EC692BB8DA7F51F8E07F15C6DB04AF69561D16AA9856C9E836BCB94181448075EEDF15C1735000E7545781A7813FCBB9E8F501490B655621974DB8CCC1B9434B16E04F7B7195111200B3188D726CEBBD4C4E01C6F14048C03516D4B904F01049459CF6D624BD83CC925FED8C04C7FDF6C8ABACC4FE69F2A1DE4551ADC6487C99979F17","key":"CMG-AccessToken"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"beta.cambridgelink.com","path":"/","secure":true,"session":true,"value":"en","key":"CMG-Language"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"beta.cambridgelink.com","path":"/","secure":true,"session":true,"value":"87EA2F41C361A9DE2E90000FE1E2A4E42B5353D0D56871EF2AE9C21A9F92951125592C5CEBAC271D0449FDFB4B04148F23AD189B15D6257A8AA543CB8EC8E7B9F3F7B074EF8F9D8AF57B668C60B5C6C9409D30155BD12571F3B1677F24E741929CEE78641CFFE5A57B7280AC0D17BB06B6318C2A62F8753FEEB5750AAA536D0AEC228BF14152619FF26643BC47F60594898D19F584B562D86A24BA5375770AB2","key":".ASPXAUTH"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"beta.cambridgelink.com","path":"/","secure":true,"session":true,"value":"[\"UPLOAD\"]","key":"CMG-XP"}],"responseTime":null,"body":"{\n\t\"content\": {\n\t\t\"items\": [\n\t\t\t{\n\t\t\t\t\"ordnum\": 0,\n\t\t\t\t\"text\": \"Multi-Currency Account\",\n\t\t\t\t\"children\": []\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"ordnum\": 1,\n\t\t\t\t\"text\": \"Bank Accounts\",\n\t\t\t\t\"children\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\": \"AINCOMING63778\",\n\t\t\t\t\t\t\"method\": {\n\t\t\t\t\t\t\t\"id\": \"W\",\n\t\t\t\t\t\t\t\"text\": \"Wire\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"currency\": \"USD\",\n\t\t\t\t\t\t\"text\": \"INCOMING63778\",\n\t\t\t\t\t\t\"paymentIdent\": \"INCOMING63778\",\n\t\t\t\t\t\t\"bankName\": \"HANG SENG BANK LIMITED\",\n\t\t\t\t\t\t\"bankAccount\": \" \",\n\t\t\t\t\t\t\"preferred\": true,\n\t\t\t\t\t\t\"selected\": true,\n\t\t\t\t\t\t\"isNamedAccount\": false,\n\t\t\t\t\t\t\"nickname\": null,\n\t\t\t\t\t\t\"links\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"rel\": \"SETTLEMENT_ACCOUNT_DETAILS\",\n\t\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/settlementAccount/INCOMING63778/W/USD?paymentProductType=Regular\",\n\t\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\": \"AINCOMING87301\",\n\t\t\t\t\t\t\"method\": {\n\t\t\t\t\t\t\t\"id\": \"W\",\n\t\t\t\t\t\t\t\"text\": \"Wire\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"currency\": \"USD\",\n\t\t\t\t\t\t\"text\": \"INCOMING87301\",\n\t\t\t\t\t\t\"paymentIdent\": \"INCOMING87301\",\n\t\t\t\t\t\t\"bankName\": \"PUBLIC BANK BERHAD\",\n\t\t\t\t\t\t\"bankAccount\": \" \",\n\t\t\t\t\t\t\"preferred\": true,\n\t\t\t\t\t\t\"selected\": false,\n\t\t\t\t\t\t\"isNamedAccount\": false,\n\t\t\t\t\t\t\"nickname\": null,\n\t\t\t\t\t\t\"links\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"rel\": \"SETTLEMENT_ACCOUNT_DETAILS\",\n\t\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/settlementAccount/INCOMING87301/W/USD?paymentProductType=Regular\",\n\t\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\": \"AINCOMING87830\",\n\t\t\t\t\t\t\"method\": {\n\t\t\t\t\t\t\t\"id\": \"W\",\n\t\t\t\t\t\t\t\"text\": \"Wire\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"currency\": \"EUR\",\n\t\t\t\t\t\t\"text\": \"INCOMING87830\",\n\t\t\t\t\t\t\"paymentIdent\": \"INCOMING87830\",\n\t\t\t\t\t\t\"bankName\": \"HONG LEONG BANK BERHAD\",\n\t\t\t\t\t\t\"bankAccount\": \" \",\n\t\t\t\t\t\t\"preferred\": false,\n\t\t\t\t\t\t\"selected\": false,\n\t\t\t\t\t\t\"isNamedAccount\": false,\n\t\t\t\t\t\t\"nickname\": null,\n\t\t\t\t\t\t\"links\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"rel\": \"SETTLEMENT_ACCOUNT_DETAILS\",\n\t\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/settlementAccount/INCOMING87830/W/EUR?paymentProductType=Regular\",\n\t\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\": \"AINCOMING88155\",\n\t\t\t\t\t\t\"method\": {\n\t\t\t\t\t\t\t\"id\": \"W\",\n\t\t\t\t\t\t\t\"text\": \"Wire\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"currency\": \"USD\",\n\t\t\t\t\t\t\"text\": \"INCOMING88155\",\n\t\t\t\t\t\t\"paymentIdent\": \"INCOMING88155\",\n\t\t\t\t\t\t\"bankName\": \" \",\n\t\t\t\t\t\t\"bankAccount\": \" \",\n\t\t\t\t\t\t\"preferred\": false,\n\t\t\t\t\t\t\"selected\": false,\n\t\t\t\t\t\t\"isNamedAccount\": false,\n\t\t\t\t\t\t\"nickname\": null,\n\t\t\t\t\t\t\"links\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"rel\": \"SETTLEMENT_ACCOUNT_DETAILS\",\n\t\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/settlementAccount/INCOMING88155/W/USD?paymentProductType=Regular\",\n\t\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\": \"AINCOMING88284\",\n\t\t\t\t\t\t\"method\": {\n\t\t\t\t\t\t\t\"id\": \"W\",\n\t\t\t\t\t\t\t\"text\": \"Wire\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"currency\": \"USD\",\n\t\t\t\t\t\t\"text\": \"INCOMING88284\",\n\t\t\t\t\t\t\"paymentIdent\": \"INCOMING88284\",\n\t\t\t\t\t\t\"bankName\": \"BANK OF AMERICA, N.A.\",\n\t\t\t\t\t\t\"bankAccount\": \" \",\n\t\t\t\t\t\t\"preferred\": false,\n\t\t\t\t\t\t\"selected\": false,\n\t\t\t\t\t\t\"isNamedAccount\": false,\n\t\t\t\t\t\t\"nickname\": null,\n\t\t\t\t\t\t\"links\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"rel\": \"SETTLEMENT_ACCOUNT_DETAILS\",\n\t\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/settlementAccount/INCOMING88284/W/USD?paymentProductType=Regular\",\n\t\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\": \"AINCOMING88658\",\n\t\t\t\t\t\t\"method\": {\n\t\t\t\t\t\t\t\"id\": \"W\",\n\t\t\t\t\t\t\t\"text\": \"Wire\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"currency\": \"EUR\",\n\t\t\t\t\t\t\"text\": \"INCOMING88658\",\n\t\t\t\t\t\t\"paymentIdent\": \"INCOMING88658\",\n\t\t\t\t\t\t\"bankName\": \"HONG LEONG BANK BERHAD\",\n\t\t\t\t\t\t\"bankAccount\": \" \",\n\t\t\t\t\t\t\"preferred\": false,\n\t\t\t\t\t\t\"selected\": false,\n\t\t\t\t\t\t\"isNamedAccount\": false,\n\t\t\t\t\t\t\"nickname\": null,\n\t\t\t\t\t\t\"links\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"rel\": \"SETTLEMENT_ACCOUNT_DETAILS\",\n\t\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/settlementAccount/INCOMING88658/W/EUR?paymentProductType=Regular\",\n\t\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t],\n\t\t\"allowWireSettlement\": true\n\t},\n\t\"errors\": [],\n\t\"links\": [\n\t\t{\n\t\t\t\"rel\": \"self\",\n\t\t\t\"uri\": \"https://crossborder.corpay.com/api/{clientCode}/0/settlement-accounts\",\n\t\t\t\"method\": \"GET\"\n\t\t}\n\t]\n}"}],"_postman_id":"88d961df-6332-4adc-8bd4-86a34212e0db"},{"name":"View Multi-Currency Accounts","id":"90f9ac56-cb5a-4408-b472-66247d550c9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":"/api/{clientCode}/0/payment-link-balance-accounts?searchString={search string; optional}&includeBalance={'true' or 'false'}&curr={Three-letter ISO currency code;optional}&showOnlyActive={'true' or 'false';optional}","description":"This call returns a list of the Corpay Multi-Currency Accounts (previously called FXBalance) for this client. Multi-Currency Accounts are internal holding balances for currency-specific deposits. They are an alternative settlement option.
\nNote: Multi-Currency Accounts cannot be created via API. They are created using a back-office procedure.
\n| Parameter | Description |
|---|---|
content.data.rows.description | The type of Multi-Currency Account. Standard - Account(s) held at Corpay for the client (previously called FXBalance). Named - Account(s) held at Corpay in a client’s business name. |
content.data.rows.account | Name of the Multi-Currency Account. |
content.data.rows.nickname | The nickname assigned by client to the Multi-Currency Account |
content.data.rows.currency | Three-letter ISO currency code. |
content.data.rows.ledgerBalance | The amount that was in the Multi-Currency Account at the end of the previous business day. |
content.data.rows.balanceHeld | The amount in the Multi-Currency Account that is allocated to cover payments that have been scheduled but are still incomplete or outstanding. |
content.data.rows.availableBalance | The amount that is available to use. Ledger Balance value minus Balance Held value. |
content.data.rows.accountNumber | Multi-Currency Account number. |
content.data.rows.isNamedAccount | Identifies if the account is Named Account(true) or not(false). |
content.data.rows.isActive | Identifies if the account is Active (true) or Deactivated (false). |
content.data.rows.deactivationDate | Returns deactivation date if account is deactivated; if active, returns null. |
content.data.rows.settlementInstructions | Client's Settlement Instruction details. Account number, Currency details, routing information, beneficiary details, bank name, bank address, and BIC. Note: The SSIs for Standard account will have Corpay (or a Corpay entity) as the Account Holder or Beneficiary. The Multi-Currency IBAN Named Accounts will display your business’s name as the Account Holder or Beneficiary. If account is deactivated, returns only incoming account number. |
content.data.rows.clientCode | Identifies the client in a client/division hierarchy. |
content.data.rows.clientDivisionId | Identifies the division in a client/division hierarchy. |
content.data.rows.links | HATEOAS links to the Corpay Cross-Border Account Details page. |
content.data.items.id | Multi-Currency Account number. |
content.data.items.text | Multi-Currency Account number. |
content.data.items.curr | Three-letter ISO currency code. |
content.data.items.currText | Currency code and currency name. |
content.data.items.account | Name of the Multi-Currency Account. |
content.data.items.ledgerBalance | The amount that was in the Multi-Currency Account at the end of the previous business day. |
content.data.items.balanceHeld | The amount in the Multi-Currency Account that is allocated to cover payments that have been scheduled but are still incomplete or outstanding. |
content.data.items.availableBalance | The amount that is available to use. Ledger Balance value minus Balance Held value. |
content.data.items.allowedPayment | The amount that is available to use. |
content.data.items.client | Identifies the client in a client/division hierarchy. |
content.data.items.branchld | Identifies the division in a client/division hierarchy. |
content.data.items.accountName | Name of the Multi-Currency Account. |
content.data.items.links | HATEOAS links to the Corpay Cross-Border Account Details page. |
content.data.clientInformation.clientCode | Identifies the client in a client/division hierarchy. |
content.data.clientInformation.clientName | Account holder name. |
content.data.clientInformation.addr1 | First line of account holder address. |
content.data.clientInformation.addr2 | Second line of account holder address. |
content.data.clientInformation.city | The account holder's city. |
content.data.clientInformation.province | The account holders province or state. |
content.data.clientInformation.country | The account holder's country. |
content.data.clientInformation.postCode | The account holder's postal code. |
content.data.clientInformation.telephone | The account holder's contact number. |
content.data.clientInformation.logo | The account holder's business logo. |
content.data.clientInformation.division | Identifies the division in a client/division hierarchy. |
Display 'ledgerBalance', 'balanceHeld', and 'availableBalance' values; optional
\n","type":"text/plain"},"key":"includeBalance","value":"{'true' or 'false'}"},{"key":"curr","value":"{Three-letter ISO currency code;optional}"},{"key":"showOnlyActive","value":"{'true' or 'false';optional}"}],"variable":[]}},"response":[{"id":"e76f0472-ec64-4680-862a-afc44425a567","name":"200 Multi-Currency Accounts","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":{"raw":"https://crossborder.corpay.com/api/{clientCode}/0/payment-link-balance-accounts?includeBalance=true&showOnlyActive=false","protocol":"https","host":["crossborder","corpay","com"],"path":["api","{clientCode}","0","payment-link-balance-accounts"],"query":[{"key":"includeBalance","value":"true"},{"key":"showOnlyActive","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n\t\"content\": {\n\t\t\"data\": {\n\t\t\t\"rows\": [\n\t\t\t\t{\n\t\t\t\t\t\"description\": \"Standard\",\n\t\t\t\t\t\"account\": \"B16890\",\n\t\t\t\t\t\"nickname\": null,\n\t\t\t\t\t\"currency\": \"DKK\",\n\t\t\t\t\t\"ledgerBalance\": 0.0,\n\t\t\t\t\t\"balanceHeld\": 0.0,\n\t\t\t\t\t\"availableBalance\": 0.0,\n\t\t\t\t\t\"accountNumber\": \"610216890006031023\",\n\t\t\t\t\t\"isNamedAccount\": false,\n\t\t\t\t\t\"isActive\": false,\n\t\t\t\t\t\"deactivationDate\": \"2025-09-08T15:29:07.68\",\n\t\t\t\t\t\"settlementInstructions\": {\n\t\t\t\t\t\t\"incomingAccountNumber\": \"GB36 BARC 2000 0087 1727 44\"\n\t\t\t\t\t},\n\t\t\t\t\t\"clientCode\": 216890,\n\t\t\t\t\t\"clientDivisionId\": 0,\n\t\t\t\t\t\"links\": [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"rel\": \"ACCOUNT_STATEMENT\",\n\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/216890/0/multi-currency-accounts/610216890006031023\",\n\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"rel\": \"MAKE_PAYMENT\",\n\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/216890/0/payment-completion-process/29936a59-671c-415c-98ff-b0ae473add2a?product=Settlement&renderTab=1&paymentProductType=Regular&accountNumber=610216890006031023\",\n\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"rel\": \"LINK_BALANCE_DETAILS\",\n\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/216890/0/link-balance-accounts/610216890006031023\",\n\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"rel\": \"LINK_BALANCE_PENDING_BALANCE\",\n\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/216890/0/link-balance-accounts/610216890006031023/pending-balance\",\n\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"rel\": \"LINK_BALANCE_ACTIVITY\",\n\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/216890/0/link-balance-accounts/610216890006031023/history?includeDetails=True\",\n\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"rel\": \"LINK_ACCOUNT_NICKNAME_SET\",\n\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/216890/0/multi-currency-accounts-nicknames/610216890006031023\",\n\t\t\t\t\t\t\t\"method\": \"POST\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"rel\": \"ENABLE_ACCOUNT\",\n\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/216890/0/accounts\",\n\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"rel\": \"LINK_ACCOUNT_NICKNAME\",\n\t\t\t\t\t\t\t\"uri\": \"https://crossborder.corpay.com/api/216890/0/multi-currency-accounts-nicknames/610216890006031023\",\n\t\t\t\t\t\t\t\"method\": \"GET\"\n\t\t\t\t\t\t}\n\t\t\t\t\t]\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"description\": \"Named\",\n\t\t\t\t\t\"account\": \"S&JSAL\",\n\t\t\t\t\t\"nickname\": \"Named Operating Acc USD\",\n\t\t\t\t\t\"currency\": \"USD\",\n\t\t\t\t\t\"ledgerBalance\": -188.13,\n\t\t\t\t\t\"balanceHeld\": 0,\n\t\t\t\t\t\"availableBalance\": -188.13,\n\t\t\t\t\t\"accountNumber\": \"610216890000031002\",\n\t\t\t\t\t\"isNamedAccount\": true,\n\t\t\t\t\t\"isActive\": true,\n\t\t\t\t\t\"deactivationDate\": null,\n\t\t\t\t\t\"settlementInstructions\": {\n\t\t\t\t\t\t\"isNAAssociated\": true,\n\t\t\t\t\t\t\"incomingAccountNumber\": \"43333333333330\",\n\t\t\t\t\t\t\"curr\": \"USD\",\n\t\t\t\t\t\t\"currName\": \"US Dollar\",\n\t\t\t\t\t\t\"isIBAN\": false,\n\t\t\t\t\t\t\"beneInfo\": \"S&J Sales LimitedThis call returns the transaction history of the specified Corpay Multi-Currency Account (previously called FXBalance).
\n| Parameter | Description |
|---|---|
content.data.pagination.total | Total number of transactions related to the specified Multi-Currency Account during the specified period. |
content.data.pagination.skip | Number of transactions skipped |
content.data.pagination.take | Number of transactions returned |
content.data.links | HATEOAS link to the Corpay Cross-Border Account Details page |
content.data.rows.orderNumber | The deal number. |
content.data.rows.date | Transaction date. |
content.data.rows.amount | Amount deducted from the Multi-Currency Account. Note: This field is returned if includeDetails=false |
content.data.rows.debitAmount | Amount debited from the Multi-Currency Account. Note: This field is returned if includeDetails=true |
content.data.rows.creditAmount | Amount credited to Multi-Currency Account. Note: This field is returned if includeDetails=true |
content.data.rows.isPosted | Specifies whether the record has been posted.
|
content.data.rows.balance | Amount remaining in the Multi-Currency Account. |
content.data.rows.links | HATEOAS link to the order. |
content.balance.rows.date | Business date(s) during the specified period. |
content.balance.rows.balance | Multi-Currency Account value at the end of the above date. |
content.data.rows.details.transID | Transaction identifier |
content.data.rows.details.orderNumber | Deal number |
content.data.rows.details.identifier | Multi-Currency Account identifier or Beneficiary identifier |
content.data.rows.details.name | Multi-Currency Account name or Beneficiary name |
content.data.rows.details.currency | Currency of the transaction |
content.data.rows.details.amount | Amount of the debit or credit |
content.data.rows.details.date | Transaction date |
content.data.rows.balance | Amount remaining in the Multi-Currency Account |
content.clientInformation | Identifies the account holder details |
content.isActive | Identifies if the account is Active (true) or Deactivated (false) |
Displays funds distribution data
\n","type":"text/plain"},"key":"includeDetails","value":"{'true' or 'false'; optional}"}],"variable":[]}},"response":[{"id":"53340e48-5d15-4ecd-a201-6d725388a171","name":"200 Multi-Currency Accounts History","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}","type":"text"}],"url":{"raw":"https://crossborder.corpay.com/api/{clientCode}/0/link-balance-accounts/61023242501011011/history?fromDate=2022-06-23&toDate=2022-06-24&skip=0&take=3&sort=&includeDetails=true","protocol":"https","host":["crossborder","corpay","com"],"path":["api","{clientCode}","0","link-balance-accounts","61023242501011011","history"],"query":[{"key":"fromDate","value":"2022-06-23"},{"key":"toDate","value":"2022-06-24"},{"key":"skip","value":"0"},{"key":"take","value":"3"},{"key":"sort","value":""},{"key":"includeDetails","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-origin","value":"*","description":"","enabled":true,"type":"text"},{"key":"cache-control","value":"no-cache","description":"","enabled":true,"type":"text"},{"key":"cmg-accesstoken","value":"{access_code}","description":"","enabled":true,"type":"text"},{"key":"content-length","value":"514","description":"","enabled":true,"type":"text"},{"key":"content-type","value":"application/json; charset=utf-8","description":"","enabled":true,"type":"text"},{"key":"date","value":"Mon, 24 Feb 2020 11:02:48 GMT","description":"","enabled":true,"type":"text"},{"key":"expires","value":"-1","description":"","enabled":true,"type":"text"},{"key":"pragma","value":"no-cache","description":"","enabled":true,"type":"text"},{"key":"server","value":"Microsoft-IIS/7.5","description":"","enabled":true,"type":"text"},{"key":"x-aspnet-version","value":"4.0.30319","description":"","enabled":true,"type":"text"},{"key":"","value":"x-powered-by","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"data\": {\n \"pagination\": {\n \"total\": 13,\n \"skip\": 0,\n \"take\": 2\n },\n \"links\": [\n {\n \"rel\": \"DATA\",\n \"uri\": \"https://crossborder.corpay.com/api/216890/0/link-balance-accounts/610216890000031002/history?skip=0&take=2&sort=&includeDetails=True\",\n \"method\": \"GET\"\n }\n ],\n \"sorting\": [],\n \"rows\": [\n {\n \"orderNumber\": \"33957880\",\n \"date\": \"2025-09-09\",\n \"amount\": -777.0000,\n \"debitAmount\": -777.0000,\n \"creditAmount\": 0,\n \"isPosted\": true,\n \"balance\": \"288.1300\",\n \"details\": [\n {\n \"transID\": 189268698,\n \"orderNumber\": \"33957880\",\n \"identifier\": \"2515_CHS_USD2\",\n \"name\": \"2515_CHS_USD2\",\n \"currency\": \"USD\",\n \"amount\": 777.0000,\n \"date\": \"2025-07-28\"\n },\n {\n \"transID\": 189689732,\n \"orderNumber\": \"33957880\",\n \"identifier\": \"610216890000031002\",\n \"name\": \"S&JSAL\",\n \"currency\": \"USD\",\n \"amount\": -777.0000,\n \"date\": \"2025-09-09\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"ORDER_DETAILS\",\n \"uri\": \"https://crossborder.corpay.com/api/216890/0/orders/33957880\",\n \"method\": \"GET\"\n }\n ]\n },\n {\n \"orderNumber\": \"33986185\",\n \"date\": \"2025-09-09\",\n \"amount\": -134.8700,\n \"debitAmount\": -134.8700,\n \"creditAmount\": 0,\n \"isPosted\": true,\n \"balance\": \"1065.1300\",\n \"details\": [\n {\n \"transID\": 189402423,\n \"orderNumber\": \"33986185\",\n \"identifier\": \"610216890000031004\",\n \"name\": \"S&JSAL\",\n \"currency\": \"GBP\",\n \"amount\": 100.0000,\n \"date\": \"2025-09-09\"\n },\n {\n \"transID\": 189689733,\n \"orderNumber\": \"33986185\",\n \"identifier\": \"610216890000031002\",\n \"name\": \"S&JSAL\",\n \"currency\": \"USD\",\n \"amount\": -134.8700,\n \"date\": \"2025-09-09\"\n }\n ],\n \"links\": [\n {\n \"rel\": \"ORDER_DETAILS\",\n \"uri\": \"https://crossborder.corpay.com/api/216890/0/orders/33986185\",\n \"method\": \"GET\"\n }\n ]\n }\n ]\n },\n \"balance\": {\n \"rows\": [\n {\n \"date\": \"2025-09-09T00:00:00\",\n \"balance\": 188.1300\n }\n ]\n },\n \"allowCliabHistoryDetails\": true,\n \"clientInformation\": {\n \"clientCode\": 216890,\n \"clientName\": \"S&J Sales Limited\",\n \"addr1\": \"216890 Addr1 Client St\",\n \"addr2\": \"216890 Addr2 Client St\",\n \"city\": \"London\",\n \"province\": \"London\",\n \"country\": \"United Kingdom\",\n \"postCode\": \"12345\",\n \"telephone\": \"416111111\",\n \"logo\": null,\n \"division\": \"UK\"\n },\n \"cmcAddress\": {\n \"clientName\": \"Cambridge Mercantile Corp. (UK) LimitedThis call returns details about incoming funds received by a Multi-Currency Account, including funds directed to any downstream client Multi-Currency Accounts.
\n| Parameter | Description |
|---|---|
ordNum |
| Parameter | Description |
|---|---|
content.data.date | Transaction date. |
content.data.dealNumber | The deal number. |
content.data.accountNumber | Multi-Currency Account number. |
content.data.currency | The three-letter ISO code for the transaction currency. |
content.data.amount | Transaction Amount. |
content.data.remitterName | The remitter name. |
content.data.paymentType | The payment rail used for the transaction. |
content.data.remitterAddressDetails | Remitter address details. |
content.data.remitterAccountDetails | Remitter bank account details. |
content.data.reference | Message Reference Details. |
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 Accounts) or Corpay holding account templates are not created in this same way.
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.
\nSimilar to the POST Create/Edit Bene 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 as it has very low chance of collision, your own hash, or some deterministic prefix in order to make sure it is unique.
Note:
\nThe only characters allowed in the 'uniqueRemitterId' are alphanumeric (a-zA-Z0-9), dash (-), and underscore (_).
\nRemitter identifiers longer than 34 characters are automatically truncated when processing the SWIFT MX message.
\n| Parameter | Description |
|---|---|
classification | string (required) Can be 'individual' or 'corporation'. |
name | string (required) The full name of the remitter. |
dateOfBirth | string (optional) The remitter's date of birth. Use the format yyyy-mm-dd. |
addressLine1 | string (required) The first line of the remitter's address. |
addressLine2 | string (optional) The second line of the remitter's address. |
city | string (required) The remitter's city. |
province | string (required for Canada or the United States) The remitter's province. |
countryISO2 | string (required) The remitter's two-letter ISO country code. |
postalCode | string (required for Canada or the United States) The remitter's postal code. |
emailAddress | string (optional) The remitter's email address. |
occupation | string (optional) The remitter's occupation. |
relationshipToYourCompany | string (optional) The remitter's relationship to your company. |
incorporationNumber | string (optional) The remitter's incorporation number. |
incorporationPlaceOfIssue | string (optional) The corporation's place of issue. |
incorporationType | string (optional) The type of corporation. |
incorporationInstitutionNumber | string (optional) The institution number for the corporation. |
bankName | string (optional) The remitter's bank name. |
bankCode | string (optional) The remitter's bank code. |
phoneHome | integer (optional) The remitter's home number. |
phoneBusiness | integer (optional) The remitter's business number. |
phoneFax | integer (optional) The remitter's fax number. |
accountNumber | string (optional) The remitter's bank account number. |
This call retrieves the details of a remitter.
\nNote: The URL is exactly the same as PUT Remitter Add/Edit, which creates or modifies a remitter, but this is a GET call rather than a PUT.
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.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e7618beb-4a36-4b11-950f-b544975b879b"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"399a0e4e-0fe3-47df-94ab-cebb8e8e79bd"}}],"_postman_id":"14987765-bc9b-454e-a4b3-84a50555e2ec"},{"name":"Mass Payments","item":[{"name":"Multiple Payments","id":"f270a6e2-a6c4-4e6a-973e-de5702fc5e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"body":{"mode":"raw","raw":"{\r\n \"payments\": [\r\n {\r\n \"beneficiaryId\": \"{clientIntegrationId}\",\r\n \"paymentMethod\": \"Wire\",\r\n \"amount\": 100,\r\n \"lockSide\": \"Settlement\",\r\n \"paymentCurrency\": \"EUR\",\r\n \"settlementCurrency\": \"CAD\",\r\n \"settlementAccountId\": \"{accountId}\",\r\n \"settlementMethod\": \"StoredValue\",\r\n \"paymentReference\": \"\",\r\n \"purposeOfPayment\": \"\",\r\n \"remitterId\": \"\",\r\n \"deliveryDate\": \"yyyy-mm-dd\",\r\n \"paymentId\":\"{internal paymentId}\"\r\n },\r\n {\r\n \"beneficiaryId\": \"{clientIntegrationId}\",\r\n \"paymentMethod\": \"Wire\",\r\n \"amount\": 100,\r\n \"lockSide\": \"Payment\",\r\n \"paymentCurrency\": \"GBP\",\r\n \"settlementCurrency\": \"USD\",\r\n \"settlementAccountId\": \"{accountId}\",\r\n \"settlementMethod\": \"EFT\",\r\n \"paymentReference\": \"\",\r\n \"purposeOfPayment\": \"\",\r\n \"remitterId\": \"\",\r\n \"deliveryDate\": \"yyyy-mm-dd\",\r\n \"paymentId\":\"{internal paymentId}\"\r\n }\r\n ]\r\n}"},"url":"/api/{clientCode}/0/quotes-payment","description":"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.
\nIn order to secure the rate(s), you must execute the next call, POST Book Multiple Payments, before the rate expires (usually 10 seconds).
| Parameter | Description |
|---|---|
payments.beneficiaryId | string (required) The identifier of the beneficiary or the FXBalance to which the payment will be sent. For beneficiaries, use either the beneIdentifier or the persistentId value, which can be found by using the GET View Bene endpoint. |
payments.paymentMethod | string (required) Method to use to send the payment = ['Wire', 'EFT', 'StoredValue']. 'StoredValue' = MCA Balance (Multi-Currency Accounts) |
payments.amount | number (required) Payment amount. |
payments.lockside | string (required) Indicates the base currency (of the currency pair), on which the rate calculation is based = ['payment', 'settlement']. |
payments.paymentCurrency | string (required) The three-letter ISO code for the payment currency. |
payments.settlementCurrency | string (required) The three-letter ISO code for the settlement currency. |
payments.settlementAccountId | string (required) Use the paymentIdent parameter (returned in the View Template response) to identify the settlement account.Note: Do not pass the account template id value.The request will fail with a permission error. |
payments.settlementMethod | string (required) Method to use to settle the deal = ['Wire', 'EFT', 'StoredValue']. 'StoredValue' = MCA Balance (Multi-Currency Accounts) |
payments.paymentReference | string (optional) Reference to be included with the payment. For example, purchase order number or invoice number. |
payments.purposeOfPayment | string (required) The purpose of payment. Can be found by using GET Purpose of Payment. |
payments.remitterId | string (required if payment is initiated by a third party) Remitter ID |
payments.deliveryDate | string (optional) The date the payment will be delivered to the beneficiary, formatted as yyyy-mm-dd. Note: The maximum delivery date is three months from the entry date. |
payments.paymentId | string (optional) The unique internal payment identifier that clients can assign to a payment transaction. |
| Parameter | Description |
|---|---|
content.paymentSummary.paymentCurrency | The three-letter ISO code for the payment currency. |
content.paymentSummary.amountTotal | Total amount paid to the beneficiary. |
content.paymentSummary.settlementCurrency | The three-letter ISO code for the settlement account currency. |
content.paymentSummary.settlementAmount | Amount being settled. |
content.paymentSummary.rate | The rate figure provided is the factor between the lockside and the quote currency. |
content.paymentSummary.count | The total number of payments going to the same beneficiary within this call. |
content.paymentSummary.lockSide | The currency on which the rate calculation is based = ['payment', 'settlement'] |
content.paymentSummary.rateType | The currency pair used in the rate calculation. Note: The second currency in the pair is the more major of the two in Corpay's internal ranking. |
content.fees.currency | 3-character ISO currency code |
content.fees.amount | Fee amount |
content.paymentTrackers.paymentId | The unique internal payment identifier that clients assign to a payment transaction. |
content.paymentTrackers.trackerId | The unique tracker identifier assigned to a payment transaction. |
This is the second of the two calls that are used to book multiple payments. The URL that you need to send can be found in the response to the preceding call (POST Multiple Payments) under 'BOOK_PAYMENT'.
Important: The quote obtained from POST Multiple Payments is valid for 10 seconds, after which it expires. If you don't book the deal before the rate expires, the response status will be '400 (Quote expired)'. If that happens, you will need to generate a new quote.
Note: The quoteKey, and loginSessionId params are contained in the URL, which is a unique feature of this workflow. This endpoint supports idempotency through the loginsessionId parameter. If the request is repeated with the same idempotencyKey the endpoint will not process the new data and book again.
| Parameter | Description |
|---|---|
combineSettlements | boolean (optional) Specifies whether to combine any associated fees into a single deduction. The default is 'false'. |
| Parameter | Description |
|---|---|
content.orderNumber | The unique global identifier for the order. |
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.
\nThe only limitation is the currency-specific account limit of any currency being used for settlement (as outlined in the onboarding agreement).
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2673a716-8a65-46d4-81c6-46d5076c23fe"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"34599845-9380-41f1-92a3-67cdae05c4ab"}}],"_postman_id":"c59395a5-8368-4e84-b52b-643127a3de08"},{"name":"Payment Tracking","item":[{"name":"Payment Channel Information","id":"f62908f3-7e7e-4e09-9e2e-02977e21a18d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CMG-AccessToken","value":"{insert Client-level \"access_code\"}"}],"url":"/api/{clientCode}/0/confirmation/payments/{paymentInstructionId}","description":"The confirmation endpoint displays a channel-specific payment confirmation message. To receive a successful response, the payment must be successfully instructed (status: 200 on POST Instruct Deal).
Rather than ordNum, this endpoint uses the paymentInstructionId in the URL. You can get the paymentInstructionId by using GET Lookup Orders.
Note:
\nMessages are provided in full only if the payment has exited the Corpay bank account and is en route to the beneficiary's bank account. Therefore, if the number of returned messages is 0, even though the payment has been booked, it just means the funds haven't left the Corpay bank account.
\nThe endpoint will return one or more MT103 or pacs 008 messages in the response field when the Method is set to W (Wire) and an MT103 or pacs 008 is found for the specified paymentInstructionId. If the Method is set to C (MCA Balance) or E (EFT), the response field will be blank. No other MTxxx messages will be returned.
| Parameter | Description |
|---|---|
content.paymentInstruction | The 'paymentInstructionId' used in the URL. |
content.messages.details.response | The contents of the MT103 or pacs**** message. For an explanation of the fields in the message, see the SWIFT MESSAGE FIELDS table below. |
content.messages.details.responseDate | The response date. |
content.messages.details.responseReference | The SWIFT confirmation ID from the channel. |
content.messages.channel | The channel used for the payment = {'SWIFT'}. |
content.messages.status | SWIFT Message Name Identification = {MT103 or pacs.008.001.08} |
| Field Number | Field Name | Description |
|---|---|---|
:20 | Transaction reference number | Message number assigned by the sender. |
:23B | Bank operation code | Type of operation. |
:32A | Value date, Currency, Interbank settled amount | Date format is YYMMDD. Currency is three-letter ISO code. |
:33B | Currency, Original ordered amount | Three-letter ISO currency code and amount of instruction. |
:50A, F, or K | Ordering customer (payer) or address of the remitter | Customer ordering the transaction. |
:52A or D | Ordering institution | Payer's bank. |
:53A, B, or D | Sender's correspondent (bank) | Account or branch of sender. |
:54A, B, or D | Receiver's correspondent | Branch or FI where funds are available to receiver. |
:56A, C, or D | Intermediary bank | FI through which transaction must pass. |
:59 or 59A | Beneficiary customer | Recipient of the funds. |
:57A, B, C, or D | Account with institution | Beneficiary's account. |
:70 | Remittance information | Information about the transaction. |
:71A | Details of charges. | Specifies which party is responsible for fees - OUR, SHA, or BEN. |
:72 | Sender to receiver information | Additional information for the receiver. |
:77B | Regulatory reporting | Regulatory information required by the sender or receiver country. |
This endpoint retrieves the tracker identifier of a specific payment by passing its paymentInstructionId. You can get the paymentInstructionId by using POST Instruct Deal or GET Lookup Orders .
| Parameter | Description |
|---|---|
content.trackerId | The unique tracker identifier assigned to a payment transaction. |
content.clientName | The client name |
content.sortedNetworkReferences | The reference assigned by SWIFT network when sending the payment |
content.events.uniqueId | The unique Id assigned to identify the payment event |
content.events.type | The information/status of the payment event at the source |
content.events.source | Identifies the payment event source |
content.events.processedTimestamp | Date and time at which the payment event was processed at source |
content.events.emittedTimestamp | Date and time at which the payment event was received at source |
content.events.fields.clientCode | The client code |
content.events.fields.transId | The unique transaction identifier for the payment event |
content.events.fields.itemKey | The unique record identifier for the payment. |
content.events.fields.method | The method used to send the payment WIRE EFT FXBalance |
content.events.fields.userKey | |
content.events.fields.createdTime | Date and time at which the payment event was created at source |
Note: If authenticating via the client-level access_code run this API request/api/{clientCode}/0/payment-tracking/{trackerId}
Trace the detailed information of a payment transaction by passing its trackerId . You can get the trackerId by using POST Instruct Deal or GET Lookup Orders or GET Payment Tracking Lookup.
| Parameter | Description |
|---|---|
content.trackerId | The unique tracker identifier assigned to a payment transaction. |
content.clientCode | The client code. |
content.clientName | The client name. |
content.uetr | The unique end to end transaction reference of a payment assigned by SWIFT. |
content.sortIndexes | Sorts the SWIFT events to help identify the event process order. |
content.events.uniqueId | The unique Id assigned to identify the payment event. |
content.events.type | The information/status of the payment event at the source. See CORPAY EVENT TYPE table for more details. |
content.events.source | Identifies the payment event source. |
content.events.processedTimestamp | Date and time at which the payment event was processed by Corpay. |
content.events.emittedTimestamp | Date and time at which the payment event was received/updated at source (same as content.events.fields.last_update_time). |
content.events.fields.clientCode | The client code. |
content.events.fields.uetr | The unique end-to-end transaction reference of a payment assigned by SWIFT. |
content.events.fields.createdTime | Date and time at which the payment event was created at source. |
content.events.fields.network_reference | Specifies the reference assigned by SWIFT network when sending the payment. |
content.events.fields.message_name_identification | The SWIFT message name identifier. See SWIFT MESSAGE NAME IDENTIFICATION table for more details. |
content.events.fields.business_service | The business service agreed between the sender and receiver under which rules this Business Message is exchanged. See SWIFT BUSINESS SERVICE table for more details. |
content.events.fields.tracker_event_type | Specifies the type of payment event. See SWIFT TRACKER EVENT TYPE table for more details. |
content.events.fields.valid | Indicates if a payment is valid (TRUE) or not (FALSE). |
content.events.fields.instruction_identification | Unique identification, as assigned by an instructing party for an instructed party, to identify the instruction. |
content.events.fields.transaction_status | The payment status in process. |
content.events.fields.transaction_status_reason | The reason for the status of a payment transaction. See SWIFT TRANSACTION STATUS CODE table for more details. |
content.events.fields.return | Indicates if a payment is a return (TRUE) or not (FALSE). |
content.events.fields.forwarded_to_agent | Specifies the BIC of the entity to which the entity reporting the status has forwarded the payment transaction. |
content.events.fields.settlement_method | Method used to settle the (batch of) payment instructions. See SWIFT SETTLEMENT METHOD table for more details. |
content.events.fields.clearing_system | Specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. |
content.events.fields.from | Business Code Identifier (BIC) of the sender party. |
content.events.fields.to | Business Code Identifier (BIC) of the receiver party. |
content.events.fields.originator | Business Code Identifier (BIC) of the party that issues the status. |
content.events.fields.serial_parties.debtor | Financial institution that owes an amount of money to the (final) financial institutional creditor. |
content.events.fields.serial_parties.creditor | Financial institution that receives an amount of money from the financial institutional debtor |
content.events.fields.serial_parties.creditor_agent | BIC of the financial institution servicing an account for the creditor. |
content.events.fields.serial_parties.debtor_agent | BIC of the financial institution servicing an account for the debtor. |
content.events.fields.serial_parties.creditor_account.identification | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. |
content.events.fields.serial_parties.instructing_reimbursement_agent | Agent through which the instructing agent identified in the \"From\" field) will reimburse the instructed agent (identified in the \"To\" field). |
content.events.fields.sender_acknowledgement_receipt | Date and time at which the sender was acknowledged receipt of the message. |
content.events.fields.received_date | Date and time at which the message was acknowledged by the receiver. |
content.events.fields.instructed_amount.currency | 3-character ISO currency code for money to be moved between the debtor (ordering customer) and creditor, as ordered by the initiating party. |
content.events.fields.instructed_amount.amount | The amount of money to be moved between the debtor (ordering customer) and creditor, before deduction of charges, as ordered by the initiating party. |
content.events.fields.interbank_settlement_amount.currency | 3-character ISO currency code for money moved between the instructing agent and the instructed agent. |
content.events.fields.interbank_settlement_amount.amount | The amount of money moved between the instructing agent and the instructed agent. |
content.events.fields.interbank_settlement_date | Specifies the date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due. |
content.events.fields.charge_bearer | Specifies which party/parties will bear the charges associated with the processing of the payment transaction. See SWIFT CHARGE BEARER table for more details. |
content.events.fields.charge_amount.currency | 3-character ISO currency code for charge amount money. |
content.events.fields.charge_amount.amount | See CHARGE AMOUNT CALCULATIONS for a payment event for more details. |
content.events.fields.funds_available | Specifies the date and time at which the funds are available. |
content.events.fields.confirmed_amount.currency | 3-character ISO currency code confirmed by the Originator. |
content.events.fields.confirmed_amount.amount | Specifies the amount confirmed by the Originator. Depending on the transaction status, this amount can be the credited amount, pending amount, rejected amount, or transferred amount. |
content.events.fields.update_payment | Contains the network reference of the payment for which the status confirmation was applicable. |
content.events.fields.last_update_time | The last date and time at which the status of this transaction was updated (same as content.events.emittedTimestamp). |
Note: Payment Tracking does not currently support exotic currencies. Please contact your account representative for more information.
\nCHARGE AMOUNT AT EACH CORRESPONDENT BANK IS CALCULATED AS:
\nA. First Event
\ncharge_amount = instructed_amount - interbank_settlement_amount
\nB. Corresponding Events
\ncharge_amount = interbank_settlement_amount/confirmed_amount (previous event) - interbank_settlement_amount/confirmed_amount (current event)
\nNOTE: interbank_settlement_amount and confirmed_amount are the amounts forwarded to the next correspondent bank or credited to the beneficiary.
\n| Field Name | Description |
|---|---|
PaymentAccepted | Payment accepted by Corpay |
PaymentCanceled | Payment canceled by Corpay |
UETRCreated | Payment sent to SWIFT |
PaymentProcessed | Payment acknowledged by SWIFT |
PaymentTrackingInfoReceived | GPI Event |
PaymentProcessedNonSwift | Payment acknowledged by non-SWIFT rail |
| Field Name | Name | Description |
|---|---|---|
CLRG | ClearingSystem | Settlement is done through a payment clearing system. |
COVE | CoverMethod | Settlement is done through a cover payment. |
INDA | InstructedAgent | Settlement is done by the agent instructed to execute a payment instruction. |
INGA | InstructingAgent | Settlement is done by the agent instructing and forwarding the payment to the next party in the payment chain. |
| Field Name | Name | Description |
|---|---|---|
COPT | CoverPayment | Indicates a cover payment. |
COSU | StatusUpdateCoverPayment | Indicates a cover payment status update. |
CTCA | CreditTransferPaymentCancellationRequest | Indicates a cancellation request related to a credit transfer payment. |
CTCR | CreditTransferPaymentCancellationResponse | Indicates a cancellation response related to a credit transfer payment. |
CTPT | CustomerCreditTransferPayment | Indicates a customer credit transfer payment. |
CTSU | StatusUpdateCustomerCreditTransferPayment | Indicates a customer credit transfer payment status update. |
CTTS | CreditTransferPaymentCancellationRequest-TrackingStatus | Indicates the tracking status of a cancellation request related to a credit transfer payment. |
FTPT | FinancialInstitutionCreditTransferPayment | Indicates a Financial Institution Credit Transfer Payment. |
FTSU | StatusUpdateFinancialInstitutionCredit-TransferPayment | Indicates a Financial Institution Credit Transfer Payment status update. |
| Field Name | Name | Description |
|---|---|---|
001 | gpiCustomerCreditTransferService | Indicates the gpi Customer Credit Transfer (CCT) service. |
002 | gpiStopAndRecallService | Indicates the gpi Stop and Recall (SRP) service. |
004 | gpiFinancialInstitutionCreditTransfer-InstantService | Indicates the gpi Financial Institution Credit Transfer service (FIT). |
005 | gpiCustomerCreditTransferInstantService | Indicates the gpi Customer Credit Transfer Instant service (CCT Instant). |
009 | gpiCustomerCreditTransferSimpleService | Indicates the gpi Customer Credit Transfer Simple Service. |
| Field Name | Name | Description |
|---|---|---|
ACCC | AcceptedCreditSettlementCompleted | Settlement on the creditor's account has been completed. |
ACSP | AcceptedSettlementInProcess | All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. |
RJCT | Rejected | Payment initiation or individual transaction included in the payment initiation has been rejected. |
| Field Name | Name | Description |
|---|---|---|
CRED | BorneByCreditor | All transaction charges are to be borne by the creditor. |
DEBT | BorneByDebtor | All transaction charges are to be borne by the debtor. |
SHAR | Shared | In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor. |
SWIFT MESSAGE NAME IDENTIFICATION
\n","urlObject":{"path":["api","payment-tracking","{trackerId}"],"query":[],"variable":[]}},"response":[{"id":"501aaa77-f5a1-4679-bab9-d06fbf92112e","name":"200 Payment Delivered","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/payment-tracking/{trackerId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"trackerId\": \"252726-5WQ4P7\",\n \"clientCode\": 252726,\n \"clientName\": \"Client\",\n \"uetr\": \"70357a7b-e0c5-426a-a12a-6a9d620b0df5\",\n \"sortIndexes\": [\n 0,\n 1,\n 7,\n 6,\n 5,\n 4,\n 3,\n 2,\n 8\n ],\n \"events\": [\n {\n \"uniqueId\": \"28018\",\n \"type\": \"UETR Created\",\n \"source\": \"CORPAY\",\n \"processedTimestamp\": \"2022-10-20T19:20:26.423Z\",\n \"emittedTimestamp\": \"2022-10-20T19:20:26.376Z\",\n \"fields\": {\n \"clientCode\": \"273675\",\n \"uetr\": \"70357a7b-e0c5-426a-a12a-6a9d620b0df5\",\n \"createdTime\": \"2022-10-20T19:20:26.376Z\"\n }\n },\n {\n \"uniqueId\": \"28019\",\n \"type\": \"PaymentProcessed\",\n \"source\": \"CORPAY\",\n \"processedTimestamp\": \"2022-10-20T19:20:44.552Z\",\n \"emittedTimestamp\": \"2022-10-20T19:20:42.136Z\",\n \"fields\": {\n \"uetr\": \"70357a7b-e0c5-426a-a12a-6a9d620b0df5\",\n \"clientCode\": \"273675\",\n \"createdTime\": \"2022-10-20T19:20:42.136Z\"\n }\n },\n {\n \"uniqueId\": \"28020\",\n \"type\": \"PaymentTrackingInfoReceived\",\n \"source\": \"SWIFT\",\n \"processedTimestamp\": \"2022-10-24T17:37:10.537Z\",\n \"emittedTimestamp\": \"2022-10-21T06:09:19.950Z\",\n \"fields\": {\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221021BNPAFRPPDXXX3720518716\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"3218252720\\\",\\\"transaction_status\\\":\\\"ACCC\\\",\\\"return\\\":false,\\\"funds_available\\\":\\\"2022-10-21T06:08:00Z\\\",\\\"from\\\":\\\"BNPAFRPPXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"BNPAFRPPXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-21T06:08:59Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"21450.\\\"},\\\"charge_amount\\\":[{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.00\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.00\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"}],\\\"update_payment\\\":\\\"20221021CITIGB2LEXXX4140992096\\\",\\\"last_update_time\\\":\\\"2022-10-21T06:09:19.95Z\\\"}\",\n \"network_reference\": \"20221021BNPAFRPPDXXX3720518716\",\n \"message_name_identification\": \"199\",\n \"business_service\": \"001\",\n \"tracker_event_type\": \"CTSU\",\n \"valid\": \"True\",\n \"instruction_identification\": \"3218252720\",\n \"transaction_status\": \"ACCC\",\n \"return\": \"False\",\n \"from\": \"BNPAFRPPXXX\",\n \"to\": \"TRCKCHZZXXX\",\n \"originator\": \"BNPAFRPPXXX\",\n \"sender_acknowledgement_receipt\": \"2022-10-21T06:08:59.000Z\",\n \"confirmed_amount.currency\": \"EUR\",\n \"confirmed_amount.amount\": \"21450.\",\n \"charge_amount[0].currency\": \"EUR\",\n \"charge_amount[0].amount\": \"0.\",\n \"charge_amount[1].currency\": \"EUR\",\n \"charge_amount[1].amount\": \"0.00\",\n \"charge_amount[2].currency\": \"EUR\",\n \"charge_amount[2].amount\": \"0.00\",\n \"charge_amount[3].currency\": \"EUR\",\n \"charge_amount[3].amount\": \"0.\",\n \"update_payment\": \"20221021CITIGB2LEXXX4140992096\",\n \"last_update_time\": \"2022-10-21T06:09:19.950Z\"\n }\n },\n {\n \"uniqueId\": \"28021\",\n \"type\": \"PaymentTrackingInfoReceived\",\n \"source\": \"SWIFT\",\n \"processedTimestamp\": \"2022-10-24T17:37:12.772Z\",\n \"emittedTimestamp\": \"2022-10-21T05:54:35.551Z\",\n \"fields\": {\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221021CITIGB2LEXXX4140992096\\\",\\\"message_name_identification\\\":\\\"103\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTPT\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"3218252720\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"settlement_method\\\":\\\"CLRG\\\",\\\"clearing_system\\\":\\\"EBA\\\",\\\"from\\\":\\\"CITIIE2XXXX\\\",\\\"to\\\":\\\"BNPAFRPPXXX\\\",\\\"originator\\\":\\\"CITIIE2XXXX\\\",\\\"serial_parties\\\":{\\\"creditor_agent\\\":\\\"BNPAFRPPXXX\\\",\\\"debtor_agent\\\":\\\"CITIIE2XXXX\\\"},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-21T05:54:09Z\\\",\\\"received_date\\\":\\\"2022-10-21T06:05:50Z\\\",\\\"instructed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"21450.\\\"},\\\"interbank_settlement_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"21450.\\\"},\\\"interbank_settlement_date\\\":\\\"2022-10-21\\\",\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.00\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.00\\\"}],\\\"copied_business_service\\\":\\\"EBA\\\",\\\"last_update_time\\\":\\\"2022-10-21T05:54:35.551Z\\\"}\",\n \"network_reference\": \"20221021CITIGB2LEXXX4140992096\",\n \"message_name_identification\": \"103\",\n \"business_service\": \"001\",\n \"tracker_event_type\": \"CTPT\",\n \"valid\": \"True\",\n \"instruction_identification\": \"3218252720\",\n \"transaction_status\": \"ACSP\",\n \"transaction_status_reason\": \"G000\",\n \"return\": \"False\",\n \"settlement_method\": \"CLRG\",\n \"clearing_system\": \"EBA\",\n \"from\": \"CITIIE2XXXX\",\n \"to\": \"BNPAFRPPXXX\",\n \"originator\": \"CITIIE2XXXX\",\n \"serial_parties.creditor_agent\": \"BNPAFRPPXXX\",\n \"serial_parties.debtor_agent\": \"CITIIE2XXXX\",\n \"sender_acknowledgement_receipt\": \"2022-10-21T05:54:09.000Z\",\n \"received_date\": \"2022-10-21T06:05:50.000Z\",\n \"instructed_amount.currency\": \"EUR\",\n \"instructed_amount.amount\": \"21450.\",\n \"interbank_settlement_amount.currency\": \"EUR\",\n \"interbank_settlement_amount.amount\": \"21450.\",\n \"interbank_settlement_date\": \"2022-10-21\",\n \"charge_bearer\": \"SHAR\",\n \"charge_amount[0].currency\": \"EUR\",\n \"charge_amount[0].amount\": \"0.\",\n \"charge_amount[1].currency\": \"EUR\",\n \"charge_amount[1].amount\": \"0.00\",\n \"charge_amount[2].currency\": \"EUR\",\n \"charge_amount[2].amount\": \"0.00\",\n \"copied_business_service\": \"EBA\",\n \"last_update_time\": \"2022-10-21T05:54:35.551Z\"\n }\n },\n {\n \"uniqueId\": \"28022\",\n \"type\": \"PaymentTrackingInfoReceived\",\n \"source\": \"SWIFT\",\n \"processedTimestamp\": \"2022-10-24T17:37:14.236Z\",\n \"emittedTimestamp\": \"2022-10-21T00:55:33.173Z\",\n \"fields\": {\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221021CITIGB2LNXXX1044920886\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"3202793737\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G002\\\",\\\"return\\\":false,\\\"from\\\":\\\"CITIIE2XXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"CITIIE2XXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-21T00:55:00Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"21450.\\\"},\\\"update_payment\\\":\\\"20221021CITIGB2LBXXX7657259642\\\",\\\"last_update_time\\\":\\\"2022-10-21T00:55:33.173Z\\\"}\",\n \"network_reference\": \"20221021CITIGB2LNXXX1044920886\",\n \"message_name_identification\": \"199\",\n \"business_service\": \"001\",\n \"tracker_event_type\": \"CTSU\",\n \"valid\": \"True\",\n \"instruction_identification\": \"3202793737\",\n \"transaction_status\": \"ACSP\",\n \"transaction_status_reason\": \"G002\",\n \"return\": \"False\",\n \"from\": \"CITIIE2XXXX\",\n \"to\": \"TRCKCHZZXXX\",\n \"originator\": \"CITIIE2XXXX\",\n \"sender_acknowledgement_receipt\": \"2022-10-21T00:55:00.000Z\",\n \"confirmed_amount.currency\": \"EUR\",\n \"confirmed_amount.amount\": \"21450.\",\n \"update_payment\": \"20221021CITIGB2LBXXX7657259642\",\n \"last_update_time\": \"2022-10-21T00:55:33.173Z\"\n }\n },\n {\n \"uniqueId\": \"28023\",\n \"type\": \"PaymentTrackingInfoReceived\",\n \"source\": \"SWIFT\",\n \"processedTimestamp\": \"2022-10-24T17:37:15.251Z\",\n \"emittedTimestamp\": \"2022-10-21T00:40:03.600Z\",\n \"fields\": {\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221021CITIGB2LBXXX7657259642\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"17681392-1\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"forwarded_to_agent\\\":\\\"CITIIE2XXXX\\\",\\\"settlement_method\\\":\\\"INGA\\\",\\\"from\\\":\\\"CITINL2XXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"CITINL2XXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-21T00:39:41Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"21450.\\\"},\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"}],\\\"update_payment\\\":\\\"20221020CMFXCATTAXXX4009347853\\\",\\\"last_update_time\\\":\\\"2022-10-21T00:40:03.6Z\\\"}\",\n \"network_reference\": \"20221021CITIGB2LBXXX7657259642\",\n \"message_name_identification\": \"199\",\n \"business_service\": \"001\",\n \"tracker_event_type\": \"CTSU\",\n \"valid\": \"True\",\n \"instruction_identification\": \"17681392-1\",\n \"transaction_status\": \"ACSP\",\n \"transaction_status_reason\": \"G000\",\n \"return\": \"False\",\n \"forwarded_to_agent\": \"CITIIE2XXXX\",\n \"settlement_method\": \"INGA\",\n \"from\": \"CITINL2XXXX\",\n \"to\": \"TRCKCHZZXXX\",\n \"originator\": \"CITINL2XXXX\",\n \"sender_acknowledgement_receipt\": \"2022-10-21T00:39:41.000Z\",\n \"confirmed_amount.currency\": \"EUR\",\n \"confirmed_amount.amount\": \"21450.\",\n \"charge_bearer\": \"SHAR\",\n \"charge_amount[0].currency\": \"EUR\",\n \"charge_amount[0].amount\": \"0.\",\n \"charge_amount[1].currency\": \"EUR\",\n \"charge_amount[1].amount\": \"0.\",\n \"update_payment\": \"20221020CMFXCATTAXXX4009347853\",\n \"last_update_time\": \"2022-10-21T00:40:03.600Z\"\n }\n },\n {\n \"uniqueId\": \"28024\",\n \"type\": \"PaymentTrackingInfoReceived\",\n \"source\": \"SWIFT\",\n \"processedTimestamp\": \"2022-10-24T17:37:15.941Z\",\n \"emittedTimestamp\": \"2022-10-20T19:24:49.210Z\",\n \"fields\": {\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221020CITIGB2LHXXX3164428972\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"17681392-1\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G002\\\",\\\"return\\\":false,\\\"from\\\":\\\"CITINL2XXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"CITINL2XXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-20T19:24:23Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"21450.\\\"},\\\"update_payment\\\":\\\"20221020CMFXCATTAXXX4009347853\\\",\\\"last_update_time\\\":\\\"2022-10-20T19:24:49.21Z\\\"}\",\n \"network_reference\": \"20221020CITIGB2LHXXX3164428972\",\n \"message_name_identification\": \"199\",\n \"business_service\": \"001\",\n \"tracker_event_type\": \"CTSU\",\n \"valid\": \"True\",\n \"instruction_identification\": \"17681392-1\",\n \"transaction_status\": \"ACSP\",\n \"transaction_status_reason\": \"G002\",\n \"return\": \"False\",\n \"from\": \"CITINL2XXXX\",\n \"to\": \"TRCKCHZZXXX\",\n \"originator\": \"CITINL2XXXX\",\n \"sender_acknowledgement_receipt\": \"2022-10-20T19:24:23.000Z\",\n \"confirmed_amount.currency\": \"EUR\",\n \"confirmed_amount.amount\": \"21450.\",\n \"update_payment\": \"20221020CMFXCATTAXXX4009347853\",\n \"last_update_time\": \"2022-10-20T19:24:49.210Z\"\n }\n },\n {\n \"uniqueId\": \"28025\",\n \"type\": \"PaymentTrackingInfoReceived\",\n \"source\": \"SWIFT\",\n \"processedTimestamp\": \"2022-10-24T17:37:16.613Z\",\n \"emittedTimestamp\": \"2022-10-20T19:21:02.460Z\",\n \"fields\": {\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221020CMFXCATTAXXX4009347853\\\",\\\"message_name_identification\\\":\\\"103\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTPT\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"17681392-1\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"settlement_method\\\":\\\"INDA\\\",\\\"from\\\":\\\"CMFXCAT0XXX\\\",\\\"to\\\":\\\"CITINL2XXXX\\\",\\\"originator\\\":\\\"CMFXCAT0XXX\\\",\\\"serial_parties\\\":{\\\"creditor_agent\\\":\\\"BNPAFRPP\\\",\\\"debtor_agent\\\":\\\"CMFXCAT0XXX\\\"},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-20T19:20:32Z\\\",\\\"received_date\\\":\\\"2022-10-20T19:20:43Z\\\",\\\"instructed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"21450.00\\\"},\\\"interbank_settlement_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"21450.00\\\"},\\\"interbank_settlement_date\\\":\\\"2022-10-20\\\",\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"}],\\\"last_update_time\\\":\\\"2022-10-20T19:21:02.46Z\\\"}\",\n \"network_reference\": \"20221020CMFXCATTAXXX4009347853\",\n \"message_name_identification\": \"103\",\n \"business_service\": \"001\",\n \"tracker_event_type\": \"CTPT\",\n \"valid\": \"True\",\n \"instruction_identification\": \"17681392-1\",\n \"transaction_status\": \"ACSP\",\n \"transaction_status_reason\": \"G000\",\n \"return\": \"False\",\n \"settlement_method\": \"INDA\",\n \"from\": \"CMFXCAT0XXX\",\n \"to\": \"CITINL2XXXX\",\n \"originator\": \"CMFXCAT0XXX\",\n \"serial_parties.creditor_agent\": \"BNPAFRPP\",\n \"serial_parties.debtor_agent\": \"CMFXCAT0XXX\",\n \"sender_acknowledgement_receipt\": \"2022-10-20T19:20:32.000Z\",\n \"received_date\": \"2022-10-20T19:20:43.000Z\",\n \"instructed_amount.currency\": \"EUR\",\n \"instructed_amount.amount\": \"21450.00\",\n \"interbank_settlement_amount.currency\": \"EUR\",\n \"interbank_settlement_amount.amount\": \"21450.00\",\n \"interbank_settlement_date\": \"2022-10-20\",\n \"charge_bearer\": \"SHAR\",\n \"charge_amount[0].currency\": \"EUR\",\n \"charge_amount[0].amount\": \"0.\",\n \"last_update_time\": \"2022-10-20T19:21:02.460Z\"\n }\n },\n {\n \"uniqueId\": \"28026\",\n \"type\": \"Payment Accepted\",\n \"source\": \"CORPAY\",\n \"processedTimestamp\": \"2022-11-01T17:19:01.295Z\",\n \"emittedTimestamp\": \"2022-11-01T17:19:00.842Z\",\n \"fields\": {\n \"clientCode\": \"252726\",\n \"createdTime\": \"2022-11-01T17:19:00.842Z\"\n }\n }\n ],\n \"messageContents\": []\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking/252726-5WQ4P7\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"CORPAY_BIC_CODES\",\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking-biccodes\",\n \"method\": \"GET\"\n },\n {\n \"rel\": \"BANK_SEARCH_SOLR\",\n \"uri\": \"https://crossborder.corpay.com/api/banks\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"c8a45b93-5735-40b2-8cd7-4a7d7e11deb7","name":"200 Payment Accepted","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"url":"/api/payment-tracking/{trackerId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": {\r\n \"trackerId\": \"252726-P20XXG\",\r\n \"clientCode\": 252726,\r\n \"clientName\": \"Client\",\r\n \"sortIndexes\": [\r\n 0\r\n ],\r\n \"events\": [\r\n {\r\n \"uniqueId\": \"28033\",\r\n \"type\": \"Payment Accepted\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-11-01T17:46:01.926Z\",\r\n \"emittedTimestamp\": \"2022-11-01T17:46:00.379Z\",\r\n \"fields\": {\r\n \"clientCode\": \"252726\",\r\n \"createdTime\": \"2022-11-01T17:46:00.379Z\"\r\n }\r\n }\r\n ],\r\n \"messageContents\": []\r\n },\r\n \"errors\": [],\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking/252726-P20XXG\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"CORPAY_BIC_CODES\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking-biccodes\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"BANK_SEARCH_SOLR\",\r\n \"uri\": \"https://crossborder.corpay.com/api/banks\",\r\n \"method\": \"GET\"\r\n }\r\n ]\r\n}"},{"id":"d113d05d-01e8-4f49-8270-d962d0e3db04","name":"200 Payment Processed","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"url":"/api/payment-tracking/{trackerId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": {\r\n \"trackerId\": \"252726-NKVTKN\",\r\n \"clientCode\": 252726,\r\n \"clientName\": \"Client\",\r\n \"uetr\": \"7750d3ea-fee7-4e1a-9a77-6b4fda2cb767\",\r\n \"sortIndexes\": [\r\n 0,\r\n 1,\r\n 2,\r\n 3\r\n ],\r\n \"events\": [\r\n {\r\n \"uniqueId\": \"28029\",\r\n \"type\": \"Payment Accepted\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-10-04T16:26:04.682Z\",\r\n \"emittedTimestamp\": \"2022-10-04T16:26:02.354Z\",\r\n \"fields\": {\r\n \"clientCode\": \"295973\",\r\n \"createdTime\": \"2022-10-04T16:26:02.354Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28030\",\r\n \"type\": \"UETR Created\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-10-11T16:29:40.063Z\",\r\n \"emittedTimestamp\": \"2022-10-11T16:29:39.781Z\",\r\n \"fields\": {\r\n \"clientCode\": \"295973\",\r\n \"uetr\": \"7750d3ea-fee7-4e1a-9a77-6b4fda2cb767\",\r\n \"createdTime\": \"2022-10-11T16:29:39.781Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28031\",\r\n \"type\": \"PaymentProcessed\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-10-11T16:30:10.406Z\",\r\n \"emittedTimestamp\": \"2022-10-11T16:30:08.453Z\",\r\n \"fields\": {\r\n \"uetr\": \"7750d3ea-fee7-4e1a-9a77-6b4fda2cb767\",\r\n \"clientCode\": \"295973\",\r\n \"createdTime\": \"2022-10-11T16:30:08.453Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28032\",\r\n \"type\": \"Payment Accepted\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-11-01T17:38:03.368Z\",\r\n \"emittedTimestamp\": \"2022-11-01T17:38:00.434Z\",\r\n \"fields\": {\r\n \"clientCode\": \"252726\",\r\n \"createdTime\": \"2022-11-01T17:38:00.434Z\"\r\n }\r\n }\r\n ],\r\n \"messageContents\": []\r\n },\r\n \"errors\": [],\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking/252726-NKVTKN\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"CORPAY_BIC_CODES\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking-biccodes\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"BANK_SEARCH_SOLR\",\r\n \"uri\": \"https://crossborder.corpay.com/api/banks\",\r\n \"method\": \"GET\"\r\n }\r\n ]\r\n}"},{"id":"0f2c9251-4fb0-4dcc-9b92-9e971d378911","name":"200 Payment In Process","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"url":"/api/payment-tracking/{trackerId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": {\r\n \"trackerId\": \"252726-1C475Q\",\r\n \"clientCode\": 252726,\r\n \"clientName\": \"Client\",\r\n \"uetr\": \"56f9adca-b57f-491a-a463-edb3049d2bba\",\r\n \"sortIndexes\": [\r\n 0,\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 6,\r\n 5,\r\n 7\r\n ],\r\n \"events\": [\r\n {\r\n \"uniqueId\": \"28034\",\r\n \"type\": \"UETR Created\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-10-28T20:56:49.127Z\",\r\n \"emittedTimestamp\": \"2022-10-28T20:56:48.462Z\",\r\n \"fields\": {\r\n \"clientCode\": \"268089\",\r\n \"uetr\": \"56f9adca-b57f-491a-a463-edb3049d2bba\",\r\n \"createdTime\": \"2022-10-28T20:56:48.462Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28035\",\r\n \"type\": \"PaymentProcessed\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-10-28T20:57:24.915Z\",\r\n \"emittedTimestamp\": \"2022-10-28T20:57:24.763Z\",\r\n \"fields\": {\r\n \"uetr\": \"56f9adca-b57f-491a-a463-edb3049d2bba\",\r\n \"clientCode\": \"268089\",\r\n \"createdTime\": \"2022-10-28T20:57:24.763Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28036\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-10-28T21:00:28.859Z\",\r\n \"emittedTimestamp\": \"2022-10-28T20:57:34.172Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221028CMFXCATTAXXX4011377628\\\",\\\"message_name_identification\\\":\\\"103\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTPT\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"16545641-6\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"settlement_method\\\":\\\"INDA\\\",\\\"from\\\":\\\"CMFXCATTXXX\\\",\\\"to\\\":\\\"CITIGB2LXXX\\\",\\\"originator\\\":\\\"CMFXCATTXXX\\\",\\\"serial_parties\\\":{\\\"creditor_agent\\\":\\\"MONZGB2L\\\",\\\"debtor_agent\\\":\\\"CMFXCATTXXX\\\"},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-28T20:57:11Z\\\",\\\"received_date\\\":\\\"2022-10-28T20:57:18Z\\\",\\\"instructed_amount\\\":{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"3000.00\\\"},\\\"interbank_settlement_amount\\\":{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"3000.00\\\"},\\\"interbank_settlement_date\\\":\\\"2022-10-28\\\",\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.\\\"}],\\\"last_update_time\\\":\\\"2022-10-28T20:57:34.172Z\\\"}\",\r\n \"network_reference\": \"20221028CMFXCATTAXXX4011377628\",\r\n \"message_name_identification\": \"103\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTPT\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"16545641-6\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G000\",\r\n \"return\": \"False\",\r\n \"settlement_method\": \"INDA\",\r\n \"from\": \"CMFXCATTXXX\",\r\n \"to\": \"CITIGB2LXXX\",\r\n \"originator\": \"CMFXCATTXXX\",\r\n \"serial_parties.creditor_agent\": \"MONZGB2L\",\r\n \"serial_parties.debtor_agent\": \"CMFXCATTXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-28T20:57:11.000Z\",\r\n \"received_date\": \"2022-10-28T20:57:18.000Z\",\r\n \"instructed_amount.currency\": \"GBP\",\r\n \"instructed_amount.amount\": \"3000.00\",\r\n \"interbank_settlement_amount.currency\": \"GBP\",\r\n \"interbank_settlement_amount.amount\": \"3000.00\",\r\n \"interbank_settlement_date\": \"2022-10-28\",\r\n \"charge_bearer\": \"SHAR\",\r\n \"charge_amount[0].currency\": \"GBP\",\r\n \"charge_amount[0].amount\": \"0.\",\r\n \"last_update_time\": \"2022-10-28T20:57:34.172Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28037\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-10-28T23:45:08.175Z\",\r\n \"emittedTimestamp\": \"2022-10-28T23:32:18.687Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221029CITIGB2LFXXX4103535302\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"16545641-6\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G002\\\",\\\"return\\\":false,\\\"from\\\":\\\"CITIGB2LXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"CITIGB2LXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-28T23:31:48Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"3000.\\\"},\\\"update_payment\\\":\\\"20221028CMFXCATTAXXX4011377628\\\",\\\"last_update_time\\\":\\\"2022-10-28T23:32:18.687Z\\\"}\",\r\n \"network_reference\": \"20221029CITIGB2LFXXX4103535302\",\r\n \"message_name_identification\": \"199\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTSU\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"16545641-6\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G002\",\r\n \"return\": \"False\",\r\n \"from\": \"CITIGB2LXXX\",\r\n \"to\": \"TRCKCHZZXXX\",\r\n \"originator\": \"CITIGB2LXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-28T23:31:48.000Z\",\r\n \"confirmed_amount.currency\": \"GBP\",\r\n \"confirmed_amount.amount\": \"3000.\",\r\n \"update_payment\": \"20221028CMFXCATTAXXX4011377628\",\r\n \"last_update_time\": \"2022-10-28T23:32:18.687Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28038\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-10-31T08:30:20.173Z\",\r\n \"emittedTimestamp\": \"2022-10-31T08:16:23.940Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221031CITIGB2LBXXX7660649468\\\",\\\"message_name_identification\\\":\\\"103\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTPT\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"B185008357724545\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"settlement_method\\\":\\\"CLRG\\\",\\\"clearing_system\\\":\\\"STG\\\",\\\"from\\\":\\\"CITIGB2LXXX\\\",\\\"to\\\":\\\"NWBKGB55XXX\\\",\\\"originator\\\":\\\"CITIGB2LXXX\\\",\\\"serial_parties\\\":{\\\"creditor_agent\\\":\\\"MONZGB2L\\\",\\\"debtor_agent\\\":\\\"CITIGB2LXXX\\\"},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-31T07:57:06Z\\\",\\\"received_date\\\":\\\"2022-10-31T08:16:48Z\\\",\\\"instructed_amount\\\":{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"3000.\\\"},\\\"interbank_settlement_amount\\\":{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"3000.\\\"},\\\"interbank_settlement_date\\\":\\\"2022-10-31\\\",\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.00\\\"}],\\\"copied_business_service\\\":\\\"STG\\\",\\\"last_update_time\\\":\\\"2022-10-31T08:16:23.94Z\\\"}\",\r\n \"network_reference\": \"20221031CITIGB2LBXXX7660649468\",\r\n \"message_name_identification\": \"103\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTPT\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"B185008357724545\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G000\",\r\n \"return\": \"False\",\r\n \"settlement_method\": \"CLRG\",\r\n \"clearing_system\": \"STG\",\r\n \"from\": \"CITIGB2LXXX\",\r\n \"to\": \"NWBKGB55XXX\",\r\n \"originator\": \"CITIGB2LXXX\",\r\n \"serial_parties.creditor_agent\": \"MONZGB2L\",\r\n \"serial_parties.debtor_agent\": \"CITIGB2LXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-31T07:57:06.000Z\",\r\n \"received_date\": \"2022-10-31T08:16:48.000Z\",\r\n \"instructed_amount.currency\": \"GBP\",\r\n \"instructed_amount.amount\": \"3000.\",\r\n \"interbank_settlement_amount.currency\": \"GBP\",\r\n \"interbank_settlement_amount.amount\": \"3000.\",\r\n \"interbank_settlement_date\": \"2022-10-31\",\r\n \"charge_bearer\": \"SHAR\",\r\n \"charge_amount[0].currency\": \"GBP\",\r\n \"charge_amount[0].amount\": \"0.\",\r\n \"charge_amount[1].currency\": \"GBP\",\r\n \"charge_amount[1].amount\": \"0.00\",\r\n \"copied_business_service\": \"STG\",\r\n \"last_update_time\": \"2022-10-31T08:16:23.940Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28040\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-10-31T09:15:24.373Z\",\r\n \"emittedTimestamp\": \"2022-10-31T09:04:17.017Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221031NWBKGB2LCXXX9860229860\\\",\\\"message_name_identification\\\":\\\"103\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTPT\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"PCM55CI08229816\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G001\\\",\\\"return\\\":false,\\\"settlement_method\\\":\\\"INDA\\\",\\\"from\\\":\\\"NWBKGB2LXXX\\\",\\\"to\\\":\\\"MONZGB2LXXX\\\",\\\"originator\\\":\\\"NWBKGB2LXXX\\\",\\\"serial_parties\\\":{\\\"creditor_agent\\\":\\\"MONZGB2LXXX\\\",\\\"debtor_agent\\\":\\\"NWBKGB2LXXX\\\"},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-31T09:03:43Z\\\",\\\"received_date\\\":\\\"2022-10-31T09:03:52Z\\\",\\\"instructed_amount\\\":{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"3000.\\\"},\\\"interbank_settlement_amount\\\":{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"3000.\\\"},\\\"interbank_settlement_date\\\":\\\"2022-10-31\\\",\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.\\\"}],\\\"last_update_time\\\":\\\"2022-10-31T09:04:17.017Z\\\"}\",\r\n \"network_reference\": \"20221031NWBKGB2LCXXX9860229860\",\r\n \"message_name_identification\": \"103\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTPT\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"PCM55CI08229816\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G001\",\r\n \"return\": \"False\",\r\n \"settlement_method\": \"INDA\",\r\n \"from\": \"NWBKGB2LXXX\",\r\n \"to\": \"MONZGB2LXXX\",\r\n \"originator\": \"NWBKGB2LXXX\",\r\n \"serial_parties.creditor_agent\": \"MONZGB2LXXX\",\r\n \"serial_parties.debtor_agent\": \"NWBKGB2LXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-31T09:03:43.000Z\",\r\n \"received_date\": \"2022-10-31T09:03:52.000Z\",\r\n \"instructed_amount.currency\": \"GBP\",\r\n \"instructed_amount.amount\": \"3000.\",\r\n \"interbank_settlement_amount.currency\": \"GBP\",\r\n \"interbank_settlement_amount.amount\": \"3000.\",\r\n \"interbank_settlement_date\": \"2022-10-31\",\r\n \"charge_bearer\": \"SHAR\",\r\n \"charge_amount[0].currency\": \"GBP\",\r\n \"charge_amount[0].amount\": \"0.\",\r\n \"charge_amount[1].currency\": \"GBP\",\r\n \"charge_amount[1].amount\": \"0.\",\r\n \"charge_amount[2].currency\": \"GBP\",\r\n \"charge_amount[2].amount\": \"0.\",\r\n \"last_update_time\": \"2022-10-31T09:04:17.017Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28039\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-10-31T09:15:24.385Z\",\r\n \"emittedTimestamp\": \"2022-10-31T09:03:05.856Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221031NWBKGB55CXXX6168731334\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"B185008357724545\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"forwarded_to_agent\\\":\\\"NWBKGB2LXXX\\\",\\\"settlement_method\\\":\\\"INDA\\\",\\\"from\\\":\\\"NWBKGB55XXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"NWBKGB55XXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-31T09:02:33Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"3000.\\\"},\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"GBP\\\",\\\"amount\\\":\\\"0.\\\"}],\\\"update_payment\\\":\\\"20221031CITIGB2LBXXX7660649468\\\",\\\"last_update_time\\\":\\\"2022-10-31T09:03:05.856Z\\\"}\",\r\n \"network_reference\": \"20221031NWBKGB55CXXX6168731334\",\r\n \"message_name_identification\": \"199\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTSU\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"B185008357724545\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G000\",\r\n \"return\": \"False\",\r\n \"forwarded_to_agent\": \"NWBKGB2LXXX\",\r\n \"settlement_method\": \"INDA\",\r\n \"from\": \"NWBKGB55XXX\",\r\n \"to\": \"TRCKCHZZXXX\",\r\n \"originator\": \"NWBKGB55XXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-31T09:02:33.000Z\",\r\n \"confirmed_amount.currency\": \"GBP\",\r\n \"confirmed_amount.amount\": \"3000.\",\r\n \"charge_bearer\": \"SHAR\",\r\n \"charge_amount[0].currency\": \"GBP\",\r\n \"charge_amount[0].amount\": \"0.\",\r\n \"charge_amount[1].currency\": \"GBP\",\r\n \"charge_amount[1].amount\": \"0.\",\r\n \"charge_amount[2].currency\": \"GBP\",\r\n \"charge_amount[2].amount\": \"0.\",\r\n \"update_payment\": \"20221031CITIGB2LBXXX7660649468\",\r\n \"last_update_time\": \"2022-10-31T09:03:05.856Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28041\",\r\n \"type\": \"Payment Accepted\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-11-01T17:58:03.116Z\",\r\n \"emittedTimestamp\": \"2022-11-01T17:58:00.663Z\",\r\n \"fields\": {\r\n \"clientCode\": \"252726\",\r\n \"createdTime\": \"2022-11-01T17:58:00.663Z\"\r\n }\r\n }\r\n ],\r\n \"messageContents\": []\r\n },\r\n \"errors\": [],\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking/252726-1C475Q\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"CORPAY_BIC_CODES\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking-biccodes\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"BANK_SEARCH_SOLR\",\r\n \"uri\": \"https://crossborder.corpay.com/api/banks\",\r\n \"method\": \"GET\"\r\n }\r\n ]\r\n}"},{"id":"399c5ab9-63bc-4af0-93bd-0462ab907ebb","name":"200 Payment Rejected","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"url":"/api/payment-tracking/{trackerId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"content\": {\r\n \"trackerId\": \"252726-SINIVZ\",\r\n \"clientCode\": 252726,\r\n \"clientName\": \"Client\",\r\n \"uetr\": \"f4b17a34-228b-4a40-8eef-916754d4db0f\",\r\n \"sortIndexes\": [],\r\n \"events\": [\r\n {\r\n \"uniqueId\": \"28044\",\r\n \"type\": \"UETR Created\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-10-28T08:16:37.662Z\",\r\n \"emittedTimestamp\": \"2022-10-28T08:16:34.790Z\",\r\n \"fields\": {\r\n \"clientCode\": \"236176\",\r\n \"uetr\": \"f4b17a34-228b-4a40-8eef-916754d4db0f\",\r\n \"createdTime\": \"2022-10-28T08:16:34.790Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28045\",\r\n \"type\": \"PaymentProcessed\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-10-28T08:17:11.650Z\",\r\n \"emittedTimestamp\": \"2022-10-28T08:17:09.817Z\",\r\n \"fields\": {\r\n \"uetr\": \"f4b17a34-228b-4a40-8eef-916754d4db0f\",\r\n \"clientCode\": \"236176\",\r\n \"createdTime\": \"2022-10-28T08:17:09.817Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28042\",\r\n \"type\": \"Payment Accepted\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-11-01T18:08:02.519Z\",\r\n \"emittedTimestamp\": \"2022-11-01T18:08:00.566Z\",\r\n \"fields\": {\r\n \"clientCode\": \"252726\",\r\n \"createdTime\": \"2022-11-01T18:08:00.566Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28046\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-11-01T18:10:23.964Z\",\r\n \"emittedTimestamp\": \"2022-10-28T08:25:18.625Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221028CITIGB2LKXXX1211391515\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"2022102804583602\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G002\\\",\\\"return\\\":false,\\\"from\\\":\\\"CITIIE2XXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"CITIIE2XXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-28T08:24:57Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"2400.\\\"},\\\"update_payment\\\":\\\"20221028CITIGB2LHXXX3165227693\\\",\\\"last_update_time\\\":\\\"2022-10-28T08:25:18.625Z\\\"}\",\r\n \"network_reference\": \"20221028CITIGB2LKXXX1211391515\",\r\n \"message_name_identification\": \"199\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTSU\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"2022102804583602\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G002\",\r\n \"return\": \"False\",\r\n \"from\": \"CITIIE2XXXX\",\r\n \"to\": \"TRCKCHZZXXX\",\r\n \"originator\": \"CITIIE2XXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-28T08:24:57.000Z\",\r\n \"confirmed_amount.currency\": \"EUR\",\r\n \"confirmed_amount.amount\": \"2400.\",\r\n \"update_payment\": \"20221028CITIGB2LHXXX3165227693\",\r\n \"last_update_time\": \"2022-10-28T08:25:18.625Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28047\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-11-01T18:10:23.964Z\",\r\n \"emittedTimestamp\": \"2022-10-28T08:22:33.650Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221028BCITITMMBXXX4640275564\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"3218755868\\\",\\\"transaction_status\\\":\\\"RJCT\\\",\\\"transaction_status_reason\\\":\\\"AC06\\\",\\\"return\\\":false,\\\"from\\\":\\\"BCITITMMXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"BCITITMMXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-28T08:22:09Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"2400.\\\"},\\\"charge_amount\\\":[{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.00\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.00\\\"}],\\\"update_payment\\\":\\\"20221028CITIGB2LOXXX1041585396\\\",\\\"last_update_time\\\":\\\"2022-10-28T08:22:33.65Z\\\"}\",\r\n \"network_reference\": \"20221028BCITITMMBXXX4640275564\",\r\n \"message_name_identification\": \"199\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTSU\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"3218755868\",\r\n \"transaction_status\": \"RJCT\",\r\n \"transaction_status_reason\": \"AC06\",\r\n \"return\": \"False\",\r\n \"from\": \"BCITITMMXXX\",\r\n \"to\": \"TRCKCHZZXXX\",\r\n \"originator\": \"BCITITMMXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-28T08:22:09.000Z\",\r\n \"confirmed_amount.currency\": \"EUR\",\r\n \"confirmed_amount.amount\": \"2400.\",\r\n \"charge_amount[0].currency\": \"EUR\",\r\n \"charge_amount[0].amount\": \"0.\",\r\n \"charge_amount[1].currency\": \"EUR\",\r\n \"charge_amount[1].amount\": \"0.00\",\r\n \"charge_amount[2].currency\": \"EUR\",\r\n \"charge_amount[2].amount\": \"0.00\",\r\n \"update_payment\": \"20221028CITIGB2LOXXX1041585396\",\r\n \"last_update_time\": \"2022-10-28T08:22:33.650Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28048\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-11-01T18:10:23.964Z\",\r\n \"emittedTimestamp\": \"2022-10-28T08:21:03.499Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221028CITIGB2LOXXX1041585396\\\",\\\"message_name_identification\\\":\\\"103\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTPT\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"3218755868\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"settlement_method\\\":\\\"CLRG\\\",\\\"clearing_system\\\":\\\"EBA\\\",\\\"from\\\":\\\"CITIIE2XXXX\\\",\\\"to\\\":\\\"BCITITMMXXX\\\",\\\"originator\\\":\\\"CITIIE2XXXX\\\",\\\"serial_parties\\\":{\\\"creditor_agent\\\":\\\"BCITITMMXXX\\\",\\\"debtor_agent\\\":\\\"CITIIE2XXXX\\\"},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-28T08:20:34Z\\\",\\\"received_date\\\":\\\"2022-10-28T08:21:07Z\\\",\\\"instructed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"2400.\\\"},\\\"interbank_settlement_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"2400.\\\"},\\\"interbank_settlement_date\\\":\\\"2022-10-28\\\",\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.00\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.00\\\"}],\\\"copied_business_service\\\":\\\"EBA\\\",\\\"last_update_time\\\":\\\"2022-10-28T08:21:03.499Z\\\"}\",\r\n \"network_reference\": \"20221028CITIGB2LOXXX1041585396\",\r\n \"message_name_identification\": \"103\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTPT\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"3218755868\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G000\",\r\n \"return\": \"False\",\r\n \"settlement_method\": \"CLRG\",\r\n \"clearing_system\": \"EBA\",\r\n \"from\": \"CITIIE2XXXX\",\r\n \"to\": \"BCITITMMXXX\",\r\n \"originator\": \"CITIIE2XXXX\",\r\n \"serial_parties.creditor_agent\": \"BCITITMMXXX\",\r\n \"serial_parties.debtor_agent\": \"CITIIE2XXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-28T08:20:34.000Z\",\r\n \"received_date\": \"2022-10-28T08:21:07.000Z\",\r\n \"instructed_amount.currency\": \"EUR\",\r\n \"instructed_amount.amount\": \"2400.\",\r\n \"interbank_settlement_amount.currency\": \"EUR\",\r\n \"interbank_settlement_amount.amount\": \"2400.\",\r\n \"interbank_settlement_date\": \"2022-10-28\",\r\n \"charge_bearer\": \"SHAR\",\r\n \"charge_amount[0].currency\": \"EUR\",\r\n \"charge_amount[0].amount\": \"0.\",\r\n \"charge_amount[1].currency\": \"EUR\",\r\n \"charge_amount[1].amount\": \"0.00\",\r\n \"charge_amount[2].currency\": \"EUR\",\r\n \"charge_amount[2].amount\": \"0.00\",\r\n \"copied_business_service\": \"EBA\",\r\n \"last_update_time\": \"2022-10-28T08:21:03.499Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28049\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-11-01T18:10:23.964Z\",\r\n \"emittedTimestamp\": \"2022-10-28T08:20:18.322Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221028CITIGB2LBXXX7658443540\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"3202886601\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G002\\\",\\\"return\\\":false,\\\"from\\\":\\\"CITIIE2XXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"CITIIE2XXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-28T08:19:58Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"2400.\\\"},\\\"update_payment\\\":\\\"20221028CITIGB2LHXXX3165227693\\\",\\\"last_update_time\\\":\\\"2022-10-28T08:20:18.322Z\\\"}\",\r\n \"network_reference\": \"20221028CITIGB2LBXXX7658443540\",\r\n \"message_name_identification\": \"199\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTSU\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"3202886601\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G002\",\r\n \"return\": \"False\",\r\n \"from\": \"CITIIE2XXXX\",\r\n \"to\": \"TRCKCHZZXXX\",\r\n \"originator\": \"CITIIE2XXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-28T08:19:58.000Z\",\r\n \"confirmed_amount.currency\": \"EUR\",\r\n \"confirmed_amount.amount\": \"2400.\",\r\n \"update_payment\": \"20221028CITIGB2LHXXX3165227693\",\r\n \"last_update_time\": \"2022-10-28T08:20:18.322Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28050\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-11-01T18:10:23.964Z\",\r\n \"emittedTimestamp\": \"2022-10-28T08:18:48.768Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221028CITIGB2LHXXX3165227693\\\",\\\"message_name_identification\\\":\\\"199\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTSU\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"17756909-1\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"forwarded_to_agent\\\":\\\"CITIIE2XXXX\\\",\\\"settlement_method\\\":\\\"INGA\\\",\\\"from\\\":\\\"CITINL2XXXX\\\",\\\"to\\\":\\\"TRCKCHZZXXX\\\",\\\"originator\\\":\\\"CITINL2XXXX\\\",\\\"serial_parties\\\":{},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-28T08:18:23Z\\\",\\\"confirmed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"2400.\\\"},\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"},{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"}],\\\"update_payment\\\":\\\"20221028CMFXCAT0AXXX4011373833\\\",\\\"last_update_time\\\":\\\"2022-10-28T08:18:48.768Z\\\"}\",\r\n \"network_reference\": \"20221028CITIGB2LHXXX3165227693\",\r\n \"message_name_identification\": \"199\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTSU\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"17756909-1\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G000\",\r\n \"return\": \"False\",\r\n \"forwarded_to_agent\": \"CITIIE2XXXX\",\r\n \"settlement_method\": \"INGA\",\r\n \"from\": \"CITINL2XXXX\",\r\n \"to\": \"TRCKCHZZXXX\",\r\n \"originator\": \"CITINL2XXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-28T08:18:23.000Z\",\r\n \"confirmed_amount.currency\": \"EUR\",\r\n \"confirmed_amount.amount\": \"2400.\",\r\n \"charge_bearer\": \"SHAR\",\r\n \"charge_amount[0].currency\": \"EUR\",\r\n \"charge_amount[0].amount\": \"0.\",\r\n \"charge_amount[1].currency\": \"EUR\",\r\n \"charge_amount[1].amount\": \"0.\",\r\n \"update_payment\": \"20221028CMFXCAT0AXXX4011373833\",\r\n \"last_update_time\": \"2022-10-28T08:18:48.768Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28051\",\r\n \"type\": \"PaymentTrackingInfoReceived\",\r\n \"source\": \"SWIFT\",\r\n \"processedTimestamp\": \"2022-11-01T18:10:23.964Z\",\r\n \"emittedTimestamp\": \"2022-10-28T08:17:17.634Z\",\r\n \"fields\": {\r\n \"rawEvent\": \"{\\\"network_reference\\\":\\\"20221028CMFXCAT0AXXX4011373833\\\",\\\"message_name_identification\\\":\\\"103\\\",\\\"business_service\\\":\\\"001\\\",\\\"tracker_event_type\\\":\\\"CTPT\\\",\\\"valid\\\":true,\\\"instruction_identification\\\":\\\"17756909-1\\\",\\\"transaction_status\\\":\\\"ACSP\\\",\\\"transaction_status_reason\\\":\\\"G000\\\",\\\"return\\\":false,\\\"settlement_method\\\":\\\"INDA\\\",\\\"from\\\":\\\"CMFXCATTXXX\\\",\\\"to\\\":\\\"CITINL2XXXX\\\",\\\"originator\\\":\\\"CMFXCATTXXX\\\",\\\"serial_parties\\\":{\\\"creditor_agent\\\":\\\"BCITITMM\\\",\\\"debtor_agent\\\":\\\"CMFXCATTXXX\\\"},\\\"sender_acknowledgement_receipt\\\":\\\"2022-10-28T08:16:57Z\\\",\\\"received_date\\\":\\\"2022-10-28T08:17:05Z\\\",\\\"instructed_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"2400.00\\\"},\\\"interbank_settlement_amount\\\":{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"2400.00\\\"},\\\"interbank_settlement_date\\\":\\\"2022-10-28\\\",\\\"charge_bearer\\\":\\\"SHAR\\\",\\\"charge_amount\\\":[{\\\"currency\\\":\\\"EUR\\\",\\\"amount\\\":\\\"0.\\\"}],\\\"last_update_time\\\":\\\"2022-10-28T08:17:17.634Z\\\"}\",\r\n \"network_reference\": \"20221028CMFXCAT0AXXX4011373833\",\r\n \"message_name_identification\": \"103\",\r\n \"business_service\": \"001\",\r\n \"tracker_event_type\": \"CTPT\",\r\n \"valid\": \"True\",\r\n \"instruction_identification\": \"17756909-1\",\r\n \"transaction_status\": \"ACSP\",\r\n \"transaction_status_reason\": \"G000\",\r\n \"return\": \"False\",\r\n \"settlement_method\": \"INDA\",\r\n \"from\": \"CMFXCATTXXX\",\r\n \"to\": \"CITINL2XXXX\",\r\n \"originator\": \"CMFXCATTXXX\",\r\n \"serial_parties.creditor_agent\": \"BCITITMM\",\r\n \"serial_parties.debtor_agent\": \"CMFXCATTXXX\",\r\n \"sender_acknowledgement_receipt\": \"2022-10-28T08:16:57.000Z\",\r\n \"received_date\": \"2022-10-28T08:17:05.000Z\",\r\n \"instructed_amount.currency\": \"EUR\",\r\n \"instructed_amount.amount\": \"2400.00\",\r\n \"interbank_settlement_amount.currency\": \"EUR\",\r\n \"interbank_settlement_amount.amount\": \"2400.00\",\r\n \"interbank_settlement_date\": \"2022-10-28\",\r\n \"charge_bearer\": \"SHAR\",\r\n \"charge_amount[0].currency\": \"EUR\",\r\n \"charge_amount[0].amount\": \"0.\",\r\n \"last_update_time\": \"2022-10-28T08:17:17.634Z\"\r\n }\r\n }\r\n ],\r\n \"messageContents\": []\r\n },\r\n \"errors\": [],\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking/252726-SINIVZ\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"CORPAY_BIC_CODES\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking-biccodes\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"BANK_SEARCH_SOLR\",\r\n \"uri\": \"https://crossborder.corpay.com/api/banks\",\r\n \"method\": \"GET\"\r\n }\r\n ]\r\n}"},{"id":"75403b37-1c1a-40e0-b2fa-b2a6c6338ecf","name":"200 Payment Canceled","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"url":"/api/payment-tracking/{trackerId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": {\r\n \"trackerId\": \"252726-66SLTM\",\r\n \"clientCode\": 252726,\r\n \"clientName\": \"Client\",\r\n \"sortIndexes\": [\r\n 0,\r\n 1\r\n ],\r\n \"events\": [\r\n {\r\n \"uniqueId\": \"28052\",\r\n \"type\": \"Payment Canceled\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-11-01T16:59:55.744Z\",\r\n \"emittedTimestamp\": \"2022-11-01T16:59:54.065Z\",\r\n \"fields\": {\r\n \"userKey\": \"79\",\r\n \"createdTime\": \"2022-11-01T16:59:54.065Z\"\r\n }\r\n },\r\n {\r\n \"uniqueId\": \"28053\",\r\n \"type\": \"Payment Accepted\",\r\n \"source\": \"CORPAY\",\r\n \"processedTimestamp\": \"2022-11-01T18:21:01.671Z\",\r\n \"emittedTimestamp\": \"2022-11-01T18:21:00.389Z\",\r\n \"fields\": {\r\n \"clientCode\": \"252726\",\r\n \"createdTime\": \"2022-11-01T18:21:00.389Z\"\r\n }\r\n }\r\n \r\n ],\r\n \"messageContents\": []\r\n },\r\n \"errors\": [],\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking/252726-66SLTM\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"CORPAY_BIC_CODES\",\r\n \"uri\": \"https://crossborder.corpay.com/api/payment-tracking-biccodes\",\r\n \"method\": \"GET\"\r\n },\r\n {\r\n \"rel\": \"BANK_SEARCH_SOLR\",\r\n \"uri\": \"https://crossborder.corpay.com/api/banks\",\r\n \"method\": \"GET\"\r\n }\r\n ]\r\n}"},{"id":"4aafbd65-5b7a-4017-a4db-54cbbe932dd1","name":"404 Invalid Value passed","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"url":"/api/payment-tracking/{trackerId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment record not found with the provided trackerId: XXX\"\n}"}],"_postman_id":"f12309ad-bbed-4b79-8476-038d2ff519bf"}],"id":"5c8cdcbc-fad9-48ef-8b01-99a1c73389f5","description":"The Payment Tracking APIs allow our partners to track payment statuses and related transaction details.
\n","_postman_id":"5c8cdcbc-fad9-48ef-8b01-99a1c73389f5"},{"name":"Client Onboarding","item":[{"name":"Onboard Client","item":[{"name":"Client Onboarding","id":"deed295d-cc09-4f99-89c7-f4f1b1602e2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyName\": \"Acme1\",\r\n \"DBAOrRegisteredTradeName\": \"Acme\",\r\n \"CompanyStreetAddress\": \"New Street\",\r\n \"CompanyCity\": \"Toronto\",\r\n \"CompanyState\": \"Ontario\",\r\n \"CompanyPostalCode\": \"M1M1M1\",\r\n \"CompanyCountryCode\": \"CA\",\r\n \"BusinessContactNumber\": \"4564564566\",\r\n \"BusinessAlternativePhoneNumber\": \"6546546544\",\r\n \"BusinessConfirmationEmail\": \"test1@acme.com\",\r\n \"BusinessConfirmationEmail2\": \"test2@acme.com\",\r\n \"IsPubliclyTraded\": true,\r\n \"StockSymbol\": \"ACM\",\r\n \"FormationIncorporationCountryCode\": \"CA\",\r\n \"FormationIncorporationState\": \"ONTARIO\",\r\n \"DateOfIncorporation\": \"01/01/1977\",\r\n \"BusinessRegistrationIncorporationNumber\": \"789456123\",\r\n \"TaxIDEINNumber\": \"123456\",\r\n \"NatureOfBusiness\": 30,\r\n \"DirectDebitAuthorization\": true,\r\n \"ApplicantTypeId\": 2,\r\n \"BusinessTypeId\": 2,\r\n \"WebsiteUrl\": \"www.ac.com\",\r\n \"OwnedByOtherCorporateEntity\": true,\r\n \"OwnedByPubliclyTradedCompany\": true,\r\n \"OwnedByPubliclyTradedCompanyStockSymbol\": \"CDE\",\r\n \"PurposeOfTransactionId\": 12,\r\n \"CurrencyNeeded\": \"CAD\",\r\n \"TradeVolume\": 4,\r\n \"AnnualVolume\": 3,\r\n \"NumberOfMonthlyTransaction\": 3,\r\n \"FundSourceCountries\": \"US\",\r\n \"FundDestinationCountries\": \"US\",\r\n \"PoliticallyExposedPerson\": false,\r\n \"NameTitlePositionHeld\": \"position\",\r\n \"IsRegisteredBusinessAddressSameAsTrading\": false,\r\n \"FullTradingAddress\": \"123 New Street\",\r\n \"CityTown\": \"Toronto\",\r\n \"PostCode\": \"M1M1M1\",\r\n \"Country\": \"CA\",\r\n \"OtherBusinessLegalStructure\": \"otherbusiness\",\r\n \"OtherSourceOfFunds\": \"othersourcefunds\",\r\n \"OtherSourceOfWealth\": \"othersourcewealth\",\r\n \"AnnualTurnoverInEUR\": \"annualturnover\",\r\n \"AnyBeneficialOwnersHoldUSCitizenship\": true,\r\n \"NoOfEmployees\": 3,\r\n \"IsClientCharitableOrganization\": true,\r\n \"IsClientDealerInStonesPreciousMetals\": true,\r\n \"IsClientHighValueDealer\": false,\r\n \"IsClientNetworkMarketingCompany\": false,\r\n \"IsClientRealEstateCompany\": true,\r\n \"IsClientTravelOrTourCompany\": false,\r\n \"IsClientCannabisRelatedCompany\": true,\r\n \"IsClientCryptoCompany\": false,\r\n \"IsClientMSBFI\": false,\r\n \"ClientIntendsToUseCorpayAccountTo\": \"2\",\r\n \"ExpectedFrequencyOfTransactions\": \"3\",\r\n \"AccountNumber\": \"23\",\r\n \"Routing\": \"2\",\r\n \"RoutingNo\": \"2343\",\r\n \"CurrencyOfAccount\": \"USD\",\r\n \"SettlementMethod\": \"3\",\r\n \"SourceOfFunds\": \"Business Operations\",\r\n \"SourceOfWealth\": \"Accumulated Business Earnings\",\r\n \"CompanyDirectors\": [\r\n {\r\n \"FullName\": \"Director1\",\r\n \"JobTitle\": \"CEO\",\r\n \"Occupation\": \"CEO\",\r\n \"Former Name\": \"D1\",\r\n \"Alias\": \"D1\",\r\n \"NationalityCitizenship\": \"US\",\r\n \"PreviousOtherNationalityHeld\": \"US\",\r\n \"DateOfBirth\": \"Jan1\",\r\n \"IdentificationType\": \"1\",\r\n \"IdentificationNo\": \"1\",\r\n \"CompleteResidentialAddress\": \"test\",\r\n \"SSN\": \"121345\",\r\n \"Email\": \"test@gmail.com\",\r\n \"TelephoneNo\": \"\"\r\n }\r\n ],\r\n \"AnyIndividualOwn25PercentOrMore\": true,\r\n \"BeneficialOwners\": [\r\n {\r\n \"FullName\": \"BO 1\",\r\n \"Nationality\": \"US\",\r\n \"SSN\": \"123456789\",\r\n \"ResidentialAddress\": \"ResidentialAddress1\",\r\n \"OwnershipPercentage\": \"25\",\r\n \"FormerName\": \"BO\",\r\n \"Alias\": \"\",\r\n \"PreviousOtherNationalityHeld\": \"\",\r\n \"BeneficialOwnerDOB\":\"1/12/2000\",\r\n \"IdentificationType\": \"Passport\",\r\n \"IdentificationNo\": \"QQ2356\",\r\n \"IdentificationExpiryDate\": \"01/01/2030\",\r\n \"JurisidictionWhereIssued\": \"CA\",\r\n \"Email\": \"test@test.com\",\r\n \"TelephoneNo\": \"1231231234\",\r\n \"PositionOrOccupation\": \"position\"\r\n }\r\n ],\r\n \"AuthorizedUser\": [\r\n {\r\n \"FullName\": \"Test Name\",\r\n \"Occupation\": \"Tester\",\r\n \"Nationality\": \"US\",\r\n \"Email\": \"test@test.com\",\r\n \"TitlePosition\": \"position\",\r\n \"DOB\": \"01/01/1976\",\r\n \"ResidentialAddress\": \"123 Fake street\",\r\n \"PhoneNo\": \"1231231234\"\r\n }\r\n ],\r\n \"AuthorizedSignatory\": [\r\n {\r\n \"FormerName\": \"AU Name\",\r\n \"Alias\": \"\",\r\n \"NationalityCitizenship\": \"CA\",\r\n \"PrevNationality\": \"AU\",\r\n \"IdentificationType\": \"Passport\",\r\n \"IDNo\": \"QQ2342\",\r\n \"IdentificationExpiryDate\": \"01/01/2030\",\r\n \"JurisdictionWhereIssued\": \"CA\",\r\n \"SSN\": \"\",\r\n \"TelephoneNo\": \"\"\r\n }\r\n ],\r\n \"Company Secretary\": [\r\n {\r\n \"FullLegalName\": \"CS 01\",\r\n \"Position\": \"\"\r\n }\r\n ],\r\n \"AgreeToTermsAndConditions\": true,\r\n \"AuthorizedToBindClientToAgreement\": true,\r\n \"ConsentToPrivacyNotice\": true,\r\n \"ProvideTruthfulInformation\": true,\r\n \"SignerFullName\": \"USSignedCustomerName\",\r\n \"SignerCompleteResidentialAddress\": \"1 Signed User Address Road\",\r\n \"SignerDateOfBirth\": \"12/12/1998\",\r\n \"SignerDateSigned\": \"8/31/2022\",\r\n \"SignerEmail\": \"test@cambridgefx.com\",\r\n \"SignerJobTitle\": \"CEO\",\r\n \"SecondSignerFullName\": \"Signer2\",\r\n \"SecondSignerDateOfBirth\": \"10/15/1998\",\r\n \"SecondSignerJobTitle\": \"CFO\",\r\n \"SecondSignerEmail\": \"test@cambridgefx.com\",\r\n \"SecondSignerCompleteResidentialAddress\": \"2 Signed User Address Road\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/api/clientonboarding","description":"Allows partners to submit a client onboarding request using the required data points. If successful, returns a unique client onboarding identifier clientOnboardingId and the ONBOARDING_ADD_FILES API to submit supporting documents.
Note:
\nField requirements vary by regulatory region. Refer to individual field descriptions below for mandatory fields.
\nRegion-specific mandatory onboarding fields are also available on this page for quick reference.
\nThe customer’s registered country determines the applicable regulatory region. Please reach out to your account representative if a customer cannot be onboarded under any regulatory region.
\nRefer to Onboarding Picklists for allowed values.
\n| Parameter | Description |
|---|---|
CompanyName | string (required) Client's complete legal name to be onboarded. Required for CA, US, UK, AU, NZ, SG, EEA |
DBAOrRegisteredTradeName | string (required) DBA/Registered Trade name/ Business name (if applicable) Required for UK, AU, NZ, SG, EEA |
CompanyStreetAddress | string (required) Current business address Note: Do not enter PO Box number. Required for CA, US, UK, AU, NZ, SG, EEA |
CompanyCity | string (required) Current business location - city/town/suburb Required for CA, US, SG |
CompanyState | string (required if country is US or Canada) Current business location -state/province. Use GET /api/regions?Country=XXfor a list of valid values. Note: Abbreviations not allowed. (e.g., use New York, not NY) |
CompanyPostalCode | string (required) Current business zip/postal code Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyCountryCode | string (required) Current business country code (2 character ISO code) Use GET /api/countries for a list of valid valuesRequired for CA, US, UK, AU, NZ, SG, EEA |
BusinessContactNumber | string (required) Registered current business phone number Required for CA,US, UK, AU, NZ, SG, EEA |
BusinessAlternativePhoneNumber | string Alternate registered business phone number |
BusinessConfirmationEmail | string (required) Registered current business email for confirmation Required for CA,US, UK, AU, NZ, SG, EEA |
BusinessConfirmationEmail2 | string (required) Alternate email for confirmation. If there is no alternate email, enter the primary email address here. |
IsPubliclyTraded | boolean(optional) Does the company publicly trade? TRUE/ FALSE |
StockSymbol | string (optional) Official stock exchange ticker symbol of the company. |
FormationIncorporationCountryCode | string (required) The country code in which the current company is incorporated or legally registered (2 character ISO code) Use GET /api/countries for a list of valid valuesRequired for CA, US, UK, AU, NZ, SG |
FormationIncorporationState | string (required if country is US or Canada) The state/province in which the current company is incorporated or legally registered Use GET /api/regions?Country=XX to retrieve valid valuesNote: Abbreviations not allowed. (e.g., use New York, not NY). Required for CA, US, UK, AU, NZ, SG |
BusinessRegistrationIncorporationNumber | string (required) Current business Registration/Incorporation Number/ACN/ABN Number/Unique Entity Number (UEN) Required for CA,US, UK, AU, NZ, SG, EEA |
TaxIDEINNumber | string (required) Tax ID/EIN/VAT/GST Registration number Required for CA, US, UK, AU, NZ, SG, EEA |
NatureOfBusiness | string(required) The type of business (any primary and secondary activities). Value must match picklist NatureOfBusiness Required for CA,US, UK, AU, NZ, SG, EEAMax: 255 characters |
DirectDebitAuthorization | boolean (required) Set True to confirm authorization for direct debit. Required for CADefault value: false |
ApplicantTypeId | number (required) Legal structure of the company. Value must match picklist ApplicantType. Required for CA,US, UK, AU, NZ, SG, EEA |
BusinessTypeId | number(required) Type of company to be onboarded. Value must match picklist BusinessType |
WebsiteUrl | string (required if Corporate) Current business website URL Required for CA, US, UK, AU, NZ, SG, EEA |
OwnedByOtherCorporateEntity | boolean (optional) Is the company owned by other corporate entity?TRUE/ FALSE |
OwnedByPubliclyTradedCompany | boolean(optional) Does the company publicly trade? TRUE/ FALSE |
OwnedByPubliclyTradedCompanyStockSymbol | string (optional) Stock Exchange Symbol of owning entity |
PurposeOfTransactionId | number (required) Purpose of transactions id. Value must match picklist PurposeOfTransactionRequired for CA, US, UK, AU, NZ, SG, EEA |
CurrencyNeeded | string (required) Currencies needed (3-character currency code, comma separated) Use GET /api/payCurrencies?product=Bene for list of valid valuesRequired for CA, US, UK, AU, NZ, SG, EEA |
TradeVolume | number (required) Approximate per-trade volumes. Value must match picklist TradeVolumeRange Required for CA, US, UK, AU, NZ, SG, EEA |
AnnualVolume | number(required) Estimated annual transaction volume. Value must match picklist AnnualVolumeRangeRequired for SG |
NumberOfMonthlyTransaction | number(required) Approximate transactions in a month |
FundDestinationCountries | string (required) Countries to which funds transfer are expected to go to (2 character country code, comma separated) Use GET /api/countries to retrieve valid values |
FundSourceCountries | string (required) Countries which funds transfer are expected to come from (2 character country code, comma separated) Use GET /api/countries to retrieve valid values |
PoliticallyExposedPerson (PEP) | boolean (required) Does the company have politically exposed persons (PEP)? Required for CA, US, UK, AU, NZ, SG, EEA |
NameTitlePositionHeld | string (required if PEP=true) Title or position of PEP |
IsRegisteredBusinessAddressSameAsTrading | boolean (required) Specifies whether the registered business address is the same as the trading address. |
FullTradingAddress | string (required if registered and trading address differ) Current trading address Required for CA, US, UK, AU, NZ, SG, EEA |
CityTown | string (required if registered and trading address differ) Current trading city |
Post Code | string (required if registered and trading address differ) Current trading zip/postal code |
Country | string (required if registered and trading address differ) Current trading country code |
OtherBusinessLegalStructure | string (required) Other Business Legal Structure. Required for CA, US, UK, AU, NZ, SG, EEA |
OtherSourceOfFunds | string (required) Other source of funds. Required for CA,US, UK, AU, NZ, SG, EEA |
OtherSourceOfWealth | string (required) Source of fund Income. Required for SG, EEA |
AnnualTurnoverInEUR | string (required) Client's annual turnover. Required for SG, EEA |
AnyBeneficialOwnersHoldUSCitizenship | boolean (required) Specifies whether any beneficial owner of the client holds US citizenship. Required for CA,US, UK, AU, NZ, SG, EEA |
NoOfEmployees | number (required) Number of employees. Required for SG, EEA |
IsClientCharitableOrganization | boolean (required) Indicates if the client is a charitable organization. Required for CA,US, UK, AU, NZ, SG, EEA |
IsClientDealerInStonesPreciousMetals | boolean (required) Indicates if the client is deals in Precious Stones or Metals. Required for CA,US, UK, AU, NZ, SG, EEA |
IsClientHighValueDealer | boolean (required) Indicates if the client is classified as a High Value Dealer. Required for CA, US, UK, AU, NZ, SG, EEA |
IsClientNetworkMarketingCompany | boolean (required) Indicates if the client is a Network Marketing Company. Required for CA,US, UK, AU, NZ, SG, EEA |
IsClientRealEstateCompany | boolean (required) Indicates if the client is in real estate sector. Required for CA,US, UK, AU, NZ, SG, EEA |
IsClientTravelOrTourCompany | boolean (required) Indicates if the client is a Travel or Tour Company. Required for CA,US, UK, AU, NZ, SG, EEA |
IsClientCannabisRelatedCompany | boolean (required) Indicates if the client is a Cannabis-Related Company. Required for CA,US, UK, AU, NZ, SG, EEA |
IsClientCryptoCompany | boolean (required) Indicates if the client operates as a cryptocurrency-related company. Required for CA,US, UK, AU, NZ, SG, EEA |
IsClientMSBFI | boolean (required) Indicates if the client is a Money Services Business or a Financial Institution. Required for CA,US, UK, AU, NZ, SG, EEA |
ClientIntendsToUseCorpayAccountTo | string (required) Specifies the intended use of the Corpay account, whether to send payments, receive payments, or both. Value must match picklist ClientIntendsToUseCorpayRequired for CA,US, UK, AU, NZ, SG, EEA |
ExpectedFrequencyOfTransactions | string (required) Expected frequency for deals. Value must match picklist ExpectedFrequencyOfTransactionsRequired for CA, US, UK, AU, NZ, SG, EEA |
AccountNumber | string (required) Account number to settle. Required for CA, US, UK, AU, NZ, SG, EEA |
Routing | string (required) Routing information. Value must match picklist RoutingRequired for CA,US, UK, AU, NZ, SG, EEA |
RoutingNo | string (required)Required for CA,US, UK, AU, NZ, SG, EEA |
CurrencyOfAccount | string (required) Account Currency. Required for CA,US, UK, AU, NZ, SG, EEA |
SettlementMethod | string (required) Deal Settlement Method. Value must match picklist SettlementMethod Required for CA,US, UK, AU, NZ, SG, EEA |
SourceOfFunds | string (required) Source of fund Investment Proceeds. Value must match picklist SourceOfFunds Required for CA,US, UK, AU, NZ, SG, EEA |
SourceOfWealth | string (required) Other source of funds. Value must match picklist SourceOfWealth Required for SG, EEA |
CompanyDirectors Array | Maximum of 6 directors allowed. |
CompanyDirectors.FullName | string (required) Director or senior officer full legal name Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.JobTitle | string (required) Director or senior officer job title Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.Occupation | string (required) Director or senior officer occupation Maximum 30 characters. Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.FormerName | string (required) Director or senior officer former name (if applicable). Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.Alias | string (required) Director or senior officer alias (if applicable). Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.NationalityCitizenship | string (required) Director or senior officer current Nationality. Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.PreviousOtherNationalityHeld | string (required) Director or senior officer previous Nationality (if applicable). Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.DateOfBirth | string (required) Director or senior officer date of birth. Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.IdentificationType | string Director or senior officer current identification document. Value must match picklist IdTypeRequired for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.IdentificationNo | string Director or senior officer current identification document number. Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.CompleteResidentialAddress | string (required) Director or senior officer current address. Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.SSN | string (required) Director or senior officer SSN (US citizens). Required for CA, US, UK, AU, NZ, SG, EEA |
CompanyDirectors.Email | string (required) Director or senior officer email address. Required for CA,US, UK, AU, NZ, SG, EEA |
CompanyDirectors.TelephoneNo | string (required) Director or senior officer contact number. Required for CA,US, UK, AU, NZ, SG, EEA |
AnyIndividualOwn25PercentOrMore | boolean (required) Does any individual own 25% or more ownership of the company TRUE/ FALSE |
BeneficialOwners Array | Maximum of 4 Beneficial Owners allowed. required if any individual owns more than 25% |
BeneficialOwners.FullName | string (required) Beneficial Owner full legal name Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.Nationality | string (required) Current nationality country code (2 character ISO code). Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.SSN | string (required) Beneficial Owner Social security number (US citizens) Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.ResidentialAddress | string (required) Beneficial Owner residential address Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.OwnershipPercentage | string (required Beneficial ownership percentage Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.FormerName | string (required) Beneficial Owner former name (if applicable). Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.Alias | string (required) Beneficial Owner former alias (if applicable). Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.PreviousOtherNationalityHeld | string (required) Beneficial Owner former nationality (if applicable) |
BeneficialOwners.IdentificationType | string Beneficial Owner identification document. Value must match picklist IdTypeRequired for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.IdentificationNo | string Beneficial Owner identification document number. Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.IdentificationExpiryDate | string Beneficial Owner identification document expiry date. Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.JurisidictionWhereIssued | string Beneficial Owner identification document issued jurisdiction. Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.Email | string (required) Beneficial Owner email address. Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.TelephoneNo | string (required) Beneficial Owner contact number. Required for CA,US, UK, AU, NZ, SG, EEA |
BeneficialOwners.PositionOrOccupation | string (required) Beneficial Owner job title. Required for CA, US, UK, AU, NZ, SG, EEA |
Authorized User array | Maximum of 3 Authorized Users allowed |
AuthorizedUser.FullName | string (required) Authorized User(s) Full Legal Name. Required for SG, EEA |
AuthorizedUser.Occupation | string (required) Authorized User(s) Occupation/Job Title. Required for SG, EEA |
AuthorizedUser.Nationality | string (required) Authorized User(s) Nationality. Required for SG, EEA |
AuthorizedUser.Email | string (required) Authorized User(s) Email. Required for SG, EEA |
AuthorizedUser.TitlePosition | string (required) Authorized User(s) Title/Position. Required for SG, EEA |
AuthorizedUser.DOB | string (required) Authorized User(s) Date of Birth. Required for SG, EEA |
AuthorizedUser.DOB | string (required) Authorized User(s) Date of Birth. Required for SG, EEA |
AuthorizedUser.ResidentialAddress | string (required) Authorized User(s) Complete Residential Address. Required for SG, EE |
AuthorizedUser.PhoneNo | string (required) Authorized User(s) Telephone Number. Required for SG, EEA |
AuthorizedSignatory array | Up to two authorized signatories are allowed. |
AuthorizedSignatory.FormerName | string (required) Authorized Signatory(s) Former Name (if applicable). Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.Alias | string (required) Authorized Signatory(s) Alias (if applicable). Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.NationalityCitizenship | string (required) Authorized Signatory(s) Nationality/Citizenship. Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.PrevNationality | string (required) Authorized Signatory(s) previous Nationality/Citizenship held Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.IdentificationType | string Authorized Signatory(s) Identification document Value must match picklist IdType.Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.IdNo | string Authorized Signatory(s) Identification number Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.IdentificationExpiryDate | string Authorized Signatory(s) Identification document expiry date Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.JurisdictionWhereIssued | string Authorized Signatory(s) Identification document issued jurisdiction Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.SSN | string (required) Authorized Signatory(s) SSN (US Citizens) Required for CA,US, UK, AU, NZ, SG, EEA |
AuthorizedSignatory.TelephoneNo | string (required) Authorized Signatory(s) contact number Required for CA,US, UK, AU, NZ, SG, EEA |
CompanySecretary Array | Only one company secretary is permitted per onboarding application |
Company Secretary.FullLegalName | string Company Secretary(s) Full Legal Name |
Company Secretary.Position | string Company Secretary(s) Position |
ProvideTruthfulInformation | boolean (required) All statements in this Agreement, and any other information and documentation submitted in support of this Agreement, are true and correct. TRUE/ FALSE Note: The value must be true to complete onboarding request. |
AgreeToTermsAndConditions | boolean (required) Client has read, understood and hereby accepts the attached terms and conditions here. TRUE/ FALSE Note: The value must be true to complete onboarding request. |
ConsentToPrivacyNotice | boolean (required) Consent to Privacy Notice here. TRUE/ FALSE Note: The value must be true to complete onboarding request. |
AuthorizedToBindClientToAgreement | boolean (required) The individual(s) signing this application have the authority to bind the Client to the terms of this Agreement (supporting documentation may be requested) TRUE/ FALSE Note: The value must be true to complete onboarding request. |
SignerFullName | string (required) Signatory full name Note: At least 1 Signatory is Required. In case the country is Australia two Signatories are required. |
SignerDateOfBirth | string (required) Signatory date of birth Allowed format: mm/dd/yyyy |
SignerDateSigned | string (required) Date on which the signatory signed the agreement. |
SignerJobTitle | string (required) Signatory job title |
SignerEmail | string (required) Signatory email |
SignerCompleteResidentialAddress | string (required) Complete address of the signatory (Street, City/Town, State/Province, Country, and Zip/Postal Code) |
SecondSignerFullName | string (required if Australia) Second Signatory full name |
SecondSignerDateOfBirth | string (required if Australia) Second signatory date of birth Allowed format: mm/dd/yyyy |
SecondSignerJobTitle | string (required if Australia) Second signatory job title |
SecondSignerEmail | string(required if Australia) Second signatory email |
SecondSignerCompleteResidentialAddress | string (required if Australia) Complete address of the second signatory (Street, City/Town, State/Province, Country, and Zip/Postal Code) |
Upload File
\n","value":null,"disabled":true},{"key":"PNG","type":"file","description":"Upload File
\n","value":null,"disabled":true},{"key":"JPG","type":"file","description":"Upload File
\n","value":null}]},"url":"/api/clientonboarding-files/clientOnboardingId","description":"After you successfully submit the client information, upload the required verification documents (refer to the Mandatory Documents Required for Onboarding table below). We recommend waiting 60 seconds before running the request to submit the files. This delay ensures that the system has completed all necessary processing steps for the onboarding record. If more documents are required, additional file uploads can be made.
\nNote: If you get a 400 Bad Request error when uploading files, please wait a few seconds and retry the request. Ensure that clientOnboardingId is valid, and all file upload criteria are met. For persistent errors, please contact your account representative.
Include the clientOnboardingId in the URL. This ID is returned in the POST /clientonboarding response.
Files must be uploaded in binary format.
\nA maximum of 10 files can be uploaded per request, and the total file upload size must not exceed 5 MB.
\nOnly PDF, PNG, and JPEG formats are supported.
\nEach document must include a file name in the request.
\nIf any of the above criteria are not met, the entire request will be rejected.
\nNote:
\nFor client onboarding requests outside the listed jurisdictions, please contact your account representative.
\nDirect Debit forms are currently collected offline and cannot be submitted via the API.
\nThis endpoint returns the Secret Key for a successfully onboarded client. This secret key is used to authenticate the API requests made by the client and to enable access to Corpay's suite of API services. Each feature is permission-based and can be enabled or restricted per client.
\nProvide a valid clientOnboardingId to retrieve the associated client-level Secret Key for a client that has been successfully onboarded and approved. The clientOnboardingId is returned in the POST clientOnboarding response.
Optionally, subscribe to the Client Onboarding Notification Webhook to receive real-time updates when a client is approved and their Secret Key is ready.
\nThe message is encrypted using AES encryption.
\nYou can use decrypting tools (e.g., LINQPad 7) to decrypt the response. Please contact your account representative for the decryption script.
\nRun the script. The decrypted response will return your ClientCode, AuthSecret, and the UserName. For example,
\n{\"ClientCode\":\"clientCode\",\"AuthSecret\":\"5da06ce6461d4411b7aef64ed64dfb2fgdwj_R2xx_-XXXX\",\"UserNames\":[\"DEMO USER\"]}\n\nOnboard a client via the client onboarding request. Upon successful submission of data, a unique clientOnboardingId is generated.
Submit the required verification documents for the onboarded client through the document submission request. This is a mandatory requirement to complete the client onboarding process.
\nOnce the onboarding request is approved, generate auth keys via the AuthSecret Keys request. You can confirm the onboarding approval by checking the onboarding response returned in Step 1. This key enables your downstream client to securely access Corpay’s API suite based on assigned permissions.
\nOptionally, subscribe to the Client Onboarding Webhook to receive real-time updates when the onboarding request is approved and the secret key is generated.
\nNote: You cannot onboard duplicate client profiles.
\n","_postman_id":"cc93f162-1d19-4585-a9ae-1fe3659f5923"},{"name":"Reference Data","item":[{"name":"Onboarding Picklists","id":"1655c1ed-d585-487d-ba7f-ffda488976d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/api/clientonboarding/onboardingpicklists?pickListType=ApplicantType","description":"This endpoint returns a list of valid picklist values for various data fields used in the POST clientOnboarding API. Use the values returned in the picklist response when sending the onboarding request. Referencing these values helps ensure your requests conform to expected formats and pass validation.
Picklist values are currently returned for the following fields:
\nAnnualVolumeRange
\nApplicantType
\nBusinessType
\nClientIntendsToUseCorpayAccountTo
\nExpectedFrequencyOfTransactions
\nIdType
\nNatureOfBusiness
\nPurposeOfTransaction
\nRouting
\nSettlementMethod
\nSourceOfFunds
\nSourceOfWealth
\nTotalAssetsOrNetWorth
\nTradeVolumeRange
\nNote: Always refer to the latest version of the response returned by this endpoint to stay aligned with our current API validation rules and supported data formats. We may add new values or modify existing ones as required. Please refer to our API release notes to stay informed of changes.
\n","urlObject":{"path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType"},{"disabled":true,"key":"pickListType","value":"BusinessType"},{"disabled":true,"key":"pickListType","value":"PurposeOfTransaction"},{"disabled":true,"key":"pickListType","value":"TradeVolumeRange"},{"disabled":true,"key":"pickListType","value":"NatureOfBusiness"},{"disabled":true,"key":"pickListType","value":"ClientIntendsToUseCorpayAccountTo"},{"disabled":true,"key":"pickListType","value":"ExpectedFrequencyOfTransactions"},{"disabled":true,"key":"pickListType","value":"TotalAssetsOrNetWorth"},{"disabled":true,"key":"pickListType","value":"SourceOfFunds"},{"disabled":true,"key":"pickListType","value":"SourceOfWealth"},{"disabled":true,"key":"pickListType","value":"Routing"},{"disabled":true,"key":"pickListType","value":"SettlementMethod"},{"disabled":true,"key":"pickListType","value":"IdType"}],"variable":[]}},"response":[{"id":"d77b20c8-7d75-4208-b7d1-713a3ab2f200","name":"200 Annual Volume Range","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=AnnualVolumeRange","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"AnnualVolumeRange"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.5","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Access-Control-Allow-Origin","value":"https://www.cambridgelink.com","enabled":true},{"key":"Date","value":"Wed, 24 Aug 2022 20:02:27 GMT","enabled":true},{"key":"Content-Length","value":"1876","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"annualVolumeRangeList\": [\n {\n \"id\": \"1\",\n \"name\": \"LessThan25000\",\n \"stringValue\": \"Less than 25000\"\n },\n {\n \"id\": \"2\",\n \"name\": \"TwentyFiveThousandToFiftyThousand\",\n \"stringValue\": \"25,000 – 50,000\"\n },\n {\n \"id\": \"3\",\n \"name\": \"FiftyThousandToSeventyFiveThousand\",\n \"stringValue\": \"50,000 – 75,000\"\n },\n {\n \"id\": \"4\",\n \"name\": \"SeventyFiveToOneHundredThousand\",\n \"stringValue\": \"75,000 – 100,000\"\n },\n {\n \"id\": \"5\",\n \"name\": \"OneHundredToOneHundredFiftyThousand\",\n \"stringValue\": \"100,000 – 150,000\"\n },\n {\n \"id\": \"6\",\n \"name\": \"OneHundredFiftyToTwoHundredThousand\",\n \"stringValue\": \"150,000 – 200,000\"\n },\n {\n \"id\": \"7\",\n \"name\": \"TwoHundredToTwoHundredFiftyThousand\",\n \"stringValue\": \"200,000 – 250,000\"\n },\n {\n \"id\": \"8\",\n \"name\": \"TwoHundredFiftyToThreeHundredThousand\",\n \"stringValue\": \"250,000 – 300,000\"\n },\n {\n \"id\": \"9\",\n \"name\": \"ThreeHundredToFourHundredThousand\",\n \"stringValue\": \"300,000 – 400,000\"\n },\n {\n \"id\": \"10\",\n \"name\": \"FourHundredToFiveHundredThousand\",\n \"stringValue\": \"400,000 – 500,000\"\n },\n {\n \"id\": \"11\",\n \"name\": \"FiveHundredToSevenHundredFiftyThousand\",\n \"stringValue\": \"500,000 – 750,000\"\n },\n {\n \"id\": \"12\",\n \"name\": \"SevenHundredFiftyThousandToOneMillion\",\n \"stringValue\": \"750,000 – 1 million\"\n },\n {\n \"id\": \"13\",\n \"name\": \"OneMillionToTwoMillion\",\n \"stringValue\": \"1 million – 2 million\"\n },\n {\n \"id\": \"14\",\n \"name\": \"TwoMillionToThreeMillion\",\n \"stringValue\": \"2 million – 3 million\"\n },\n {\n \"id\": \"15\",\n \"name\": \"ThreeMillionToFiveMillion\",\n \"stringValue\": \"3 million – 5 million\"\n },\n {\n \"id\": \"16\",\n \"name\": \"FiveMillionToSevenPointFiveMillion\",\n \"stringValue\": \"5 million – 7.5 million\"\n },\n {\n \"id\": \"17\",\n \"name\": \"SevenPointFiveMillionToTenMillion\",\n \"stringValue\": \"7.5 million – 10 million\"\n },\n {\n \"id\": \"18\",\n \"name\": \"GreaterThan10Million\",\n \"stringValue\": \"Greater than 10 Mil\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20AnnualVolumeRange\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"91a598b4-e656-4895-8e4d-3822d6f8c38e","name":"200 Applicant Type","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=ApplicantType","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.5","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Access-Control-Allow-Origin","value":"https://www.cambridgelink.com","enabled":true},{"key":"Date","value":"Wed, 24 Aug 2022 20:04:12 GMT","enabled":true},{"key":"Content-Length","value":"1248","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"applicantTypeList\": [\n {\n \"id\": \"1\",\n \"name\": \"Corporation\",\n \"stringValue\": \"Corporation\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Limited_Liability_Company\",\n \"stringValue\": \"Limited Liability Company\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Partnership\",\n \"stringValue\": \"Partnership\"\n },\n {\n \"id\": \"4\",\n \"name\": \"Unincorporated_Entity\",\n \"stringValue\": \"Unincorporated Entity\"\n },\n {\n \"id\": \"5\",\n \"name\": \"Hybrid_Or_Flexible_Entities\",\n \"stringValue\": \"Hybrid or Flexible Entities (e.g. LLC)\"\n },\n {\n \"id\": \"6\",\n \"name\": \"Non_Profit\",\n \"stringValue\": \"Non Profit\"\n },\n {\n \"id\": \"7\",\n \"name\": \"Financial_Institution\",\n \"stringValue\": \"Financial Institution\"\n },\n {\n \"id\": \"8\",\n \"name\": \"Charitable_Organization\",\n \"stringValue\": \"Charitable Organization\"\n },\n {\n \"id\": \"9\",\n \"name\": \"Sole_Proprietorship_Sole_Trader\",\n \"stringValue\": \"Sole Proprietorship Sole Trader\"\n },\n {\n \"id\": \"10\",\n \"name\": \"Personal_Account\",\n \"stringValue\": \"Personal Account\"\n },\n {\n \"id\": \"11\",\n \"name\": \"Trust\",\n \"stringValue\": \"Trust\"\n },\n {\n \"id\": \"12\",\n \"name\": \"Online_User_Verification\",\n \"stringValue\": \"Online User Verification\"\n },\n {\n \"id\": \"13\",\n \"name\": \"Private_Person_Entity\",\n \"stringValue\": \"Private Person Entity\"\n },\n {\n \"id\": \"14\",\n \"name\": \"Other\",\n \"stringValue\": \"Other\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ApplicantType\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"0f18cc1d-1ff0-41f7-871f-9af0eb5d0617","name":"200 Business Type","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=BusinessType","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"BusinessType"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.5","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Access-Control-Allow-Origin","value":"https://www.cambridgelink.com","enabled":true},{"key":"Date","value":"Wed, 24 Aug 2022 20:04:40 GMT","enabled":true},{"key":"Content-Length","value":"1641","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"businessTypeList\": [\n {\n \"id\": \"1\",\n \"name\": \"Call_In\",\n \"stringValue\": \"Call-In\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Cannabis_Related_Business\",\n \"stringValue\": \"Cannabis-Related Business\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Charitable_Organization\",\n \"stringValue\": \"Charitable Organization\"\n },\n {\n \"id\": \"4\",\n \"name\": \"ECommerce_Online_Retail_Businesses\",\n \"stringValue\": \"E-Commerce/ Online Retail Businesses\"\n },\n {\n \"id\": \"5\",\n \"name\": \"Health_Care_Travel_Insurance\",\n \"stringValue\": \"Health Care and Travel Insurance\"\n },\n {\n \"id\": \"6\",\n \"name\": \"Holding_Company\",\n \"stringValue\": \"Holding Company\"\n },\n {\n \"id\": \"7\",\n \"name\": \"Investment_Firm\",\n \"stringValue\": \"Investment Firm\"\n },\n {\n \"id\": \"8\",\n \"name\": \"Law_Firms_Accounting_Firms\",\n \"stringValue\": \"Law Firms/Accounting Firms\"\n },\n {\n \"id\": \"9\",\n \"name\": \"Multi_Level_Marketing_MLMs\",\n \"stringValue\": \"Multi-Level Marketing (MLMs)\"\n },\n {\n \"id\": \"10\",\n \"name\": \"Payment_Processor\",\n \"stringValue\": \"Payment Processor\"\n },\n {\n \"id\": \"11\",\n \"name\": \"Payroll_Processor\",\n \"stringValue\": \"Payroll Processor\"\n },\n {\n \"id\": \"12\",\n \"name\": \"Precious_Metals_High_Value_Dealer\",\n \"stringValue\": \"Precious Metals/ High Value Dealer\"\n },\n {\n \"id\": \"13\",\n \"name\": \"Real_Estate\",\n \"stringValue\": \"Real Estate\"\n },\n {\n \"id\": \"14\",\n \"name\": \"Travel_and_Tour\",\n \"stringValue\": \"Travel and Tour\"\n },\n {\n \"id\": \"15\",\n \"name\": \"Used_Vehicle_Dealer\",\n \"stringValue\": \"(Used) Vehicle Dealer\"\n },\n {\n \"id\": \"16\",\n \"name\": \"Vendor_In_Amazon_Or_Equivalent\",\n \"stringValue\": \"Vendor in Amazon/ Equivalent Website\"\n },\n {\n \"id\": \"17\",\n \"name\": \"Not_Applicable\",\n \"stringValue\": \"Not Applicable\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20BusinessType\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"903343c0-23a7-466a-b5e4-b61f9baeb8eb","name":"200 Client Intends To Use Corpay Account To","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=ClientIntendsToUseCorpayAccountTo","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"ClientIntendsToUseCorpayAccountTo"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"clientIntendsToUseCorpayAccountTo\": [\n {\n \"id\": \"0\",\n \"name\": \"Undefined\",\n \"stringValue\": \"Undefined\"\n },\n {\n \"id\": \"1\",\n \"name\": \"SendPaymentsOnly\",\n \"stringValue\": \"Send payments only\"\n },\n {\n \"id\": \"2\",\n \"name\": \"ReceivePaymentsOnly\",\n \"stringValue\": \"Receive payments only\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Both\",\n \"stringValue\": \"Both\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ClientIntendsToUseCorpayAccountTo\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"626ff484-6af6-4218-99d1-9f75ae9a34b7","name":"200 Expected Frequency Of Transactions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=ExpectedFrequencyOfTransactions","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"ExpectedFrequencyOfTransactions"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"expectedFrequencyOfTransactions\": [\n {\n \"id\": \"0\",\n \"name\": \"Undefined\",\n \"stringValue\": \"Undefined\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Weekly\",\n \"stringValue\": \"Weekly\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Monthly\",\n \"stringValue\": \"Monthly\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Quarterly\",\n \"stringValue\": \"Quarterly\"\n },\n {\n \"id\": \"4\",\n \"name\": \"Annually\",\n \"stringValue\": \"Annually\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20ExpectedFrequencyofTransactions\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"729978ea-98a6-43fa-b4d8-44e4df06e0c6","name":"200 Id Type","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=IdType","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"IdType"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"idType\": [\n {\n \"id\": \"0\",\n \"name\": \"Undefined\",\n \"stringValue\": \"Undefined\"\n },\n {\n \"id\": \"1\",\n \"name\": \"BirthCertificate\",\n \"stringValue\": \"Birth Certificate\"\n },\n {\n \"id\": \"2\",\n \"name\": \"CitizenshipCard\",\n \"stringValue\": \"Citizenship Card\"\n },\n {\n \"id\": \"3\",\n \"name\": \"DriversLicense\",\n \"stringValue\": \"Driver's License\"\n },\n {\n \"id\": \"4\",\n \"name\": \"NationalizationCard\",\n \"stringValue\": \"Nationalization Card\"\n },\n {\n \"id\": \"5\",\n \"name\": \"Passport\",\n \"stringValue\": \"Passport\"\n },\n {\n \"id\": \"6\",\n \"name\": \"PhotoIdProofOfAge\",\n \"stringValue\": \"PhotoId / Proof of Age\"\n },\n {\n \"id\": \"7\",\n \"name\": \"Photocard\",\n \"stringValue\": \"Photocard\"\n },\n {\n \"id\": \"8\",\n \"name\": \"StateIdentityCard\",\n \"stringValue\": \"State Identity Card\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20IdType\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"69e85f84-bb35-4c9f-be6c-8ad0ebb7f504","name":"200 NatureOfBusiness","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=NatureOfBusiness","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"NatureOfBusiness","type":"text"},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"natureOfBusinessList\": [\n {\n \"id\": \"0\",\n \"name\": \"Undefined\",\n \"stringValue\": \"Undefined\"\n },\n {\n \"id\": \"10\",\n \"name\": \"Aerospace and defense\",\n \"stringValue\": \"Aerospace and defense\"\n },\n {\n \"id\": \"20\",\n \"name\": \"Agriculture and agric-food\",\n \"stringValue\": \"Agriculture and agric-food\"\n },\n {\n \"id\": \"30\",\n \"name\": \"Apparel / Clothing\",\n \"stringValue\": \"Apparel / Clothing\"\n },\n {\n \"id\": \"40\",\n \"name\": \"Automotive / Trucking\",\n \"stringValue\": \"Automotive / Trucking\"\n },\n {\n \"id\": \"50\",\n \"name\": \"Books / Magazines\",\n \"stringValue\": \"Books / Magazines\"\n },\n {\n \"id\": \"60\",\n \"name\": \"Broadcasting\",\n \"stringValue\": \"Broadcasting\"\n },\n {\n \"id\": \"70\",\n \"name\": \"Building products\",\n \"stringValue\": \"Building products\"\n },\n {\n \"id\": \"80\",\n \"name\": \"Chemicals\",\n \"stringValue\": \"Chemicals\"\n },\n {\n \"id\": \"90\",\n \"name\": \"Dairy\",\n \"stringValue\": \"Dairy\"\n },\n {\n \"id\": \"100\",\n \"name\": \"E-business\",\n \"stringValue\": \"E-business\"\n },\n {\n \"id\": \"105\",\n \"name\": \"Educational Institutes\",\n \"stringValue\": \"Educational Institutes\"\n },\n {\n \"id\": \"110\",\n \"name\": \"Environment\",\n \"stringValue\": \"Environment\"\n },\n {\n \"id\": \"120\",\n \"name\": \"Explosives\",\n \"stringValue\": \"Explosives\"\n },\n {\n \"id\": \"140\",\n \"name\": \"Fisheries and oceans\",\n \"stringValue\": \"Fisheries and oceans\"\n },\n {\n \"id\": \"150\",\n \"name\": \"Food / Beverage distribution\",\n \"stringValue\": \"Food / Beverage distribution\"\n },\n {\n \"id\": \"160\",\n \"name\": \"Footwear\",\n \"stringValue\": \"Footwear\"\n },\n {\n \"id\": \"170\",\n \"name\": \"Forest industries\",\n \"stringValue\": \"Forest industries\"\n },\n {\n \"id\": \"180\",\n \"name\": \"Furniture\",\n \"stringValue\": \"Furniture\"\n },\n {\n \"id\": \"190\",\n \"name\": \"Giftware and crafts\",\n \"stringValue\": \"Giftware and crafts\"\n },\n {\n \"id\": \"200\",\n \"name\": \"Horticulture\",\n \"stringValue\": \"Horticulture\"\n },\n {\n \"id\": \"210\",\n \"name\": \"Hydroelectric energy\",\n \"stringValue\": \"Hydroelectric energy\"\n },\n {\n \"id\": \"220\",\n \"name\": \"Information and communication technologies\",\n \"stringValue\": \"Information and communication technologies\"\n },\n {\n \"id\": \"230\",\n \"name\": \"Intelligent systems\",\n \"stringValue\": \"Intelligent systems\"\n },\n {\n \"id\": \"240\",\n \"name\": \"Livestock\",\n \"stringValue\": \"Livestock\"\n },\n {\n \"id\": \"250\",\n \"name\": \"Medical devices\",\n \"stringValue\": \"Medical devices\"\n },\n {\n \"id\": \"251\",\n \"name\": \"Medical treatment\",\n \"stringValue\": \"Medical treatment\"\n },\n {\n \"id\": \"260\",\n \"name\": \"Minerals, metals and mining\",\n \"stringValue\": \"Minerals, metals and mining\"\n },\n {\n \"id\": \"270\",\n \"name\": \"Oil and gas\",\n \"stringValue\": \"Oil and gas\"\n },\n {\n \"id\": \"280\",\n \"name\": \"Pharmaceuticals and biopharmaceuticals\",\n \"stringValue\": \"Pharmaceuticals and biopharmaceuticals\"\n },\n {\n \"id\": \"290\",\n \"name\": \"Plastics\",\n \"stringValue\": \"Plastics\"\n },\n {\n \"id\": \"300\",\n \"name\": \"Poultry and eggs\",\n \"stringValue\": \"Poultry and eggs\"\n },\n {\n \"id\": \"310\",\n \"name\": \"Printing /Publishing\",\n \"stringValue\": \"Printing /Publishing\"\n },\n {\n \"id\": \"320\",\n \"name\": \"Product design and development\",\n \"stringValue\": \"Product design and development\"\n },\n {\n \"id\": \"330\",\n \"name\": \"Railway\",\n \"stringValue\": \"Railway\"\n },\n {\n \"id\": \"340\",\n \"name\": \"Retail\",\n \"stringValue\": \"Retail\"\n },\n {\n \"id\": \"350\",\n \"name\": \"Shipping and industrial marine\",\n \"stringValue\": \"Shipping and industrial marine\"\n },\n {\n \"id\": \"360\",\n \"name\": \"Soil\",\n \"stringValue\": \"Soil\"\n },\n {\n \"id\": \"370\",\n \"name\": \"Sound recording\",\n \"stringValue\": \"Sound recording\"\n },\n {\n \"id\": \"380\",\n \"name\": \"Sporting goods\",\n \"stringValue\": \"Sporting goods\"\n },\n {\n \"id\": \"390\",\n \"name\": \"Telecommunications equipment\",\n \"stringValue\": \"Telecommunications equipment\"\n },\n {\n \"id\": \"400\",\n \"name\": \"Television\",\n \"stringValue\": \"Television\"\n },\n {\n \"id\": \"410\",\n \"name\": \"Textiles\",\n \"stringValue\": \"Textiles\"\n },\n {\n \"id\": \"420\",\n \"name\": \"Tourism\",\n \"stringValue\": \"Tourism\"\n },\n {\n \"id\": \"425\",\n \"name\": \"Trademarks / Law\",\n \"stringValue\": \"Trademarks / Law\"\n },\n {\n \"id\": \"430\",\n \"name\": \"Water supply\",\n \"stringValue\": \"Water supply\"\n },\n {\n \"id\": \"440\",\n \"name\": \"Wholesale\",\n \"stringValue\": \"Wholesale\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20NatureOfBusiness\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"0c14d466-a6e1-4fd9-8719-e1670da413cc","name":"200 Purpose of Transactions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=PurposeOfTransaction","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"PurposeOfTransaction"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.5","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Access-Control-Allow-Origin","value":"https://www.cambridgelink.com","enabled":true},{"key":"Date","value":"Wed, 24 Aug 2022 20:05:19 GMT","enabled":true},{"key":"Content-Length","value":"1375","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"purposeOfTransactionList\": [\n {\n \"id\": \"0\",\n \"name\": \"Undefined\",\n \"stringValue\": \"Undefined\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Purchase_Sale_Of_A_Good\",\n \"stringValue\": \"Purchase/Sale of a good(s)\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Sale_Service\",\n \"stringValue\": \"Purchase/Sale of a service(s)\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Fee_Payment\",\n \"stringValue\": \"Professional fees payment (e.g. legal, accountant)\"\n },\n {\n \"id\": \"4\",\n \"name\": \"Payroll_Personnel\",\n \"stringValue\": \"Payroll/personnel payment\"\n },\n {\n \"id\": \"5\",\n \"name\": \"Bill_Payment\",\n \"stringValue\": \"Bill payment\"\n },\n {\n \"id\": \"6\",\n \"name\": \"Resear_Development\",\n \"stringValue\": \"Research and Development\"\n },\n {\n \"id\": \"7\",\n \"name\": \"Business_Venture\",\n \"stringValue\": \"Business venture (e.g. merger, acquisition)\"\n },\n {\n \"id\": \"8\",\n \"name\": \"Intercompany_Payment\",\n \"stringValue\": \"Intercompany payment\"\n },\n {\n \"id\": \"9\",\n \"name\": \"Charitable_Payment\",\n \"stringValue\": \"Charitable and humanitarian related payment\"\n },\n {\n \"id\": \"10\",\n \"name\": \"Real_Estate\",\n \"stringValue\": \"Purchase/Sale of property/real estate\"\n },\n {\n \"id\": \"11\",\n \"name\": \"Government_Payment\",\n \"stringValue\": \"Government related payment (e.g. income tax return)\"\n },\n {\n \"id\": \"12\",\n \"name\": \"Investment_Payment\",\n \"stringValue\": \"Investment related payment\"\n },\n {\n \"id\": \"13\",\n \"name\": \"Other\",\n \"stringValue\": \"Other (please be specific)\"\n },\n {\n \"id\": \"14\",\n \"name\": \"Charity_Donation\",\n \"stringValue\": \"Charity donation\"\n },\n {\n \"id\": \"15\",\n \"name\": \"Divident_Payments\",\n \"stringValue\": \"Dividend payments\"\n },\n {\n \"id\": \"16\",\n \"name\": \"Intercompany_Transfers\",\n \"stringValue\": \"Intercompany transfers\"\n },\n {\n \"id\": \"17\",\n \"name\": \"Investment\",\n \"stringValue\": \"Investment\"\n },\n {\n \"id\": \"18\",\n \"name\": \"Payment_Invoices\",\n \"stringValue\": \"Payment invoices\"\n },\n {\n \"id\": \"19\",\n \"name\": \"Payroll\",\n \"stringValue\": \"Payroll\"\n },\n {\n \"id\": \"20\",\n \"name\": \"Repatriating_Overseas\",\n \"stringValue\": \"Repatriating overseas\"\n },\n {\n \"id\": \"21\",\n \"name\": \"Supplier_Payments\",\n \"stringValue\": \"Supplier payments\"\n },\n {\n \"id\": \"22\",\n \"name\": \"Emigration\",\n \"stringValue\": \"Emigration\"\n },\n {\n \"id\": \"23\",\n \"name\": \"Gift\",\n \"stringValue\": \"Gift\"\n },\n {\n \"id\": \"24\",\n \"name\": \"Inheritance\",\n \"stringValue\": \"Inheritance\"\n },\n {\n \"id\": \"25\",\n \"name\": \"Medical_Expenses\",\n \"stringValue\": \"Medical expenses\"\n },\n {\n \"id\": \"26\",\n \"name\": \"Mortgage_Rental\",\n \"stringValue\": \"Mortgage/Rental Payments\"\n },\n {\n \"id\": \"27\",\n \"name\": \"Overseas_Investment\",\n \"stringValue\": \"Overseas investment\"\n },\n {\n \"id\": \"28\",\n \"name\": \"Overseas_Living\",\n \"stringValue\": \"Overseas living expenses\"\n },\n {\n \"id\": \"29\",\n \"name\": \"Paying_Bills_Overseas\",\n \"stringValue\": \"Paying bills overseas\"\n },\n {\n \"id\": \"30\",\n \"name\": \"Payments_Family_Friends\",\n \"stringValue\": \"Payments to family & Friends\"\n },\n {\n \"id\": \"31\",\n \"name\": \"Pension\",\n \"stringValue\": \"Pension\"\n },\n {\n \"id\": \"32\",\n \"name\": \"Property_Development\",\n \"stringValue\": \"Property Development\"\n },\n {\n \"id\": \"33\",\n \"name\": \"Property_Maintenance\",\n \"stringValue\": \"Property Maintenance\"\n },\n {\n \"id\": \"34\",\n \"name\": \"Property_Purchase\",\n \"stringValue\": \"Property Purchase\"\n },\n {\n \"id\": \"35\",\n \"name\": \"PropertyRental_FeeIncome\",\n \"stringValue\": \"Property Rental/Fee income\"\n },\n {\n \"id\": \"36\",\n \"name\": \"Property_Sale\",\n \"stringValue\": \"Property sale\"\n },\n {\n \"id\": \"37\",\n \"name\": \"Repatriating_Overseas_Earnings\",\n \"stringValue\": \"Repatriating overseas earnings\"\n },\n {\n \"id\": \"38\",\n \"name\": \"Salary\",\n \"stringValue\": \"Salary\"\n },\n {\n \"id\": \"39\",\n \"name\": \"Transfer_Living\",\n \"stringValue\": \"Transfer of living expenses\"\n },\n {\n \"id\": \"40\",\n \"name\": \"Transfer_Family_Friend\",\n \"stringValue\": \"Transfer to family or friend\"\n },\n {\n \"id\": \"41\",\n \"name\": \"Transfer_Own_Account\",\n \"stringValue\": \"Transfer to own account\"\n },\n {\n \"id\": \"42\",\n \"name\": \"Tuition_Fees\",\n \"stringValue\": \"Tuition fees\"\n },\n {\n \"id\": \"43\",\n \"name\": \"Vehicle_Boat\",\n \"stringValue\": \"Vehicle or boat purchase\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20PurposeOfTransaction\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"b6f02a06-6ac9-416a-8588-8c974931ce73","name":"200 Routing","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=Routing","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"Routing"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": {\r\n \"routing\": [\r\n {\r\n \"id\": \"0\",\r\n \"name\": \"Undefined\",\r\n \"stringValue\": \"Undefined\"\r\n },\r\n {\r\n \"id\": \"1\",\r\n \"name\": \"Transit\",\r\n \"stringValue\": \"Transit\"\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"name\": \"ABA\",\r\n \"stringValue\": \"ABA\"\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"name\": \"Fedwire\",\r\n \"stringValue\": \"Fedwire\"\r\n },\r\n {\r\n \"id\": \"4\",\r\n \"name\": \"SortCode\",\r\n \"stringValue\": \"Sort Code\"\r\n },\r\n {\r\n \"id\": \"5\",\r\n \"name\": \"BSBNumber\",\r\n \"stringValue\": \"BSB Number\"\r\n }\r\n ]\r\n },\r\n \"errors\": [],\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20Routing\",\r\n \"method\": \"GET\"\r\n }\r\n ]\r\n}"},{"id":"cf31c0fd-d911-4e67-a2d4-bffd0cde55f1","name":"200 Settlement Method","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=SettlementMethod","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"SettlementMethod"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"settlementMethod\": [\n {\n \"id\": \"0\",\n \"name\": \"Undefined\",\n \"stringValue\": \"Undefined\"\n },\n {\n \"id\": \"1\",\n \"name\": \"ACH\",\n \"stringValue\": \"ACH\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Debit\",\n \"stringValue\": \"Debit\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Wire\",\n \"stringValue\": \"Wire\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SettlementMethod\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"c35dfe57-f6d8-4dbf-8795-c42c19de1f47","name":"200 Source Of Funds","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=SourceOfFunds","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"SourceOfFunds"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": {\r\n \"sourceOfFunds\": [\r\n {\r\n \"id\": \"0\",\r\n \"name\": \"Undefined\",\r\n \"stringValue\": \"Undefined\"\r\n },\r\n {\r\n \"id\": \"1\",\r\n \"name\": \"BusinessOperations\",\r\n \"stringValue\": \"Business Operations\"\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"name\": \"FromShareholders\",\r\n \"stringValue\": \"From Shareholders\"\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"name\": \"InvestmentProceeds\",\r\n \"stringValue\": \"Investment Proceeds\"\r\n },\r\n {\r\n \"id\": \"4\",\r\n \"name\": \"Others\",\r\n \"stringValue\": \"Others, please specify\"\r\n }\r\n ]\r\n },\r\n \"errors\": [],\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SourceOfFunds\",\r\n \"method\": \"GET\"\r\n }\r\n ]\r\n}"},{"id":"c80d8db2-9659-47e9-8def-56b0fa24e310","name":"200 Source Of Wealth","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=sourceOfWealth","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"sourceOfFunds","disabled":true},{"key":"pickListType","value":"sourceOfWealth","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"content\": {\r\n \"sourceOfWealth\": [\r\n {\r\n \"id\": \"0\",\r\n \"name\": \"Undefined\",\r\n \"stringValue\": \"Undefined\"\r\n },\r\n {\r\n \"id\": \"1\",\r\n \"name\": \"AccumulatedBusinessEarnings\",\r\n \"stringValue\": \"Accumulated Business Earnings\"\r\n },\r\n {\r\n \"id\": \"2\",\r\n \"name\": \"FromShareholders\",\r\n \"stringValue\": \"From Shareholders\"\r\n },\r\n {\r\n \"id\": \"3\",\r\n \"name\": \"InvestmentPortfolio\",\r\n \"stringValue\": \"Investment Portfolio\"\r\n },\r\n {\r\n \"id\": \"4\",\r\n \"name\": \"Others\",\r\n \"stringValue\": \"Others, please specify\"\r\n }\r\n ]\r\n },\r\n \"errors\": [],\r\n \"links\": [\r\n {\r\n \"rel\": \"self\",\r\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20SourceOfWealth\",\r\n \"method\": \"GET\"\r\n }\r\n ]\r\n}"},{"id":"c1cb804d-0303-4155-b8d1-f1e642ac1b06","name":"200 Total Assets or Net Worth","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=TotalAssetsOrNetWorth","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"ApplicantType","type":"text","disabled":true},{"key":"pickListType","value":"BusinessType","type":"text","disabled":true},{"key":"pickListType","value":"PurposeOfTransaction","type":"text","disabled":true},{"key":"pickListType","value":"TradeVolumeRange","type":"text","disabled":true},{"key":"pickListType","value":"TotalAssetsOrNetWorth"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"totalAssetsOrNetWorth\": [\n {\n \"id\": \"0\",\n \"name\": \"Undefined\",\n \"stringValue\": \"Undefined\"\n },\n {\n \"id\": \"1\",\n \"name\": \"OneToOneMillion\",\n \"stringValue\": \"$1 to $1,000,000\"\n },\n {\n \"id\": \"2\",\n \"name\": \"OneMillionOneToTenMillion\",\n \"stringValue\": \"$1,000,001 to $10,000,000\"\n },\n {\n \"id\": \"3\",\n \"name\": \"TenMillionOneToFiftyMillion\",\n \"stringValue\": \"$10,000,001 to $50,000,000\"\n },\n {\n \"id\": \"4\",\n \"name\": \"FiftyMillionOneToOneHundredMillion\",\n \"stringValue\": \"$50,000,001 to $100,000,000\"\n },\n {\n \"id\": \"5\",\n \"name\": \"OtherEstimatedAmount\",\n \"stringValue\": \"Other estimated amount, please specify\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20TotalAssetsorNetWorth\",\n \"method\": \"GET\"\n }\n ]\n}"},{"id":"e01ae8f1-63b7-4c06-aeb6-811d6b508833","name":"200 Trade Volume Range","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CMG-AccessToken","value":"{insert Partner-level \"access_code\"}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/api/clientonboarding/onboardingpicklists?pickListType=TradeVolumeRange","path":["api","clientonboarding","onboardingpicklists"],"query":[{"key":"pickListType","value":"TradeVolumeRange"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","enabled":true},{"key":"Pragma","value":"no-cache","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Expires","value":"-1","enabled":true},{"key":"Server","value":"Microsoft-IIS/8.5","enabled":true},{"key":"X-AspNet-Version","value":"4.0.30319","enabled":true},{"key":"X-Powered-By","value":"ASP.NET","enabled":true},{"key":"Access-Control-Allow-Origin","value":"https://www.cambridgelink.com","enabled":true},{"key":"Date","value":"Wed, 24 Aug 2022 20:05:51 GMT","enabled":true},{"key":"Content-Length","value":"1202","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"tradeVolumeRangeList\": [\n {\n \"id\": \"1\",\n \"name\": \"LessThan5000\",\n \"stringValue\": \"less than 5000\"\n },\n {\n \"id\": \"2\",\n \"name\": \"FiveThousandToTenThousand\",\n \"stringValue\": \"5,000 – 10,000\"\n },\n {\n \"id\": \"3\",\n \"name\": \"TenToTwentyFiveThousand\",\n \"stringValue\": \"10,000 – 25,000\"\n },\n {\n \"id\": \"4\",\n \"name\": \"TwentyFiveToFiftyThousand\",\n \"stringValue\": \"25,000 – 50,000\"\n },\n {\n \"id\": \"5\",\n \"name\": \"FiftyToOneHundredThousand\",\n \"stringValue\": \"50,000 – 100,000\"\n },\n {\n \"id\": \"6\",\n \"name\": \"OneHundredToOneHundredFiftyThousand\",\n \"stringValue\": \"100,000 – 150,000\"\n },\n {\n \"id\": \"7\",\n \"name\": \"OneHundredFiftyToTwoHundredFiftyThousand\",\n \"stringValue\": \"150,000 – 250,000\"\n },\n {\n \"id\": \"8\",\n \"name\": \"TwoHundredFiftyToFiveHundredThousand\",\n \"stringValue\": \"250,000 – 500,000\"\n },\n {\n \"id\": \"9\",\n \"name\": \"FiveHundredToSevenHundredFiftyThousand\",\n \"stringValue\": \"500,000 – 750,000\"\n },\n {\n \"id\": \"10\",\n \"name\": \"SevenHundredFiftyThousandToOneMillion\",\n \"stringValue\": \"750,000 – 1 million\"\n },\n {\n \"id\": \"11\",\n \"name\": \"GreaterThanOneMillion\",\n \"stringValue\": \"greater than 1 Mil\"\n }\n ]\n },\n \"errors\": [],\n \"links\": [\n {\n \"rel\": \"self\",\n \"uri\": \"https://crossborder.corpay.com/api/clientonboarding/onboardingpicklists?pickListType=%20TradeVolumeRange\",\n \"method\": \"GET\"\n }\n ]\n}"}],"_postman_id":"1655c1ed-d585-487d-ba7f-ffda488976d5"}],"id":"31ebfed5-289e-4284-8ff6-4b6bf3eb0ef2","description":"This folder defines picklist values used across Client Onboarding APIs. These values help ensure consistency and accuracy when creating or updating onboarding requests.
\nThe onboardingpicklist endpoint is updated periodically to reflect changes in Corpay's business rules and regulatory requirements. We may add new values or modify existing ones as required. Please refer to our API release notes to stay informed of changes.
The client onboarding API allows our integrated partners to expedite the onboarding process of their downstream clients. Partners submit the client onboarding data, upload the required verification documents, and generate the auth key to allow their client access to Corpay's API suite.
\n","_postman_id":"f7f89960-e0e2-4030-a402-1b57bd881023"},{"name":"Webhooks","item":[{"name":"Subscribe to Webhooks","item":[],"id":"b0baf21a-f3a4-41ef-ab67-d1fd7770198a","description":"Set up a publicly accessible HTTPS URL on your server.
\nEnsure it returns a 2xx HTTP status code to acknowledge receipt.
Specify the events you want to subscribe to.
\nFor the full list of events, refer to the supported events section or contact your account representative.
\nFor BETA testing, HTTP URLs are allowed.
\nFor Production, HTTPS is mandatory.
\nOnce verified, enable your public HTTPS URL webhook endpoint in production.
\nRegister your URL with Corpay. Any updates to the registered URL must be informed to your account representative to continue receiving notifications.
\nNote: Always test your webhook in the Beta environment before enabling it in production to ensure it correctly handles notifications.
\n","_postman_id":"b0baf21a-f3a4-41ef-ab67-d1fd7770198a"},{"name":"Receive Webhook Notifications","item":[],"id":"0ea73d9e-8960-45db-8516-70c883807cdb","description":"Your server must respond with a 2xx HTTP status code.
If Corpay does not get a 2xx response, it will be logged as an error, and the system will attempt a retry, according to the retry logic described below.
Webhooks can fail if your endpoint is unavailable, returns an error response, or takes too long to respond. If webhook notifications repeatedly fail:
\nCorpay will retry for up to 24 hours using exponential backoff (instead of retrying immediately, the system waits longer between retries).
\nIf all retries fail within 24 hours, the webhook is automatically disabled. To reactivate the notifications, please contact your account representative.
\nIf you're not receiving notifications, check for:
\nEndpoint not publicly accessible
\nNon-2xx HTTP responses
\nSlow response times causing timeouts
\nIncorrect event subscriptions
\nSignature validation failure
\nNotifications may be manually disabled by your account representative
\nNote: Contact your account representative to manage subscriptions or reactivate disabled webhooks.
\n","_postman_id":"983b430c-c6ef-4e6e-be43-0806fcce9f6e"},{"name":"Supported Events","item":[{"name":"Payment","item":[{"name":"Payment webhook notification","id":"94b16749-e7fd-4c14-942f-707647bfef7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://sandbox.webhook","description":"Payment event notifications sent to the registered webhook endpoint URL.
\n","urlObject":{"protocol":"https","host":["sandbox","webhook"],"query":[],"variable":[]}},"response":[{"id":"edb3ea6b-266e-40f5-b823-70a5fdc6477e","name":"PaymentAccepted","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Connection","value":"close","enabled":true},{"key":"Accept-Encoding","value":"gzip, deflate","enabled":true},{"key":"Host","value":"partner.webhook.site","enabled":true},{"key":"User-Agent","value":"RestSharp/106.13.0.0","enabled":true},{"key":"Accept","value":"application/json, text/json, text/x-json, text/javascript, application/xml, text/xml","enabled":true},{"key":"Corpay-Signature","value":"t=1680188699,v1=b3682384dad15fd28bfa150cd3fd43c99f8f7060","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"","value":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"EventType\": \"PaymentAccepted\",\r\n\t\"CreatedDate\": \"2023-03-30T11:04:59.846784-04:00\",\r\n\t\"ClientCode\": \"{clientCode}\",\r\n\t\"Id\": \"{clientCode}-P5MBEP\",\r\n\t\"MessageId\": \"d2fa6482-c4c3-4a7a-9957-73ca1931143d\"\r\n}"},{"id":"11da6d37-917e-49e6-abae-d9eaf9e573ce","name":"PaymentCancelled","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"EventType\": \"PaymentCancelled\",\n \"CreatedDate\": \"2026-03-12T14:23:27.5540463-04:00\",\n \"ClientCode\": \"{clientCode}\",\n \"Id\": \"{clientCode}-EVVD2X\",\n \"MessageId\": \"9df69871-78f5-47f6-900d-bb0962b5652e\"\n}"},{"id":"da42da22-6b0f-45c6-88d8-f6d10c2d37d6","name":"PaymentCancelledByClient","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"EventType\": \"PaymentCancelledByClient\",\n \"CreatedDate\": \"2026-03-09T16:11:20.0625667-04:00\",\n \"ClientCode\": \"{clientCode}\",\n \"Id\": \"{clientCode}-O8S69L\",\n \"MessageId\": \"b6e515d0-1043-4101-bd96-b34ebeb2b8f9\"\n}"},{"id":"272c53bd-4e42-41d8-b9e1-256570eca04e","name":"PaymentReturned","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"EventType\": \"PaymentReturned\",\n \"CreatedDate\": \"2026-03-12T15:31:38.3047405-04:00\",\n \"ClientCode\": \"{clientCode}\",\n \"Id\": \"{clientCode}-QHZOCX\",\n \"MessageId\": \"e089d669-02d5-4fc3-87aa-e4def08c74cf\"\n}"},{"id":"9d4a31b9-065b-4d6f-aaf1-7a0990bf84f2","name":"PaymentProcessed","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Connection","value":"close","enabled":true},{"key":"Accept-Encoding","value":"gzip, deflate","enabled":true},{"key":"Host","value":"partner.webhook.site","enabled":true},{"key":"User-Agent","value":"RestSharp/106.13.0.0","enabled":true},{"key":"Accept","value":"application/json, text/json, text/x-json, text/javascript, application/xml, text/xml","enabled":true},{"key":"Corpay-Signature","value":"t=1680192080,v1=8dd6434ab8d1efe8c04f2854f856eac5780d7dfc","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"","value":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"EventType\": \"PaymentProcessed\",\r\n\t\"CreatedDate\": \"2023-03-30T12:01:20.9526609-04:00\",\r\n\t\"ClientCode\": \"{clientCode}\",\r\n\t\"Id\": \"{clientCode}-P5MBEP\",\r\n\t\"MessageId\": \"4c3319ea-9986-4140-bcd4-c397a17bc669\"\r\n}"},{"id":"7150acbc-eb2b-4332-9848-6518ce6b67c4","name":"PaymentTrackingInfoReceived","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Connection","value":"close","enabled":true},{"key":"Accept-Encoding","value":"gzip, deflate","enabled":true},{"key":"Host","value":"partner.webhook.site","enabled":true},{"key":"User-Agent","value":"RestSharp/106.13.0.0","enabled":true},{"key":"Accept","value":"application/json, text/json, text/x-json, text/javascript, application/xml, text/xml","enabled":true},{"key":"Corpay-Signature","value":"t=1680206493,v1=4fcf4d51b49bd9d435880517ffd2fc15cd7a4469","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"","value":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"EventType\": \"PaymentTrackingInfoReceived\",\r\n\t\"CreatedDate\": \"2023-03-30T16:01:33.717+00:00\",\r\n\t\"ClientCode\": \"{clientCode}\",\r\n\t\"Id\": \"{clientCode}-P5MBEP\",\r\n\t\"MessageId\": \"e2cf798a-7ac6-4139-a4fb-de36fd4db859\"\r\n}"},{"id":"59d30f79-2de4-4919-bd02-18308252bb3c","name":"PaymentProcessedNonSwift","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"EventType\": \"PaymentProcessedNonSwift\",\n \"CreatedDate\": \"2023-06-28T11:28:51.2319516-04:00\",\n \"ClientCode\": \"{clientCode}\",\n \"Id\": \"{clientCode}-EHYACM\",\n \"MessageId\": \"3fa2b098-036c-43fd-affb-37df4e490cac\"\n}"}],"_postman_id":"94b16749-e7fd-4c14-942f-707647bfef7a"}],"id":"e5703a98-504a-43f3-96dd-8319fe8d0a36","description":"Corpay sends push notifications for the following payment events:
\nExample payment event
\n{\n \"EventType\": \"PaymentAccepted\",\n \"CreatedDate\": \"2023-03-27T10:07:01.7284746-04:00\",\n \"ClientCode\": \"{clientCode}\",\n \"Id\": \"{clientCode}-TKW7AY\",\n \"MessageId\": \"72bcfbf7-1c72-44f4-b991-8eb6f110ac8d\"\n}\n\nResponse Body
\nYou can also send a request to /api/payment-tracking/{trackerId} to trace the detailed information of your payment transaction.
\n","_postman_id":"e5703a98-504a-43f3-96dd-8319fe8d0a36"},{"name":"Client Onboarding","item":[{"name":"Client Onboarding webhook notification","id":"fbbb7313-c915-477d-adfa-e16649b0b444","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://sandbox.webhook","description":"Client onboarding event notifications sent to the registered webhook endpoint URL.
\n","urlObject":{"protocol":"https","host":["sandbox","webhook"],"query":[],"variable":[]}},"response":[{"id":"e2304685-a63c-4973-81a0-92fc5e88d3e9","name":"AccountApproved","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"status":"OK","code":200,"_postman_previewlanguage":"JSON","header":[{"key":"Connection","value":"close","enabled":true},{"key":"Accept-Encoding","value":"gzip, deflate","enabled":true},{"key":"Host","value":"partner.webhook.site","enabled":true},{"key":"User-Agent","value":"RestSharp/106.13.0.0","enabled":true},{"key":"Accept","value":"application/json, text/json, text/x-json, text/javascript, application/xml, text/xml","enabled":true},{"key":"Corpay-Signature","value":"t=1687975608,v1=fe18c01048a488b20a8c2ba5f954f1e12525ea34","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"","value":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\r\n \"EventType\": \"AccountApproved\",\r\n \"CreatedDate\": \"2023-06-28T14:06:07.1204513-04:00\",\r\n \"ClientCode\": \"{clientCode}\",\r\n \"Id\": \"b3f4082365bb97be3a192d0f50ab45c6\",\r\n \"MessageId\": \"2d552e33-b598-405b-ae9f-7f092e90164d\"\r\n}"}],"_postman_id":"fbbb7313-c915-477d-adfa-e16649b0b444"}],"id":"84cbbfc1-55f4-4fe4-9626-fb633f32ac1e","description":"Corpay sends push notifications for the following onboarding event:
\nExample onboarding event
\n{\n \"EventType\": \"AccountApproved\",\n \"CreatedDate\": \"2023-06-28T14:06:07.1204513-04:00\",\n \"ClientCode\": \"{clientCode}\",\n \"Id\": \"b3f4082365bb97be3a192d0f50ab45c6\",\n \"MessageId\": \"2d552e33-b598-405b-ae9f-7f092e90164d\"\n}\n\nResponse Body
\n","_postman_id":"84cbbfc1-55f4-4fe4-9626-fb633f32ac1e"},{"name":"Incoming Funds","item":[{"name":"Incoming funds webhook notification","id":"fb779e8a-cd58-4f13-82ee-4e3d25817a71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://sandbox.webhook","description":"Incoming funds event notifications sent to the registered webhook endpoint URL.
\n","urlObject":{"protocol":"https","host":["sandbox","webhook"],"query":[],"variable":[]}},"response":[{"id":"331cabe3-1290-4ed7-8b3f-e62f44e7dc2a","name":"Incoming funds credited","originalRequest":{"method":"POST","header":[],"url":"https://sandbox.webhook"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n\t\"EventType\": \"IncomingFundsCredited\",\r\n\t\"CreatedDate\": \"2025-05-22T10:48:14.3630453-04:00\",\r\n\t\"ClientCode\": \"{clientCode}\",\r\n\t\"Id\": \"{ordNum}\",\r\n\t\"MessageId\": \"5e97ad66-cae9-4242-85e3-28de9e04db1c\"\r\n}"}],"_postman_id":"fb779e8a-cd58-4f13-82ee-4e3d25817a71"}],"id":"fd824b9c-5988-4c90-86d3-28356bf8afc8","description":"Corpay sends incoming funds notifications for the following events:
\nYou can also send a request to GET: incoming-funds/{ordNum} to trace detailed information of your incoming funds.
\n{\n \"EventType\": \"IncomingFundsCredited\",\n \"CreatedDate\": \"2025-05-22T10:48:14.3630453-04:00\",\n \"ClientCode\": \"{clientCode}\",\n \"Id\": \"296559XX\",\n \"MessageId\": \"5e97ad66-cae9-4242-85e3-28de9e04db1c\"\n}\n\nResponse Body
\n","_postman_id":"fd824b9c-5988-4c90-86d3-28356bf8afc8"},{"name":"Exceptions","item":[{"name":"Payment on Hold event notification","id":"a812e976-0124-4d8a-88b5-b7efd42472ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://sandbox.webhook","description":"Exception event notification sent to the registered webhook endpoint URL.
\n","urlObject":{"protocol":"https","host":["sandbox","webhook"],"query":[],"variable":[]}},"response":[{"id":"e644f0e8-1af8-4e02-8ea4-0cb8a352eac5","name":"Payment on Hold","originalRequest":{"method":"POST","header":[],"url":"webhookexample.com"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"EventType\": \"PaymentOnHold\",\r\n \"CreatedDate\": \"2025-06-23T02:22:38-04:00\",\r\n \"ClientCode\": \"{clientCode}\",\r\n \"Id\": \"{TrackerID}\",\r\n \"MessageId\": \"43873d5f-b401-4388-8e33-0da113fe25ee\"\r\n}"}],"_postman_id":"a812e976-0124-4d8a-88b5-b7efd42472ca"}],"id":"c47492c5-61fd-4d38-8088-28cfa5762d92","description":"Corpay sends notifications for the following exception event:
\n{\n \"EventType\": \"PaymentOnHold\",\n \"CreatedDate\": \"2025-05-22T10:48:14.3630453-04:00\",\n \"ClientCode\": \"{clientCode}\",\n \"Id\": \"{TrackerId}\",\n \"MessageId\": \"5e97ad66-cae9-4242-85e3-28de9e04db1c\"\n}\n\nResponse Body
\n","_postman_id":"c47492c5-61fd-4d38-8088-28cfa5762d92"}],"id":"5b816dc5-6963-4ef5-93fe-690b592758d2","description":"Corpay sends webhook notifications for the following events:
\nNote: You can currently subscribe to events that have an Active status.
\n","_postman_id":"5b816dc5-6963-4ef5-93fe-690b592758d2"}],"id":"420918fd-2014-430a-b7ed-95137afd4c5c","description":"Webhooks let you subscribe to events and receive real-time notifications when those specific events occur. (For example, payment processed, funds received into your account, or a client onboarded). Instead of polling the API for updates, webhooks push data to your endpoint as soon as the event happens, improving efficiency and reducing unnecessary API calls.
\nReceive real-time updates
\nReduce API traffic and server load
\nSync the data as it changes
\nEnsure timely and reliable updates
\nProvide a public, secure URL where your system can receive webhook notifications.
\nSubscribe to events you want to receive (e.g., payment processed, client onboarded, etc.).
\nAn event you've subscribed to occurs in the Corpay system.
\nCorpay sends an HTTP POST request with the event details to your registered webhook URL.
\nUse the received webhook notifications to monitor specific events and sync the updates.
\nUse REST APIs when you need to query data on demand.
\nUse Webhooks when you need to be notified immediately when an event occurs to avoid constant polling.
\nTo ensure secure communication, each webhook request includes a digital Corpay-Signature in the Header. You can use this signature to authenticate the payload and prevent man-in-the-middle (MITM) attacks.
\nThe header includes a Unix timestamp with an encrypted key in SHA1 cryptographic hash format, created using HMAC.
\nYou can verify the authenticity of the notification by decrypting this header with HMAC to confirm if it matches the key.
\n