{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d57567de-6952-4dac-b076-6cb2783028cb","name":"Corpay Cross-Border API Payments API 2.0","description":"Payments V2.0 is the newest API suite offered by Corpay that enables businesses to have an easy access to foreign exchange and domestic payment capabilities. The API suite offers spot and forward capabilities for FX transactions, as well as robust data services around beneficiary creation process. All together it provides simple and standardized access to 145+ currencies with 110 in country delivery channels.\n\n# Common Terms\n\n<ul><li><div>Partner - entity governing one or more client accounts</div></li><li><div>Client – unique entity. All information that pertains to beneficiaries and transactions resides under one client and is not shared between client accounts even under one partner</div></li><li><div>Client Code - unique 6-digit client identifier for each client account. Used in all endpoints as part of URL.</div></li><li><div>Beneficiary – bene – recipient of funds</div></li><li><div>Remitter – the initiator of funds when different from the client</div></li><li><div>Payment - outgoing cashflow to a beneficiary</div></li><li><div>Settlement - Incoming cashflow to Corpay.</div></li><li><div>Order – an object that must contain rate, payment and settlement information and with balanced amount to be considered complete. These elements do not have to be created or provided simultaneously, payment and settlement info can be provide with a time delay (less than 24H)</div></li><li><div>Instructed deal – deal with payments and settlements balanced and fully accounted for</div></li><li><div>Uninstructed deal – deal with payments and settlements not yet present or balanced</div></li></ul>\n\n# Base URL\n\nThe documentation for each endpoint displays the HTTP method and the end path. Before you submit the request, you need to prepend the base path to get the full resource URL. All endpoints referenced in the documentation require the following base path:\n\nsandbox env -[https://cambridgefx-payments-eapi-qa.ca-ce1-ch2-d-000.api.fleetcor.com/](https://cambridgefx-payments-eapi-qa.ca-ce1-ch2-d-000.api.fleetcor.com/)\n\nproduction env - [https://cambridgefx-payments-eapi.api.fleetcor.com/api](https://cambridgefx-payments-eapi.api.fleetcor.com/api)\n\n**Note:** This base path will not be the same for the sandbox and production.\n\nColons are used as a placeholder and indicate the type of value that you need to supply. For instance, where you see :clientCode in the resource, you need to replace that string with your client code.\n\nFor example, in the documentation, endpoints look like to this:\n\n`partner/:partnerId/:clientCode/forwards/:forwardID`\n\nWhen you add the base path, your client code, and any parameters, the result is a well-formed REST URL that looks something like this:\n\n`partner/XAPIPrt/252397/forwards/2134`\n\n# Swagger Documentation\n\nYou can access and try out the endpoints by visiting the swagger docs\n\n<a href=\"https://app.swaggerhub.com/apis-docs/Cambridgefx/cambridge-fx_payments/1.0.0\">here</a>\n\n# API Status Check\n\nRealtime health of the API can be found on the status page\n\n<a href=\"http://status.cambridgefx.com/\">here</a>\n\nThe specific API product these docs relate to on the status page are Corpay Cross-Border for production environment and Beta for the sandbox environment.\n\n# Response Codes\n\nMost of the endpoints include examples for both successful and unsuccessful responses. In the Example Request, click the downward arrow beside the response code to view additional examples.\n\nCorpay uses conventional HTTP response codes to indicate the success or failure of an API request.\n\n<table><tbody><tr><th>Response Code</th><th>Description</th></tr><tr><td><div>2<i>xx</i></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Success.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>4<i>xx</i></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div><p>Client error. This is usually due to missing or incorrect information, for example, a missing or incorrect parameter or value.</p><ul><li><div>401 - Authorization issue. This usually means that the authorization token has expired and you need to refresh it.</div></li><li><div>410 - Rate resource expired. Due to currency fluctuations, quotes are valid for a very limited period of time. When you get a 410 error, it means that the rate resource you're trying to use has expired and you need to generate a new quote.</div></li><ul></ul></ul></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>5<i>xx</i></div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td><td><div>Server error. If the error persists, contact Corpay Tier 2 support.</div><div contenteditable=\"false\"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n# API Keys\n\nThe API keys will be provided by the team at Corpay, for any inquiries or support please contact: [paymentsAPI@cambridgefx.com](https://mailto:paymentsAPI@cambridgefx.com)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5203630","collectionId":"d57567de-6952-4dac-b076-6cb2783028cb","publishedId":"UVR4PAbZ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/5203630/UVR4PAbZ","privateUrl":"https://go.postman.co/documentation/5203630-d57567de-6952-4dac-b076-6cb2783028cb","customColor":{"top-bar":"3D1628","right-sidebar":"3D1628","highlight":"981239"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2021-12-10T21:55:53.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UVR4PAbZ"}