![\"On-Board-A-Client-pre-reqs.jpg\"](\"https://user-images.githubusercontent.com/72567787/98576748-e5365b80-22b2-11eb-84ed-53454005ddf7.JPG\")
The Corpay Cross-Border API is designed for businesses that want to connect their existing software or ERP infrastructure to Corpay's extensive range of international payment, risk management and FX services. By accessing Corpay's Payment Engine via our API, it allows our partners to automate their end-to-end payment processes and rapidly deliver direct tailor-made solutions for their business requirements. Payments are sent through Corpay Cross-Border's intermediary banks, payment channels and are bound by applicable laws, regulations, clearing house rules or payment processing procedures.
\nOur API is built by developers for developers making it straightforward to integrate with our systems. Rest assured that all new clients who wish to partner with Corpay and integrate with our API will also be designated their own Technical Sales Consultant to assist throughout the whole integration life-cycle.
\nWe’ve designed our documentation to be easy to use as well as providing a clear insight into Corpay Cross-Border's suite of API services. All of our individual API methods are grouped into feature sets which you can see in the navigation menu here on our API documentation.
\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 in-depth release notes that detail the most recent API enhancements and updates as found on our API Solutions site here!
\nProduction: V03.12.2021 was deployed to our Production environment on December 3rd 2021.
\nNon-Prod: V03.12.2021 was deployed to the Demo environment on December 3rd 2021.
\nTLS version support: Effective June 2018, Corpay no longer supports TLS version 1.0. Corpay currently supports TLS 1.1 and 1.2 in both the demo and production environments.
\nProduction server IP address range: Effective August 2018, the Corpay production servers public IP range was changed to 136.179.35.192/26.
1. Read the documentation
We recommend that you read the API documentation's different feature sets to familiarize yourself with the API conventions and functionality along with exploring the provided examples. A recent addition to our documentation is the inclusion of the Use Case Library to further help you learn how our API functions can be applied to solve for different scenarios and tasks.
2. Use the Demo API
The Demo API is connected to our test infrastructure. It returns real data but executes trades on your demo account and does not execute live transactions.
A unique demo account will be provided to you as part of your engagement and will mirror the configuration needed for your eventual production account.
\nDemo end points are:
\nAFEX API (beneficiaries, trading and payments):
\nVersion 1.0 https://demo.api.afex.com:7890/\nVersion 2.0 https://WebApiDemo.afex.com/\n\nPartner API (account on-boarding):
\nVersion 1.0** https://demo.api.afex.com:7885/\n\n3. Design & Development
Your dedicated Integrated Solutions Program Manager will assist with defining the optimum technical design based on your unique requirements.
Corpay Cross-Border's PartnerAPI services enable you to on-board your own clients with Corpay which in turn grants them access to Corpay's DirectAPI payment functions. The PartnerAPI allows partners to on-board Corporate clients by passing all pre-agreed KYC/Registration data via our secure Account Create method. The following steps will walk you through on-boarding a new client account with Corpay.
\nIn this use case, a company that provides a corporate currency risk management software needs to onboard a new corporate client in the Freight Forwarding industry onto both their own software and Corpay Cross-Border. Once this client has been on-boarded they will be able to use the risk management software to gain market exposure and hedging advice as well as carry out trades/payments based on the advised hedging strategy.
\nThankfully, this company's software is not only integrated with Corpay's DirectAPI services to power their risk management software's trade and payment capabilities, but it is also integrated with Corpay's PartnerAPI. This means the new Freight corporate client can be seamlessly on-boarded with both the partner company and Corpay at the same time.
\nUsing the software's registration form, the client will populate all of the mandatory on-boarding fields and view the required terms and condition documentation before submitting their Account Create request to both the partner company and Corpay via the PartnerAPI. The on-boarding form will be collecting varied information such as the Corporate client's business address, key contact and director details as well as expected transactional volumes.
\nWith the registration process started, the client will then Add Files to upload supporting on-boarding documentation which may include a Business Registration Certificate, director passport, organisational chart and proof of address. Finally, once all the required information has submitted, the client will use submit Account Find requests to check the status of their account onboarding as well as see what details have been stored on record.
\nLets have a look at the keys steps of this workflow:
This section will now walk you through using the PartnerAPI to implement the workflow.
![\"On-Board-A-Client-Flow.jpg\"](\"https://user-images.githubusercontent.com/72567787/98577007-3a726d00-22b3-11eb-8369-4e2c58e27e79.JPG\")
\n
Step 1: Authenticate
\n
POST api/Token
\ncurl --location --request POST '{{PartnerAPI.Endpoint}}token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'Grant_Type=password' \\\n--data-urlencode 'Username={{API-Key}}' \\\n--data-urlencode 'Password={{PartnerAPI.Password}}'\n200 OK Response
\n{\n\"access_token\": \"LjJo-w2jVd3bpAF- aYq_AGlZlDz9E9vKXpk8yZZHPAti4scXULPAln7jjZUfdwLIF2XtZfsgLksR1wtdVZvyyBcY6f3V1eiy8wUlvksN49FpkDFtDc1bRuJL6ETxbg06UGqktORnNapMU9F-b4CREqyFvgvkBzz2ny5CZvSMwO0utxriKwXNBBVO528thMSR5_XaD7FYRZkwni7tnqpTaLCakoi6X_6lNF9P-v-4yw-im8lzm2ZvIBrw4NeP4Ws8V-KyiX4U5f_nXUSwnrJ-rA\",\n\"token_type\": \"bearer\",\n\"expires_in\": 28799,\n\".issued\": \"Wed, 30 Sep 2020 18:05:19 GMT\",\n\".expires\": \"Thu, 01 Oct 2020 02:05:19 GMT\"\n}\nStep 2: Submit Client On-Boarding Request
\n
Now that the risk management software is authenticated with Corpay's PartnerAPI, you can proceed with filling out the new Freight corporate client's details on the software's registration form. All of the required on-boarding fields displayed on the form are pre-agreed between the partner company of the risk management software and Corpay's Compliance teams. This ensures that all the mandatory data is collected from new clients during registration in order for both the partner and Corpay to successfully on-board and approve them.
The form will be integrated with a number of Corpay supporting PartnerAPI calls providing helpful drop-down options for some of the fields. This includes the API calls listed in the pre-requisites at the start of this use case such as Company Type and NAICS.
Once you have filled out all of the required registration fields with the Freight corporate client's details you will then be able to 'Submit' the on-boarding request using the Account Create API.
\nPOST api/v1/AccountCreate
\ncurl --location --request POST '{{PartnerAPI.Endpoint}}api/v1/AccountCreate' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Authorization: bearer [token]' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"TermsAndConditions\": \"TRUE\",\n\"AccountEntityType\": \"Corporate Client\",\n\"LegalCompanyName\": \"Global Freight Shipping\",\n\"DoingBusinessAs\": \"Global Freight\",\n\"BusinessTelephoneNo\": \"0201 001 001\",\n\"BusinessWebsite\": \"global-freight.co\",\n\"CompanyType\": \"Private Limited Company\",\n\"DescriptionOfBusiness\": \"Freight forwarding shipping services\",\n\"DateOfFormation\": \"06/25/2009\",\n\"CountryOfIncorporation\": \"US\",\n\"StateRegionOfIncorporation\": \"LA\",\n\"FederalTaxId\": \"Business Registration Number\",\n\"CompanyRegistrationNo\": \"333444\",\n\"BusinessCountry\": \"US\",\n\"BusinessAddress\": \"15 Test Street\",\n\"BusinessCity\": \"Louisiana\",\n\"BusinessState\": \"LA\",\n\"BusinessZip\": \"701300\",\n\"NAICS\": \"Deep Sea Freight Transportation\",\n\"TickerSymbol\": \"$\",\n\"Description\": \"Freight forwarding shipping services\",\n\"ExpectedMonthlyPayments\": \"10\",\n\"Expected MonthlyVolume\": \"100000\",\n\"LEINumber\": \"345654\",\n\"LEIExpirationDate\": \"06/05/2030\",\n\"TradingCountries\": [\"US\", \"GB\", \"AU\"],\n\"KeyIndividuals\":[\n{\n\"IndividualRoles\":[\"Owner\"],\n\"PercentOwnership\": \"50\",\n\"Salutation\": \"Mr.\",\n\"FirstName\": \"Richard\",\n\"MiddleName\": \"Henry\",\n\"LastName\": \"Phillips\",\n\"JobTitle\": \"Owner\",\n\"DateOfBirth\": \"04/20/1980\",\n\"Address\": \"45 Test Street\",\n\"City\": \"Louisiana\",\n\"Zip\": \"701310\",\n\"Email\": \"rphillips@noreply.com\",\n\"PhoneNumber\": \"01010 900100\",\n\"SSN\": \"143234\",\n\"IdType\": \"Passport\",\n\"IdNo\": \"155443321\",\n\"IdExpirationDate\": \"06/06/2030\",\n\"IssueJurisdiction\": \"US\",\n\"AccountPrimaryContact\": \"True\",\n\"AFEXDirectUserRole\": \"Input and Approve\",\n\"Citizenship\": \"US\",\n\"State\": \"LA\",\n\"Country\": \"US\"}\n]\n}'\n201 Created Response
\n{\n\"APIKey\": \"00006D15V1398eb29-1a1a-0a0a-2a2a-0050569b0000\",\n\"AccountNumber\": \"00006D15\",\n\"RemitId\": \"00006D15\",\n\"Message\": \"Created\"\n}\nStep 3: Upload Supporting Documents
\n
POST api/v1/AddFiles
\ncurl --location --request POST '{{PartnerAPI.Endpoint}}api/v1/AddFiles?ApiKey=00006D15V1398eb29- \n1a1a-0a0a-2a2a-0050569b0000' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: bearer [token]' \\\n--form '=@/path/to/file'\"Business Registration Certificate - Global Freight\" \\\n--form '=@/path/to/file'\"Organisational Chart - Global Freight Execs\" \\\n--form '=@/path/to/file'\"Richard Phillips Passport\"\n200 OK Response
\n{\n\"3 File(s) Uploaded\"\n}'\nStep 4: Retrieve Client Account Status
\n
GET api/v1/AccountFind
\ncurl --location --request GET '{{PartnerAPI.Endpoint}}api/v1/AccountFind?ApiKey=00006D15V1398eb29- \n1a1a-0a0a-2a2a-0050569b0000' \\\n--header 'Authorization: bearer {token}' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n\"IncludeKeyIndividuals\":\"True\",\n\"ExcluseAccountInfo\":\"False\",\n \"KeyIndividuals\":{\n \"AccountPrimaryContact\":\"\",\n \"IndividualRoles\":\"\",\n \"FirstName\":\"\",\n \"LastName\":\"\"\n }\n}'\n200 OK Response
\n{\n\"AccountEntityType\": \"Corporate Client\",\n\"AccountNumber\": \"00006D15\",\n\"AccountStatus\": \"Approved\"\n}\nCorpay Cross-Border's DirectAPI services allow you to execute an FX trade in order to make an international payment to a beneficiary in their own home currency. The following steps will walk you through creating an overseas beneficiary template, booking an FX trade and scheduling a payment.
In this use case, a user of a Treasury Management System (TMS) needs to pay an overseas supplier in their home currency. The user of the TMS only holds British Pound Sterling (GBP) business funds but the supplier is based in Italy so requires payment in Euro's (EUR). Fortunately the TMS is integrated with Corpay's DirectAPI services.
To initiate the international payment the user, via the TMS, submits a Create Beneficiary request in order to create the Italian supplier as a EUR beneficiary. Once the TMS shows the beneficiary has been created and approved the user initiates a Get Quote request and receives the EURGBP exchange rate. Happy with the rate, the user proceeds to submitting a Create Trade request to convert their GBP into EUR's at the agreed rate. Next, with the trade conversion complete the user schedules a Create Payment request to send the required EUR's to the Italian supplier. Finally, A payment confirmation is retrieved and payment status check completed.
Lets have a look at the keys steps of this workflow:
![\"Beneficiary-with-FX-Payment-Overview.jpg\"](\"https://user-images.githubusercontent.com/72567787/98577124-67268480-22b3-11eb-86fb-2db3254f62c5.JPG\")
This section will now walk you through using the DirectAPI to implement the workflow.
![\"Use-Case-Pre-Reqs-Bene-FX-Payment.jpg\"](\"https://user-images.githubusercontent.com/72567787/98577216-89200700-22b3-11eb-9f3c-7620ba0aaca9.JPG\")
Step 1: Create The Beneficiary
\n
\n![\"Step-1-Create-Beneficiary.jpg\"](\"https://user-images.githubusercontent.com/72567787/98577297-a654d580-22b3-11eb-872b-a0b6fe593e59.JPG\")
POST api/BeneficiaryCreate
\ncurl --location --request POST '{{AFEXAPI.Endpoint}}api/beneficiaryCreate' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"BankAccountNumber\": \"\",\n \"BankCountryCode\": \"IT\",\n \"BankName\": \"\",\n \"BankSWIFTBIC\": \"\",\n \"BeneficiaryAddressLine1\": \"\",\n \"BeneficiaryCity\": \"\",\n \"BeneficiaryCountryCode\": \"IT\",\n \"BeneficiaryName\": \"\",\n \"BeneficiaryPostalCode\": \"\",\n \"BeneficiaryRegion\": \"\",\n \"Corporate\": \"TRUE\",\n \"Currency\": \"EUR\",\n \"HighLowValue\": \"\",\n \"NotificationEmail\": \"\",\n \"RemittanceLine1\": \"\",\n \"RemittanceLine2\": \"\",\n \"VendorId\": \"\"\n}'\n201 Created Response
\n{\n \"Name\": \"BeneficiaryName cannot be blank\",\n \"VendorId\": null,\n \"Code\": 58,\n \"InformationMessage\": null,\n \"InformationCode\": 0,\n \"Status\": null\n},\n{\n \"Name\": \"BankName cannot be blank\",\n \"VendorId\": null,\n \"Code\": 53,\n \"InformationMessage\": null,\n \"InformationCode\": 0,\n \"Status\": null\n},\n{\n \"Name\": \"BankAccountNumber cannot be blank\",\n \"VendorId\": null,\n \"Code\": 50,\n \"InformationMessage\": \"BankAccountNumber must be formatted as IBAN\",\n \"InformationCode\": 100017,\n \"Status\": null\n},\n{\n \"Name\": \"Beneficiary SWIFT BIC cannot be blank\",\n \"VendorId\": null,\n \"Code\": 55,\n \"InformationMessage\": null,\n \"InformationCode\": 0,\n \"Status\": null\n},\n{\n \"Name\": null,\n \"VendorId\": null,\n \"Code\": 0,\n \"InformationMessage\": \"RemittanceLine1 updated from '' to 'BOF afexdemoBradAnderson'\",\n \"InformationCode\": 100013,\n \"Status\": null\n}\nNow that you know the required fields needed to create a corporate EUR beneficiary based in Italy, you can proceed with populating the missing fields with the beneficiary's business and banking details. For the purpose of this use case we have provided some EUR Italy bank details in the example below.
Any beneficiaries created via the API have the advantage of being auto-approved as long as the banking details provided are correct and valid. In the API response below you can see the beneficiary status has immediately 'Approved'. Beneficiaries that don't auto-approve will be manually checked and approved by Corpay's operations team.
POST api/BeneficiaryCreate
\ncurl --location --request POST '{{AFEXAPI.Endpoint}}api/beneficiaryCreate' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"BankAccountNumber\": \"IT39M0100003245348200005625\",\n \"BankCountryCode\": \"IT\",\n \"BankName\": \"Credito Emiliano S.p.A.\",\n \"BankSWIFTBIC\": \"BACRIT21216\",\n \"BeneficiaryAddressLine1\": \"Via Barberini\",\n \"BeneficiaryCity\": \"Rome\",\n \"BeneficiaryCountryCode\": \"IT\",\n \"BeneficiaryName\": \"Italy Event Supplies\",\n \"BeneficiaryPostalCode\": \"001800\",\n \"BeneficiaryRegion\": \"RM\",\n \"Corporate\": \"TRUE\",\n \"Currency\": \"EUR\",\n \"HighLowValue\": \"1\",\n \"NotificationEmail\": \"sbeavis@noreply.com\",\n \"RemittanceLine1\": \"afexdemo\",\n \"RemittanceLine2\": \"IVPT\",\n \"VendorId\": \"ItalyEventSupplies\"\n}'\n201 Created Response
\n{\n \"Name\": \"Beneficiary has been created. Vendor ID: ItalyEventSupplies\",\n \"Code\": 0,\n \"InformationMessage\": null,\n \"InformationCode\": 0,\n \"Status\": \"Approved\"\n},\n{\n \"Name\": null,\n \"Code\": 0,\n \"InformationMessage\": \"BankAddress1 updated from '' to 'Strada Statale Della Cisa, 86/V'\",\n \"InformationCode\": 100018,\n \"Status\": null\n},\n{\n \"Name\": null,\n \"Code\": 0,\n \"InformationMessage\": \"BankAddress3 updated from '' to 'Borgo Virgilio'\",\n \"InformationCode\": 100020,\n \"Status\": null\n}\nGET api/beneficiary/find
\ncurl --location --request GET '{{AFEXAPI.Endpoint}}api/beneficiary/find?=ItalyEventSupplies' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw ''\n200 OK Response
\n{\n\"Currency\": \"EUR\",\n\"VendorId\": \"ItalyEventSupplies\",\n\"BeneficiaryName\": \"Italy Event Supplies\",\n\"TemplateType\": 1,\n\"NotificationEmail\": \"sbeavis@noreply.com\",\n\"BeneficiaryCity\": \"Rome\",\n\"BeneficiaryCountryCode\": \"IT\",\n\"BeneficiaryPostalCode\": \"001800\",\n\"BeneficiaryRegion\": \"Roma\",\n\"BeneficiaryRegionCode\": \"RM\",\n\"RemittanceLine1\": \"BOF afexdemo\",\n\"RemittanceLine2\": \"IVPT\",\n\"BankAccountNumber\": \"IT39M0100003245348200005625\",\n\"BankAddress1\": \"STRADA STATALE DELLA CISA, 86/V\",\n\"BankAddress3\": \"BORGO VIRGILIO\",\n\"BankCountryCode\": \"IT\",\n\"BankName\": \"CREDITO EMILIANO S.P.A.\",\n\"BankSWIFTBIC\": \"BACRIT21216\",\n\"HighLowValue\": 1,\n\"Corporate\": true,\n\"Status\": \"Approved\"\n}\nStep 2. Execute FX Trade
\n
\n![\"Step-2-Execute-FX-Trade.jpg\"](\"https://user-images.githubusercontent.com/72567787/98577361-bf5d8680-22b3-11eb-98d2-60b3fd8c376a.JPG\")
Now that you have successfully created your Italian EUR beneficiary, which in this example is called 'Italy Event Supplies' and has auto-approved, you will need to convert GBP (Pound Sterling) into EUR (Euro) in order to schedule a €500 payment out to them.
GET api/v2/ValueDates
\ncurl --location --request GET '{{AFEXAPI.Endpoint}}api/v2/valuedates? \nCurrencyPair=EURGBP&ValueType=CASH' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json'\n200 OK Response
\n\"2020/07/10\"\nGET api/v2/Quote
\ncurl --location --request GET '{{AFEXAPI.Endpoint}}api/v2/quote? \nCurrencyPair=EURGBP&Amount=1000&IsAmountSettlement=FALSE&ValueDate=07/10/2020' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw ''\n200 OK Response
\n{\n\"Rate\": 0.8959,\n\"InvertedRate\": 1.1162,\n\"ValueDate\": \"2020-07-10T00:00:00\",\n\"OptionDate\": \"0001-01-01T00:00:00\",\n\"QuoteId\": \"05765648\",\n\"Amount\": 500.0,\n\"IsAmountSettlement\": false,\n\"TradeCcy\": \"EUR\",\n\"SettlementCcy\": \"GBP\",\n\"SettlementAmt\": 447.95,\n\"Expires_in\": 60\n}\nPOST api/v2/Trades/Create
\ncurl --location --request POST '{{AFEXAPI.Endpoint}}api/v2/trades/create' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"Amount\": \"500\",\n \"FeeAmt\": \"\",\n \"IsAmountSettlement\": \"FALSE\",\n \"QuoteID\": \"05765648\",\n \"SettlementCcy\": \"GBP\",\n \"TradeCcy\": \"EUR\",\n \"ValueDate\": \"07/10/2020\",\n \"VendorId\": \"\"\n}'\n201 Created Response
\n{\n\"TradeNumber\": 376017,\n\"Amount\": 500.0,\n\"Rate\": 0.8959,\n\"TradeCcy\": \"EUR\",\n\"SettlementAmt\": 447.95,\n\"SettlementCcy\": \"GBP\",\n\"ValueDate\": \"2020-07-10T00:00:00\",\n\"FeeAmt\": 0.0,\n\"FeeCurrency\": \"\"\n}\nGET api/Ssi/GetSSI
\ncurl --location --request GET '{{AFEXAPI.Endpoint}}api/ssi/GetSSI?Currency=GBP' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json'\n200 OK Response
\n{\n\"Currency\": \"GBP\",\n\"PaymentInstructions\": \"Remit Funds to: Bank of America, London\\rSWIFT:BOFAGB22\\rSort Code: CHAPS 165050\\rSort Code: BACS 301635 \\rAccount No: 67454050\\rBeneficiary: Associated Foreign Exchange, Inc.\"\n}\nGET api/v2/Trades?ID
\ncurl --location --request GET '{{AFEXAPI.Endpoint}}api/v2/trades?Id=376017' \\\n--header 'Content-Type: application/json' \\\n--header 'API-Key: {{API-Key}}'<br />\n200 OK Response
\n{\n\"TradeNumber\": 376017,\n\"Amount\": 500.0,\n\"RemainingBalance\": 500.0,\n\"Rate\": 0.8959,\n\"BeneficiaryName\": \"\",\n\"TradeCcy\": \"EUR\",\n\"SettlementAmt\": 447.95,\n\"SettlementCcy\": \"GBP\",\n\"TradeDate\": \"2020-07-10T05:57:05\",\n\"ValueDate\": \"2020-07-10T00:00:00\",\n\"Status\": \"Verified\",\n\"Funded\": True,\n\"Note\": \"\",\n\"FeeAmt\": 0.0,\n\"FeeCurrency\": \"\"\n}\nStep 3. Schedule Beneficiary Payment
\n
\n![\"Step-3-Schedule-Beneficiary-Payment.jpg\"](\"https://user-images.githubusercontent.com/72567787/98577440-dbf9be80-22b3-11eb-9489-0fbef8d55f50.JPG\")
Now that you have successfully booked and funded an FX trade to purchase €500, you can schedule a payment out to the Italy Event Supplies EUR beneficiary.
POST api/v2/Payments/Create
\ncurl --location --request POST '{{AFEXAPI.Endpoint}}api/v2/payments/create' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"Amount\": \"500\",\n \"Currency\": \"EUR\",\n \"FeeAmt\": \"\",\n \"PaymentDate\": \"07/10/2020\",\n \"PopCode\": \"\",\n \"PurposeofPayment\": \"\",\n \"VendorId\": \"ItalyEventSupplies\"\n}'\n201 Created Response
\n{\n\"ReferenceNumber\": 249983,\n\"Amount\": 500.0,\n\"Ccy\": \"EUR\",\n\"PaymentDate\": \"2020-07-10T00:00:00\",\n\"Message\": \"Scheduled payment successfully created.\",\n\"FeeAmt\": 0.0,\n\"FeeCurrency\": \"USD\"\n}\nGET api/v2/payments?ID
\ncurl --location --request GET '{{AFEXAPI.Endpoint}}api/v2/payments?Id=249983' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json'<br />\n200 OK Response
\n{\n\"ReferenceNumber\": \"SP249983\",\n\"PaymentStatus\": \"Processed\",\n\"Currency\": \"EUR\",\n\"Amount\": 500.0000,\n\"ValueDate\": \"2020-07-13T00:00:00\",\n\"BeneficiaryName\": \"Italy Event Supplies\",\n\"ScheduledDate\": \"2020-07-10T06:45:34.953\",\n\"SubmittedDate\": \"2020-07-10T06:45:34.953\",\n\"ModifiedDate\": \"2020-07-10T13:45:34.9578012\",\n\"TradeNumber\": \"10144177\",\n\"Status\": \"Submitted\",\n\"Note\": \"\",\n\"FeeAmt\": 0.0000,\n\"FeeCurrency\": \"GBP\"\n}\nStep 4. Retrieve Payment Confirmation
\n
\n![\"Step-4-Retrieve-Payment-Confirmation.jpg\"](\"https://user-images.githubusercontent.com/72567787/98577514-f9c72380-22b3-11eb-9152-81a161e462a2.JPG\")
Finally, with the sending of the beneficiary payment, the last step is to retrieve the Corpay payment confirmation for record keeping. Corpay generates confirmations for all transaction types.
GET api/confirmations
\ncurl --location --request GET '{{AFEXAPI.Endpoint}}api/confirmations? \nTradeNumber=10144177&Swift=FALSE' \\\n--header 'API-Key: {{API-Key}}' \\\n--header 'Content-Type: application/json'\n200 OK Response
\n%PDF-1.3\n1 0 obj\n[/PDF /Text /ImageB /ImageC /ImageI]\nendobj 8 0 obj\n<< /Length 2589 /Filter /FlateDecode>> stream\nTo help you get started, in this section you can view a number of use cases which will help you learn how to utilise different components of Corpay Cross-Border's API services in real-world scenarios. Each use case will provide a typical scenario and business requirement which will be solved for using Corpay's wide range of API services.
\nLet's Start! Click on one of the use cases below to see a step-by-step tutorial on how Corpay's individual API services can be used in a particular scenario:
\nOn-board a Client - In this tutorial you will learn how to on-board a client (child account) under your primary parent account held with Corpay Cross-Border. On-boarding one of your corporate clients with AFEX will in turn give them access to Corpay's DirectAPI transactional services once they have been approved.\nClick here to view the On-Board a Client Use Case
Beneficiary Payment With FX - In this tutorial you will learn how to schedule an international payment to a third-party payee (beneficiary). This will include a walk-through on how to create a beneficiary, execute an FX trade and then finally schedule a payment to the newly created beneficiary. Click here to view the Beneficiary Payment With FX Use Case
Using OAuth 2.0, request a bearer token which will grant access to any PartnerAPI calls located under the Client On-boarding section.
\n","urlObject":{"host":["{{PartnerAPI.Endpoint}}token"],"query":[],"variable":[]}},"response":[{"id":"56bc02a6-3641-42ef-a70e-6467eec08172","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"Grant_Type","value":"password","type":"text"},{"key":"Username","value":"{API-Key}","type":"text"},{"key":"Password","value":"","type":"text"}]},"url":"{{P-URL}}token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"101","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Feb 2018 14:52:54 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"{\"error\":\"unprocessable_entity\",\"error_description\":\"The username and password fields are required.\"}"},{"id":"c0932df6-251b-47e0-afe5-009c9d2f8907","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"Grant_Type","value":"password","type":"text"},{"key":"Username","value":"{API-Key}","type":"text"},{"key":"Password","value":"{Password}","type":"text"}]},"url":"{{P-URL}}token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"401","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json;charset=UTF-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 14 Feb 2018 14:34:30 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"{\"access_token\":\"D3AMwB2V6sRQrkj9uoDe5oQ5CqswM66Pa3IM_60LRr7VwOQ4x7FigaU8K1F0BDEcxjGeokSzdu73-_t1I47D9E_rN2y_reFIJ-omk63PTiao7paDcBBrGwBuMywWcqNDY-Tm0eNd_mx9bxFFEUOm0ux8I30ETGCDZLrCGfJ9BVTWsUMszNnG8mbw8UcF1f9zOXUBMhNDrCUUCaRW-n9hcT5Y-FnWAY4czSaOnFabQPtAE-RoxGppxpcmm-cGtlCu\",\"token_type\":\"bearer\",\"expires_in\":28799,\".issued\":\"Wed, 14 Feb 2018 14:34:30 GMT\",\".expires\":\"Wed, 14 Feb 2018 22:34:30 GMT\"}"}],"_postman_id":"20bd98e8-22ca-4200-8cb2-d0def9ec8513"},{"name":"DirectAPI Token","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);\r","pm.environment.set('AFEXAPI_access_token', jsonData.access_token);"],"type":"text/javascript","id":"a33c72d1-5e35-4c20-8dd4-2a5e74039f5e"}}],"id":"4cebe23e-d2bb-4403-b1f8-c708b443956b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"Grant_Type","value":"password","type":"text"},{"key":"Username","value":"{{PartnerAPI.API-Key}}","type":"text"},{"key":"Password","value":"{{PartnerAPI.Password}}","type":"text"},{"key":"Timeout","value":"400","type":"text"}]},"url":"{{AFEXAPI.Endpoint}}/token","description":"Using OAuth 2.0, request a bearer token which will grant access to any DirectAPI calls located under the 'Beneficiary Management', 'Trades', 'Window Forwards', 'Payments' and 'Reference'sections.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}},"urlObject":{"path":["token"],"host":["{{AFEXAPI.Endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4cebe23e-d2bb-4403-b1f8-c708b443956b"}],"id":"4e2b83d5-497b-49a2-a0b6-45d36d94e08c","description":"Corpay Cross-Border uses OAuth 2.0 to add an extra layer of security to our PartnerAPI services making for a more secure connection with our partners and their clients. Using the POST Get Token method detailed below, along with a unique username and password, partners will be able to retrieve a bearer token which is then required to access any PartnerAPI methods located under the Client On-boarding section.
\n","_postman_id":"4e2b83d5-497b-49a2-a0b6-45d36d94e08c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}},{"name":"Client On-boarding","item":[{"name":"Account Creation v1","item":[{"name":"AccountCreate","id":"6471318d-0b1c-44d2-a364-17a0e6a8669b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"TermsAndConditions\": \"\",\r\n\"AccountEntityType\": \"\",\r\n\"AccountNumber\": \"\",\r\n\"Salutation\": \"\",\r\n\"FirstName\": \"\",\r\n\"MiddleName\": \"\",\r\n\"LastName\": \"\",\r\n\"Citizenship\": \"\",\r\n\"ContactAddress1\": \"\",\r\n\"ContactAddress2\": \"\",\r\n\"ContactAddress3\": \"\",\r\n\"ContactZip\": \"\",\r\n\"ContactCity\": \"\",\r\n\"ContactStateRegion\": \"\",\r\n\"ContactCountryCode\": \"\",\r\n\"ContactPhone\": \"\",\r\n\"ContactPrimaryIdentificationExpirationDate\": \"\",\r\n\"ContactPrimaryIdentificationIssuingAgency\": \"\",\r\n\"ContactPrimaryIdentificationNumber\": \"\",\r\n\"ContactPrimaryIdentificationType\": \"\",\r\n\"DateOfBirth\": \"\",\r\n\"EmploymentStatus\": \"\",\r\n\"JobTitle\": \"\",\r\n\"Occupation\": \"\",\r\n\"PrimaryEmailAddress\": \"\",\r\n\"SecondaryIdentificationExpirationDate\": \"\",\r\n\"SecondaryIdentificationIssuingAgency\": \"\",\r\n\"SecondaryIdentificationNumber\": \"\",\r\n\"SecondaryIdentificationType\": \"\",\r\n\"SourcesOfWealth\": \"\",\r\n\"TaxIdentificationNumber\": \"\",\r\n\"LegalCompanyName\": \"\",\r\n\"DoingBusinessAs\": \"\",\r\n\"BusinessTelephoneNo\": \"\",\r\n\"BusinessWebsite\": \"\",\r\n\"CompanyType\": \"\",\r\n\"DescriptionOfBusiness\": \"\",\r\n\"DateOfFormation\": \"\",\r\n\"CountryOfIncorporation\": \"\",\r\n\"StateRegionOfIncorporation\": \"\",\r\n\"FederalTaxId\": \"\",\r\n\"CompanyRegistrationNo\": \"\",\r\n\"BusinessCountry\": \"\",\r\n\"BusinessAddress\": \"\",\r\n\"BusinessCity\": \"\",\r\n\"BusinessState\": \"\",\r\n\"BusinessZip\": \"\",\r\n\"CorrespondenceCountry\": \"\",\r\n\"CorrespondenceAddress\": \"\",\r\n\"CorrespondenceCity\": \"\",\r\n\"CorrespondenceState\": \"\",\r\n\"CorrespondenceZip\": \"\",\r\n\"NAICS\": \"\",\r\n\"TickerSymbol\": \"\",\r\n\"Description\": \"\",\r\n\"ExpectedMonthlyPayments\": \"\",\r\n\"ExpectedMonthlyVolume\": \"\",\r\n\"LEINumber\": \"\",\r\n\"LEIExpirationDate\": \"\",\r\n\"TradingCountries\": \"\",\r\n\"KeyIndividuals\":[\r\n{\r\n\t\"IndividualRoles\":\"\",\r\n\t\"PercentOwnership\": \"\",\r\n\t\"Salutation\": \"\",\r\n\t\"FirstName\": \"\",\r\n\t\"MiddleName\": \"\",\r\n\t\"LastName\": \"\",\r\n\t\"JobTitle\": \"\",\r\n\t\"JobTitleOther\": \"\",\r\n\t\"DateOfBirth\": \"\",\r\n\t\"Address\": \"\",\r\n\t\"City\": \"\",\r\n\t\"Zip\": \"\",\r\n\t\"Email\": \"\",\r\n\t\"PhoneNumber\": \"\",\r\n\t\"SSN\": \"\",\r\n\t\"IdType\": \"\",\r\n\t\"IdNo\": \"\",\r\n\t\"IdExpirationDate\": \"\",\r\n\t\"IssueJurisdiction\": \"\",\r\n\t\"AccountPrimaryContact\": \"\",\r\n\t\"AFEXDirectUserRole\": \"\",\r\n\t\"Citizenship\": \"\",\r\n\t\"State\": \"\",\r\n\t\"Country\": \"\"}\r\n\t]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{PartnerAPI.Endpoint}}api/v1/AccountCreate","description":"This Account Create method enables you to on-board a Corporate Client entity type with Corpay Cross-Border along with the listed data points below. A wide range of required data points can be passed via the Account Create method including corporate client address information, account use and purpose, ID information and key business individual details.
\nPlease note, for each PartnerAPI integration Corpay's Compliance team and designated IT Programme Manager will work with you to validate what data points and supporting on-boarding documentation needs to be sent to Corpay via the API to ensure successful client on-boarding and approval.
\nThe Prospect Create method allows you to create a Corporate prospect record with Corpay Cross-Border. The full range of available data points, as found with Corpay's 'Account Create' method, can be passed via the 'Prospect Create' method. This includes Corporate client address information, account use and purpose, ID information and key business individual details.
\nProspect records can be created with minimal data points in which the minimum data requirement can be found in the request parameter table below. Prospect records can also be updated with new information via this same API method. Once a prospect is ready to be converted into an account, the prospect's unique ID can be submitted via the Account Create method to begin full compliance on-boarding.
\nCorpay's Prospect Create method enables our partners to improve their record keeping/management of prospect lists as well as streamlining the process of converting a prospect record to an fully on-boarded account.
\nTo further streamline and quicken the client on-boarding process, Corpay Cross-Border's PartnerAPI allows you to upload up to 3 files to a client account within a single Add Files request in order to support Corpay's Compliance review. Additional Add File requests can be made if further client on-boarding documentation is needed.
\nRequest Parameters
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"This method allows you to retrieve a list of these available Account Entity Types which are used to populate the 'AccountEntityType' parameter for api/v1/AccountCreate. Specifying what type of client account entity needs to be created will determine what parameters need populating for the Account Create method.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get a list of available salutations that are used to populate the 'Salutation' parameters for api/v1/AccountCreate as part of client onboarding.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get a list of Individual Role types that are used to populate the 'IndvidualRoles' parameter for api/v1/AccountCreate as part of Corporate client and Corporate Registered User onboarding.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get a list of available AFEXDirect User Roles that are used to populate the 'AFEXDirectUserRole' parameter for api/v1/AccountCreate as part of Corporate client onboarding. The will automatically begin the sign-up process of your client to AFEX's customer portal known as AFEXDirect.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get a list of accepted Business Identification Types that are used to populate the 'FederalTaxId' parameter for api/v1/AccountCreate as part of Corporate client onboarding.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Status Definitions
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Retrieve the information held on account for a Prospect record by specifying its 'ProspectId'.
\n
The api/v1/AccountCreate method and following supporting reference APIs in this collection allow a Corpay Partner to create/onboard a number of client account entity types with Corpay. As mentioned previously, the Account Create method streamlines the client onboarding process for all of our partners integrated with us by allowing them to electronically submit on-boarding data of a corporate or private client directly to Corpay via the PartnerAPI.
\n","event":[{"listen":"prerequest","script":{"id":"f1f2ad55-f7dd-4798-ad27-89b8ae70fa8f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4e380365-c610-46b9-9072-b25a16fd7665","type":"text/javascript","exec":[""]}}],"_postman_id":"c942d8fe-48a5-403c-a6bc-488091f6d78f","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Create a new Private client account.
\nCreate a new Corporate client account.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"This method is used to add a Company Officer to an existing Corporate Client account. A Company Officer is a Director or UBO (Ultimate Beneficial Owner) with a controlling company ownership of 25% or greater and is verified as part of the standard Corpay due diligence and KYC procedures.
\nGet the account status of a child account by submitting its API key.
\nStatus Definitions
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get the account details for the specified private client.
\nGet the account details for the specified corporate client.
\nThe following API container consists of Corpay's first iteration of the PartnerAPI Corporate and Private Client on-boarding methods. Whilst still available, all new API integrations will use Corpay's updated Account Creation v1 methods.
\n","event":[{"listen":"prerequest","script":{"id":"fcbafac2-6604-45a9-92bf-a3f6d564577b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"653b9ac9-4ba5-47ff-8233-9849ca497ab4","type":"text/javascript","exec":[""]}}],"_postman_id":"4cf93b73-de30-47d4-a75f-f96edf8d80d9","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get a list of account identification types for use with api/v1/CorporateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get a list of contact identification types for use with api/v1/PrivateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get list of company types for use with api/v1/CorporateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get list of occupation groups for use with api/v1/OccupationDetails.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Using the GroupId retrieved with api/v1/OccupationGroups, Get a list of occupation details for use with api/v1/PrivateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get list of sources of wealth for use with api/v1/PrivateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get list of employment status types for use with api/v1/PrivateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get list of product details for use with api/v1/CorporateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get list of job titles for use with api/v1/CorporateClient and api/v1/PrivateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Get list of NAICS (North American Industry Classification System) codes for use with api/v1/CorporateClient.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Corpay Cross-Border's PartnerAPI reference data collection includes a number of methods which help support clients through their on-boarding journey with both our Partners and Corpay. Importantly, these reference methods help to populate the corresponding fields with the 'POST AccountCreate' request.
\n","event":[{"listen":"prerequest","script":{"id":"c58bdbea-4648-4085-a3fd-51bac60c3df1","type":"text/javascript","exec":["pm.request.headers.add({","key: 'Content-Type',","value: 'application/json'","});"]}},{"listen":"test","script":{"id":"51b3057d-f18c-4bf4-9dc9-a88ba50c78b4","type":"text/javascript","exec":[""]}}],"_postman_id":"fdb37b6d-4d18-4bc8-8f0b-39a4e22e51a3","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"This method will enable the enrollment of an account for Direct Debit settlement. The account details are stored and can be used as a settlement account in api/v2/Trades/Create, api/Forwards/Create or api/v2/Payments/Create by including the 'AccountNumber' parameter for the desired direct debit account.
\nThis method will initiate the un-enrollment of an account for Direct Debit settlement.
\nThe following API methods allow clients to submit a request to setup (enroll or unroll) their own bank account for Direct Debit settlement with Corpay. This feature provides our partners with an opportunity to support further end-to-end automation by utilising GBP and USD Direct Debit settlement options for client trades and payments.
\n","_postman_id":"6fed7330-7f28-4295-b7a6-125e5f0c6d11","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"This method can be used to retrieve the available notification filters. Any notification filter can be subscribed to using:
\napi/v1/WebHooks/notificationSubscribe
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"This method can be used to retrieve a list of active subscriptions for a specified customer.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"As part of AFEX’s continuous enhancement of its API offering, this latest release includes the introduction of API outbound notifications (Web-Hooks). This enhancement will allow AFEX to send partners and clients notifications via the API for triggered events, specifically status changes.
\nPartners can subscribe to the three different notification filters listed below in which they will receive an outbound notification to alert them of any status changes. A new ‘WebHook Notification Filters’ method has been added to the PartnerAPI which will return all of AFEX’s available notification types.
\n`Account Approval` - An on-boarded account has been approved and is ready for use.\n\n`Beneficiary Approval` - A beneficiary template has been validated and approved for the use of sending funds with api/v2/Trades/Create, or api/v2/Paymentments/Create.\n\n`Transaction Processed` - A transaction has been updated from pending to processed.\n\n`Fund Received` - An incoming wire/payment has been received on the client's funding balance.\nEach service will poll every 5 minutes to see whether a change has been applied to the selected notification filter criteria such as a client account being approved; a beneficiary being approved; or if a transaction has been processed. The partner can provide their own endpoint in which these outbound notifications would be sent to.
\nPush Notifications, commonly referred to as webhooks, allow you to subscribe to key events whereby AFEX will send an out-bound notification when the event criteria is triggered. Events include Account Approval, Beneficiary Template Approval or Transaction Processing. Real-time updates will be sent assuring you have the latest information to support your internal processes and customer's needs.
\nUsing the methods in this collection, an AFEX Partner can discover the available subscription filters, enroll or unroll to notifications as well as check their client's active notification subscriptions.
\n","event":[{"listen":"prerequest","script":{"id":"9b33419d-837a-4dc7-b108-a054947fb664","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7bdcec82-ded3-40fe-afd6-80728047ba38","type":"text/javascript","exec":[""]}}],"_postman_id":"b7043705-6f72-4df5-8d17-bc3c5f1e1237","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Corpay Cross-Border's PartnerAPI makes it possible for our partners to on-board their own clients with Corpay which in turn enables their clients to make full use of Corpay's trade and payment services. One of the key value propositions of the Corpay Partnership Program is that it allows your clients to enjoy Corpay Cross-Border's products and services from your own portal/application.
\nAs you will see in the upcoming collection, Corpay's PartnerAPI services streamline the client on-boarding process for all of our integrated partners by allowing them to electronically submit on-boarding data of a corporate client directly to Corpay via the API. As part of the on-boarding process, your clients will undergo a thorough compliance due diligence review and be screened against automated Straight-Through-Processing (STP) checks before being approved to utilize Corpay's suite of DirectAPI products and services.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"This method allows a client to create a new third-party beneficiary for payment scheduling. Funds can be sent to a beneficiary bank account by specifying the beneficiary's VendorID in either api/v2/trades/create or api/v2/payments/create requests.
\nWhen creating a beneficiary you may assign your own unique VendorID or otherwise the AFEX system will assign a default VendorID.
\nThe required data for a beneficiary varies based on currency, clearing method (SWIFT/high value or local clearing/low value), beneficiary entity type (corporate or individual), and beneficiary and bank country. This validation utilizes AFEX payment and currency rules to derive the details needed to deliver a payment to a beneficiary. When all the required data is submitted, the beneficiary will be created with a status of \"Approved\" or \"Pending\". Where the status is \"Pending\", this will require manual review and approval by AFEX.
\nNote that an iterative approach is recommended for the beneficiary creation (As seen in the below steps 1 - 4.) A detailed design document outlining this flow is available upon request from your assigned IT Programme Manager.
\n1. Submit the minimum set of beneficiary data as described above i.e. currency, HighLowValue, Corporate=true or false, bank country code and beneficiary country code.\n2. Review the remaining required data as indicated by the API response.\n3. Submit required beneficiary data.\n4. Repeat until the response indicates \"Beneficiary has been created\", Status \"Approved\" or \"Pending\".\nThis API Method allows you to update an existing beneficiary record (Please note, the method cannot be used to update an instant beneficiary). The update request must echo back the original data sent to create the beneficiary, and for those fields to be updated, the new data should be populated instead.
\nNote only the below parameters are recommended to be updated. Updating any other parameter would require too significant a change to the overall template. If additional parameters do need updating, it is advised that you disable the template using api/BeneficiaryDisable and create a new beneficiary template.
\nDisable an existing beneficiary record by VendorID. Once a beneficiary is disabled, it can only be re-enabled by contacting AFEX. Can be used for a standard beneficiary or an instant beneficiary.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}},"urlObject":{"path":["beneficiaryDisable"],"host":["{{AFEXAPI.Endpoint}}api"],"query":[{"key":"VendorId","value":""}],"variable":[]}},"response":[{"id":"23bb3065-1104-4c91-a301-f2463089b467","name":"200 Ok","originalRequest":{"method":"POST","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{URL}}api/beneficiaryDisable?VendorId=USDExampleBeneficiaryName","host":["{{URL}}api"],"path":["beneficiaryDisable"],"query":[{"key":"VendorId","value":"USDExampleBeneficiaryName"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"45","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Feb 2018 16:20:49 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"\"USDExampleBeneficiaryName has been disabled\""},{"id":"8e9621e4-ec1e-4334-89b3-32106b6ca55a","name":"Disable Beneficiary","originalRequest":{"method":"POST","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{URL}}api/beneficiaryDisable?VendorId=NZD636046187630498296","host":["{{URL}}api"],"path":["beneficiaryDisable"],"query":[{"key":"VendorId","value":"NZD636046187630498296"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"41","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Thu, 12 Apr 2018 13:33:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","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)"}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"\"NZD636046187630498296 has been disabled\""},{"id":"cdb26e5b-bd02-4c96-9f70-8ffde4cd4024","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{URL}}api/beneficiaryDisable?VendorId=","host":["{{URL}}api"],"path":["beneficiaryDisable"],"query":[{"key":"VendorId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"51","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Feb 2018 16:21:21 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"\"A vendor ID is required to disable a beneficiary.\""}],"_postman_id":"7d7ea914-6ed2-4520-9b5c-15805d97d199"}],"id":"c522ba9b-1196-4581-9e3b-933d63fdcd88","description":"AFEX's Beneficiary Management features allow our partners and clients to create and manage their own trusted payees (beneficiaries) list with AFEX.
\n","event":[{"listen":"prerequest","script":{"id":"1b993289-4017-4b0e-b238-5afc8b0255a4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9dac0d0c-a189-4705-9b08-d07298c02228","type":"text/javascript","exec":[""]}}],"_postman_id":"c522ba9b-1196-4581-9e3b-933d63fdcd88","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}},{"name":"Create Instant Payment Beneficiary","item":[{"name":"Validate an Instant Beneficiary","id":"a40700f0-bf56-45bd-a3fe-80212449a6ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"AccountID\":\"\",\n \"FundingBalanceID\":\"\",\n \"NotificationEmail\":\"\",\n \"RemittanceLine4\":\"\",\n \"VendorId\":\"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/instantbeneficiaryvalidate","description":"Validate if the data to be supplied to create an instant beneficiary is valid.
\nCreate an instant beneficiary to receive an instant payment. Instant payments allow an AFEX client to send funds directly to another AFEX client. The transfer occurs instantly on a 24 x 7 basis including outside of business hours. You must obtain a Funding Balance ID and an Account ID from the AFEX client who is to be the beneficiary of the funds. Note, instant beneficiaries can only be paid via a scheduled payment from existing currency funding/Vostro balances (utilising POST api/v2/payments/create). They cannot be paid directly from trade proceeds (such as with api/v2/trades/create).
\nCreate a currency funding balance on a client's account. A funding balance is required on the client's account in order to set them up an \"instant beneficiary\" for the chosen currency. The Funding Balance ID and the Account ID must be supplied to the sender of the funds so to allow for those funds to be sent to the correct AFEX client account. Creation of a funding balance is only required if the client has not transacted in the currency before, and a Vostro holding for the specified currency therefore doesn't yet exist.
\nGet a Funding Balance ID and an Account ID. As mentioned previously, a funding balance is required on the client's account so that they can be setup an \"instant\" beneficiary to receive client-to-client transfers in the required currency. This data must be provided to the sender of an AFEX \"instant beneficiary\" payment so that the sender can setup the client's funding balance as an instant beneficiary. If a funding balance ID does not exist, one must be created using api/FundingBalance/Create.
\nAFEX's Instant Payment Beneficiary features allow clients to make internal transfers to other mutually on-boarded clients of AFEX. These transfers occur instantly on a 24 x 7 basis including outside of business hours with no payment fees attached. The Instant Payment Beneficiary features also create a wider scope of settlement opportunities for client transactions whereby transfers can be made at partner (master account) level to fund their underlying client accounts funding balances.
\n","_postman_id":"b67893b7-b272-4cf6-a644-dda665cdc8bc","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}},{"name":"Find Beneficiary","item":[{"name":"Get All Beneficiaries","id":"b005fe2f-b047-4946-a109-22a1c186b166","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"PageSize\":\"\",\r\n \"PageNumber\":\"\",\r\n \"RemitId\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/v2/beneficiary","description":"Returns a list of all the beneficiaries on your account including basic information such as VendorID and Status.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}},"urlObject":{"path":["v2","beneficiary"],"host":["{{AFEXAPI.Endpoint}}api"],"query":[],"variable":[]}},"response":[{"id":"9777bc14-61a4-4f66-b7ef-6a5602b19fa4","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"url":"{{URL}}api/beneficiary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"3469","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Feb 2018 14:55:12 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"[\n {\n \"Name\": \"Beneficiary 1\",\n \"Currency\": \"USD\",\n \"VendorId\": \"USD4568213548354\",\n \"Status\": \"Pending\"\n },\n {\n \"Name\": \"Beneficiary 2\",\n \"Currency\": \"GBP\",\n \"VendorId\": \"GBP4546135419689\",\n \"Status\": \"Pending\"\n },\n {\n \"Name\": \"Beneficiary 3\",\n \"Currency\": \"AUD\",\n \"VendorId\": \"AUD8765498451665\",\n \"Status\": \"Approved\"\n },\n {\n \"Name\": \"Beneficiary 4\",\n \"Currency\": \"CAD\",\n \"VendorId\": \"CAD5465135132166\",\n \"Status\": \"Pending\"\n }\n]"},{"id":"b662e444-70e4-4ce4-a278-c237eecdf734","name":"Get All Benficiaries ","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{URL}}api/beneficiary"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b005fe2f-b047-4946-a109-22a1c186b166"},{"name":"Find Beneficiary ","id":"164b5d90-bd7c-4f13-9fcc-e60d2c47026f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"VendorId\": \"\"\n}"},"url":"{{AFEXAPI.Endpoint}}api/beneficiary/find?","description":"Search for beneficiary details using its unique Vendor Id. By passing a Vendor ID the API will returns the full set of data held on record for that beneficiary. This method can be used for both standard and instant beneficiaries.
\nThese API methods allow you to retrieve a list of all of the beneficiaries created under your AFEX account as well as retrieving the full details held on record by AFEX of a particular beneficiary.
\n","event":[{"listen":"prerequest","script":{"id":"dd1d17bc-121c-4451-ac1a-b88380edcf33","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"10985bc8-92b6-4a73-a9bc-0f21eb5435bf","type":"text/javascript","exec":[""]}}],"_postman_id":"c775cfd7-779b-4e12-bb1a-2843882c4723","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}},{"name":"Find Beneficiary Banks & Reference Data","item":[{"name":"Beneficiary Information and Error Codes","id":"c0031e98-291c-4561-aa1a-367d76a4fb14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{AFEXAPI.Endpoint}}api/beneficiaryCodes?Information=","description":"Retrieve all information and error response code types that can returned in the Create and Update beneficiary API responses related to.
\nThis API method returns a list of country names including their ISO code which are to be used when specifying the beneficiary and bank country code whilst creating a new beneficiary.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}},"urlObject":{"path":["country","find"],"host":["{{AFEXAPI.Endpoint}}api"],"query":[],"variable":[]}},"response":[{"id":"ef9ea387-ee89-4adb-9ef6-2e1b8b118a52","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{URL}}api/country/find"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 19 Nov 2018 04:47:25 GMT"},{"key":"Content-Length","value":"8320"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"AX\",\n \"Name\": \"Aland Islands\"\n },\n {\n \"Code\": \"AL\",\n \"Name\": \"Albania\"\n },\n {\n \"Code\": \"DZ\",\n \"Name\": \"Algeria\"\n },\n {\n \"Code\": \"AS\",\n \"Name\": \"American Samoa\"\n },\n {\n \"Code\": \"AD\",\n \"Name\": \"Andorra\"\n },\n {\n \"Code\": \"AO\",\n \"Name\": \"Angola\"\n },\n {\n \"Code\": \"AI\",\n \"Name\": \"Anguilla\"\n },\n {\n \"Code\": \"AG\",\n \"Name\": \"Antigua and Barbuda\"\n },\n {\n \"Code\": \"AR\",\n \"Name\": \"Argentina\"\n },\n {\n \"Code\": \"AM\",\n \"Name\": \"Armenia\"\n },\n {\n \"Code\": \"AW\",\n \"Name\": \"Aruba\"\n },\n {\n \"Code\": \"AU\",\n \"Name\": \"Australia\"\n },\n {\n \"Code\": \"AT\",\n \"Name\": \"Austria\"\n },\n {\n \"Code\": \"AZ\",\n \"Name\": \"Azerbaijan\"\n },\n {\n \"Code\": \"BS\",\n \"Name\": \"Bahamas\"\n },\n {\n \"Code\": \"BH\",\n \"Name\": \"Bahrain\"\n },\n {\n \"Code\": \"BD\",\n \"Name\": \"Bangladesh\"\n },\n {\n \"Code\": \"BB\",\n \"Name\": \"Barbados\"\n },\n {\n \"Code\": \"BY\",\n \"Name\": \"Belarus\"\n },\n {\n \"Code\": \"BE\",\n \"Name\": \"Belgium\"\n },\n {\n \"Code\": \"BZ\",\n \"Name\": \"Belize\"\n },\n {\n \"Code\": \"BJ\",\n \"Name\": \"Benin\"\n },\n {\n \"Code\": \"BM\",\n \"Name\": \"Bermuda\"\n },\n {\n \"Code\": \"BT\",\n \"Name\": \"Bhutan\"\n },\n {\n \"Code\": \"BO\",\n \"Name\": \"Bolivia\"\n },\n {\n \"Code\": \"BQ\",\n \"Name\": \"Bonaire, Sint Eustatius and Saba\"\n },\n {\n \"Code\": \"BA\",\n \"Name\": \"Bosnia and Herzegovina\"\n },\n {\n \"Code\": \"BW\",\n \"Name\": \"Botswana\"\n },\n {\n \"Code\": \"BV\",\n \"Name\": \"Bouvet Island\"\n },\n {\n \"Code\": \"BR\",\n \"Name\": \"Brazil\"\n },\n {\n \"Code\": \"IO\",\n \"Name\": \"British Indian Ocean Territory\"\n },\n {\n \"Code\": \"BN\",\n \"Name\": \"Brunei Darussalam\"\n },\n {\n \"Code\": \"BG\",\n \"Name\": \"Bulgaria\"\n },\n {\n \"Code\": \"BF\",\n \"Name\": \"Burkina Faso\"\n },\n {\n \"Code\": \"BI\",\n \"Name\": \"Burundi\"\n },\n {\n \"Code\": \"KH\",\n \"Name\": \"Cambodia\"\n },\n {\n \"Code\": \"CM\",\n \"Name\": \"Cameroon\"\n },\n {\n \"Code\": \"CA\",\n \"Name\": \"Canada\"\n },\n {\n \"Code\": \"CV\",\n \"Name\": \"Cape Verde\"\n },\n {\n \"Code\": \"KY\",\n \"Name\": \"Cayman Islands\"\n },\n {\n \"Code\": \"CF\",\n \"Name\": \"Central African Republic\"\n },\n {\n \"Code\": \"TD\",\n \"Name\": \"Chad\"\n },\n {\n \"Code\": \"CL\",\n \"Name\": \"Chile\"\n },\n {\n \"Code\": \"CN\",\n \"Name\": \"China\"\n },\n {\n \"Code\": \"CX\",\n \"Name\": \"Christmas Island\"\n },\n {\n \"Code\": \"CC\",\n \"Name\": \"Cocos (Keeling) Islands\"\n },\n {\n \"Code\": \"CO\",\n \"Name\": \"Colombia\"\n },\n {\n \"Code\": \"KM\",\n \"Name\": \"Comoros\"\n },\n {\n \"Code\": \"CG\",\n \"Name\": \"Congo\"\n },\n {\n \"Code\": \"CD\",\n \"Name\": \"Congo, Democratic Republic of the\"\n },\n {\n \"Code\": \"CK\",\n \"Name\": \"Cook Islands\"\n },\n {\n \"Code\": \"CR\",\n \"Name\": \"Costa Rica\"\n },\n {\n \"Code\": \"HR\",\n \"Name\": \"Croatia\"\n },\n {\n \"Code\": \"CW\",\n \"Name\": \"Curacao\"\n },\n {\n \"Code\": \"CY\",\n \"Name\": \"Cyprus\"\n },\n {\n \"Code\": \"CZ\",\n \"Name\": \"Czech Republic\"\n },\n {\n \"Code\": \"DK\",\n \"Name\": \"Denmark\"\n },\n {\n \"Code\": \"DJ\",\n \"Name\": \"Djibouti\"\n },\n {\n \"Code\": \"DM\",\n \"Name\": \"Dominica\"\n },\n {\n \"Code\": \"DO\",\n \"Name\": \"Dominican Republic\"\n },\n {\n \"Code\": \"EC\",\n \"Name\": \"Ecuador\"\n },\n {\n \"Code\": \"EG\",\n \"Name\": \"Egypt\"\n },\n {\n \"Code\": \"SV\",\n \"Name\": \"El Salvador\"\n },\n {\n \"Code\": \"GQ\",\n \"Name\": \"Equatorial Guinea\"\n },\n {\n \"Code\": \"ER\",\n \"Name\": \"Eritrea\"\n },\n {\n \"Code\": \"EE\",\n \"Name\": \"Estonia\"\n },\n {\n \"Code\": \"ET\",\n \"Name\": \"Ethiopia\"\n },\n {\n \"Code\": \"FK\",\n \"Name\": \"Falkland Islands (Malvinas)\"\n },\n {\n \"Code\": \"FO\",\n \"Name\": \"Faroe Islands\"\n },\n {\n \"Code\": \"FJ\",\n \"Name\": \"Fiji\"\n },\n {\n \"Code\": \"FI\",\n \"Name\": \"Finland\"\n },\n {\n \"Code\": \"FR\",\n \"Name\": \"France\"\n },\n {\n \"Code\": \"GF\",\n \"Name\": \"French Guiana\"\n },\n {\n \"Code\": \"PF\",\n \"Name\": \"French Polynesia\"\n },\n {\n \"Code\": \"TF\",\n \"Name\": \"French Southern Territories\"\n },\n {\n \"Code\": \"GA\",\n \"Name\": \"Gabon\"\n },\n {\n \"Code\": \"GM\",\n \"Name\": \"Gambia\"\n },\n {\n \"Code\": \"GE\",\n \"Name\": \"Georgia\"\n },\n {\n \"Code\": \"DE\",\n \"Name\": \"Germany\"\n },\n {\n \"Code\": \"GH\",\n \"Name\": \"Ghana\"\n },\n {\n \"Code\": \"GI\",\n \"Name\": \"Gibraltar\"\n },\n {\n \"Code\": \"GR\",\n \"Name\": \"Greece\"\n },\n {\n \"Code\": \"GL\",\n \"Name\": \"Greenland\"\n },\n {\n \"Code\": \"GD\",\n \"Name\": \"Grenada\"\n },\n {\n \"Code\": \"GP\",\n \"Name\": \"Guadaloupe\"\n },\n {\n \"Code\": \"GU\",\n \"Name\": \"Guam\"\n },\n {\n \"Code\": \"GT\",\n \"Name\": \"Guatemala\"\n },\n {\n \"Code\": \"GG\",\n \"Name\": \"Guernsey, C.I.\"\n },\n {\n \"Code\": \"GN\",\n \"Name\": \"Guinea\"\n },\n {\n \"Code\": \"GW\",\n \"Name\": \"Guinea-Bissau\"\n },\n {\n \"Code\": \"GY\",\n \"Name\": \"Guyana\"\n },\n {\n \"Code\": \"HT\",\n \"Name\": \"Haiti\"\n },\n {\n \"Code\": \"HM\",\n \"Name\": \"Heard Island and McDonald Islands\"\n },\n {\n \"Code\": \"HN\",\n \"Name\": \"Honduras\"\n },\n {\n \"Code\": \"HK\",\n \"Name\": \"Hong Kong\"\n },\n {\n \"Code\": \"HU\",\n \"Name\": \"Hungary\"\n },\n {\n \"Code\": \"IS\",\n \"Name\": \"Iceland\"\n },\n {\n \"Code\": \"IN\",\n \"Name\": \"India\"\n },\n {\n \"Code\": \"ID\",\n \"Name\": \"Indonesia\"\n },\n {\n \"Code\": \"IQ\",\n \"Name\": \"Iraq\"\n },\n {\n \"Code\": \"IE\",\n \"Name\": \"Ireland\"\n },\n {\n \"Code\": \"IM\",\n \"Name\": \"Isle of Man\"\n },\n {\n \"Code\": \"IL\",\n \"Name\": \"Israel\"\n },\n {\n \"Code\": \"IT\",\n \"Name\": \"Italy\"\n },\n {\n \"Code\": \"CI\",\n \"Name\": \"Ivory Coast\"\n },\n {\n \"Code\": \"JM\",\n \"Name\": \"Jamaica\"\n },\n {\n \"Code\": \"JP\",\n \"Name\": \"Japan\"\n },\n {\n \"Code\": \"JE\",\n \"Name\": \"Jersey, C.I.\"\n },\n {\n \"Code\": \"JO\",\n \"Name\": \"Jordan\"\n },\n {\n \"Code\": \"KZ\",\n \"Name\": \"Kazakhstan\"\n },\n {\n \"Code\": \"KE\",\n \"Name\": \"Kenya\"\n },\n {\n \"Code\": \"KI\",\n \"Name\": \"Kiribati\"\n },\n {\n \"Code\": \"XK\",\n \"Name\": \"Kosovo\"\n },\n {\n \"Code\": \"KW\",\n \"Name\": \"Kuwait\"\n },\n {\n \"Code\": \"KG\",\n \"Name\": \"Kyrgyzstan\"\n },\n {\n \"Code\": \"LA\",\n \"Name\": \"Laos\"\n },\n {\n \"Code\": \"LV\",\n \"Name\": \"Latvia\"\n },\n {\n \"Code\": \"LB\",\n \"Name\": \"Lebanon\"\n },\n {\n \"Code\": \"LS\",\n \"Name\": \"Lesotho\"\n },\n {\n \"Code\": \"LR\",\n \"Name\": \"Liberia\"\n },\n {\n \"Code\": \"LY\",\n \"Name\": \"Libya\"\n },\n {\n \"Code\": \"LI\",\n \"Name\": \"Liechtenstein\"\n },\n {\n \"Code\": \"LT\",\n \"Name\": \"Lithuania\"\n },\n {\n \"Code\": \"LU\",\n \"Name\": \"Luxembourg\"\n },\n {\n \"Code\": \"MO\",\n \"Name\": \"Macau\"\n },\n {\n \"Code\": \"MK\",\n \"Name\": \"Macedonia\"\n },\n {\n \"Code\": \"MG\",\n \"Name\": \"Madagascar\"\n },\n {\n \"Code\": \"MW\",\n \"Name\": \"Malawi\"\n },\n {\n \"Code\": \"MY\",\n \"Name\": \"Malaysia\"\n },\n {\n \"Code\": \"MV\",\n \"Name\": \"Maldives\"\n },\n {\n \"Code\": \"ML\",\n \"Name\": \"Mali\"\n },\n {\n \"Code\": \"MT\",\n \"Name\": \"Malta\"\n },\n {\n \"Code\": \"MH\",\n \"Name\": \"Marshall Islands\"\n },\n {\n \"Code\": \"MQ\",\n \"Name\": \"Martinique\"\n },\n {\n \"Code\": \"MR\",\n \"Name\": \"Mauritania\"\n },\n {\n \"Code\": \"MU\",\n \"Name\": \"Mauritius\"\n },\n {\n \"Code\": \"YT\",\n \"Name\": \"Mayotte\"\n },\n {\n \"Code\": \"MX\",\n \"Name\": \"Mexico\"\n },\n {\n \"Code\": \"FM\",\n \"Name\": \"Micronesia\"\n },\n {\n \"Code\": \"MD\",\n \"Name\": \"Moldova\"\n },\n {\n \"Code\": \"MC\",\n \"Name\": \"Monaco\"\n },\n {\n \"Code\": \"MN\",\n \"Name\": \"Mongolia\"\n },\n {\n \"Code\": \"ME\",\n \"Name\": \"Montenegro\"\n },\n {\n \"Code\": \"MS\",\n \"Name\": \"Montserrat\"\n },\n {\n \"Code\": \"MA\",\n \"Name\": \"Morocco\"\n },\n {\n \"Code\": \"MZ\",\n \"Name\": \"Mozambique\"\n },\n {\n \"Code\": \"MM\",\n \"Name\": \"Myanmar\"\n },\n {\n \"Code\": \"NA\",\n \"Name\": \"Namibia\"\n },\n {\n \"Code\": \"NR\",\n \"Name\": \"Nauru\"\n },\n {\n \"Code\": \"NP\",\n \"Name\": \"Nepal\"\n },\n {\n \"Code\": \"NL\",\n \"Name\": \"Netherlands\"\n },\n {\n \"Code\": \"AN\",\n \"Name\": \"Netherlands Antilles\"\n },\n {\n \"Code\": \"NC\",\n \"Name\": \"New Caledonia\"\n },\n {\n \"Code\": \"NZ\",\n \"Name\": \"New Zealand\"\n },\n {\n \"Code\": \"NI\",\n \"Name\": \"Nicaragua\"\n },\n {\n \"Code\": \"NE\",\n \"Name\": \"Niger\"\n },\n {\n \"Code\": \"NG\",\n \"Name\": \"Nigeria\"\n },\n {\n \"Code\": \"NU\",\n \"Name\": \"Niue\"\n },\n {\n \"Code\": \"NF\",\n \"Name\": \"Norfolk Island\"\n },\n {\n \"Code\": \"MP\",\n \"Name\": \"Northern Mariana Islands\"\n },\n {\n \"Code\": \"NO\",\n \"Name\": \"Norway\"\n },\n {\n \"Code\": \"OM\",\n \"Name\": \"Oman\"\n },\n {\n \"Code\": \"PK\",\n \"Name\": \"Pakistan\"\n },\n {\n \"Code\": \"PW\",\n \"Name\": \"Palau\"\n },\n {\n \"Code\": \"PA\",\n \"Name\": \"Panama\"\n },\n {\n \"Code\": \"PG\",\n \"Name\": \"Papua New Guinea\"\n },\n {\n \"Code\": \"PY\",\n \"Name\": \"Paraguay\"\n },\n {\n \"Code\": \"PE\",\n \"Name\": \"Peru\"\n },\n {\n \"Code\": \"PH\",\n \"Name\": \"Philippines\"\n },\n {\n \"Code\": \"PN\",\n \"Name\": \"Pitcairn\"\n },\n {\n \"Code\": \"PL\",\n \"Name\": \"Poland\"\n },\n {\n \"Code\": \"PT\",\n \"Name\": \"Portugal\"\n },\n {\n \"Code\": \"PR\",\n \"Name\": \"Puerto Rico\"\n },\n {\n \"Code\": \"QA\",\n \"Name\": \"Qatar\"\n },\n {\n \"Code\": \"RE\",\n \"Name\": \"Reunion\"\n },\n {\n \"Code\": \"RO\",\n \"Name\": \"Romania\"\n },\n {\n \"Code\": \"RU\",\n \"Name\": \"Russian Federation\"\n },\n {\n \"Code\": \"RW\",\n \"Name\": \"Rwanda\"\n },\n {\n \"Code\": \"BL\",\n \"Name\": \"Saint Barthelemy\"\n },\n {\n \"Code\": \"SH\",\n \"Name\": \"Saint Helena\"\n },\n {\n \"Code\": \"KN\",\n \"Name\": \"Saint Kitts and Nevis\"\n },\n {\n \"Code\": \"LC\",\n \"Name\": \"Saint Lucia\"\n },\n {\n \"Code\": \"MF\",\n \"Name\": \"Saint Martin\"\n },\n {\n \"Code\": \"PM\",\n \"Name\": \"Saint Pierre and Miquelon\"\n },\n {\n \"Code\": \"VC\",\n \"Name\": \"Saint Vincent and the Grenadines\"\n },\n {\n \"Code\": \"WS\",\n \"Name\": \"Samoa\"\n },\n {\n \"Code\": \"SM\",\n \"Name\": \"San Marino\"\n },\n {\n \"Code\": \"ST\",\n \"Name\": \"Sao Tome and Principe\"\n },\n {\n \"Code\": \"SA\",\n \"Name\": \"Saudi Arabia\"\n },\n {\n \"Code\": \"SN\",\n \"Name\": \"Senegal\"\n },\n {\n \"Code\": \"RS\",\n \"Name\": \"Serbia\"\n },\n {\n \"Code\": \"SC\",\n \"Name\": \"Seychelles\"\n },\n {\n \"Code\": \"SL\",\n \"Name\": \"Sierra Leone\"\n },\n {\n \"Code\": \"SG\",\n \"Name\": \"Singapore\"\n },\n {\n \"Code\": \"SX\",\n \"Name\": \"Sint Maarten (Dutch part)\"\n },\n {\n \"Code\": \"SK\",\n \"Name\": \"Slovak Republic\"\n },\n {\n \"Code\": \"SI\",\n \"Name\": \"Slovenia\"\n },\n {\n \"Code\": \"SB\",\n \"Name\": \"Solomon Islands\"\n },\n {\n \"Code\": \"SO\",\n \"Name\": \"Somalia\"\n },\n {\n \"Code\": \"ZA\",\n \"Name\": \"South Africa\"\n },\n {\n \"Code\": \"GS\",\n \"Name\": \"South Georgia and the South Sandwich Islands\"\n },\n {\n \"Code\": \"KR\",\n \"Name\": \"South Korea\"\n },\n {\n \"Code\": \"ES\",\n \"Name\": \"Spain\"\n },\n {\n \"Code\": \"LK\",\n \"Name\": \"Sri Lanka\"\n },\n {\n \"Code\": \"SR\",\n \"Name\": \"Suriname\"\n },\n {\n \"Code\": \"SJ\",\n \"Name\": \"Svalbard and Jan Mayen\"\n },\n {\n \"Code\": \"SZ\",\n \"Name\": \"Swaziland\"\n },\n {\n \"Code\": \"SE\",\n \"Name\": \"Sweden\"\n },\n {\n \"Code\": \"CH\",\n \"Name\": \"Switzerland\"\n },\n {\n \"Code\": \"TW\",\n \"Name\": \"Taiwan\"\n },\n {\n \"Code\": \"TJ\",\n \"Name\": \"Tajikistan\"\n },\n {\n \"Code\": \"TZ\",\n \"Name\": \"Tanzania\"\n },\n {\n \"Code\": \"TH\",\n \"Name\": \"Thailand\"\n },\n {\n \"Code\": \"TL\",\n \"Name\": \"Timor-Leste\"\n },\n {\n \"Code\": \"TG\",\n \"Name\": \"Togo\"\n },\n {\n \"Code\": \"TK\",\n \"Name\": \"Tokelau\"\n },\n {\n \"Code\": \"TO\",\n \"Name\": \"Tonga\"\n },\n {\n \"Code\": \"TT\",\n \"Name\": \"Trinidad and Tobago\"\n },\n {\n \"Code\": \"TN\",\n \"Name\": \"Tunisia\"\n },\n {\n \"Code\": \"TR\",\n \"Name\": \"Turkey\"\n },\n {\n \"Code\": \"TM\",\n \"Name\": \"Turkmenistan\"\n },\n {\n \"Code\": \"TC\",\n \"Name\": \"Turks and Caicos Islands\"\n },\n {\n \"Code\": \"TV\",\n \"Name\": \"Tuvalu\"\n },\n {\n \"Code\": \"UG\",\n \"Name\": \"Uganda\"\n },\n {\n \"Code\": \"UA\",\n \"Name\": \"Ukraine\"\n },\n {\n \"Code\": \"AE\",\n \"Name\": \"United Arab Emirates\"\n },\n {\n \"Code\": \"GB\",\n \"Name\": \"United Kingdom\"\n },\n {\n \"Code\": \"US\",\n \"Name\": \"United States\"\n },\n {\n \"Code\": \"UM\",\n \"Name\": \"United States Minor Outlying Islands\"\n },\n {\n \"Code\": \"UY\",\n \"Name\": \"Uruguay\"\n },\n {\n \"Code\": \"UZ\",\n \"Name\": \"Uzbekistan\"\n },\n {\n \"Code\": \"VU\",\n \"Name\": \"Vanuatu\"\n },\n {\n \"Code\": \"VA\",\n \"Name\": \"Vatican City State (Holy See)\"\n },\n {\n \"Code\": \"VE\",\n \"Name\": \"Venezuela\"\n },\n {\n \"Code\": \"VN\",\n \"Name\": \"Viet Nam\"\n },\n {\n \"Code\": \"VG\",\n \"Name\": \"Virgin Islands, British\"\n },\n {\n \"Code\": \"VI\",\n \"Name\": \"Virgin Islands, U.S.\"\n },\n {\n \"Code\": \"WF\",\n \"Name\": \"Wallis and Fortuna Islands\"\n },\n {\n \"Code\": \"EH\",\n \"Name\": \"Western Sahara (provisional)\"\n },\n {\n \"Code\": \"YE\",\n \"Name\": \"Yemen\"\n },\n {\n \"Code\": \"ZM\",\n \"Name\": \"Zambia\"\n },\n {\n \"Code\": \"ZW\",\n \"Name\": \"Zimbabwe\"\n }\n]"}],"_postman_id":"98bdfea8-5cca-4ba3-a8d9-07d7dfe30372"},{"name":"Find Region/State","id":"1218bbe5-270d-4c77-8a54-88251506b7eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"CountryCode\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/country/region","description":"Retrieve a list of regions/states for a specified country including their ISO code. The region code is to be used when populating the beneficiary's address region during creation.
\nRetrieve a list of all suburbs/cities for a specified country which is to be used when populating a beneficiary's address city during creation.
\nSearch for bank details relating to a bank national ID. A national ID is the bank code assigned by a central bank. This is commonly referred to as a sort code, routing code, ABA, BSB number etc. These bank details can be used when validating or creating a beneficiary template.
\nSearch for bank details relating to a bank SWIFTBIC. These bank details can be used when validating or creating a beneficiary template.
\nRetrieve a list of valid Purpose Of Payments including their POP (PurposeOfPayment) Codes. A valid AFEX POP Code must be passed in Remittance Line 2 when creating a beneficiary. These POP codes can also be used in the Optional 'POP Code' fields for POST api/v2/trades/create and api/v2/payments/create.
\nThis API method allows you to validate a beneficiary's IBAN in which the associated SWIFT BIC will also be returned. The IBAN is the standard international bank account number format used by European banks and is also used in some non-European countries. The bank SWIFTBIC will be derived from the IBAN.
\nAFEX's beneficiary reference data collection includes a number of methods which help to support clients whilst creating new beneficiaries. Importantly, these reference methods help to populate the corresponding fields with the Create Beneficiary and Update Beneficiary requests.
\n","event":[{"listen":"prerequest","script":{"id":"f41e7e22-03a6-438f-a980-53d47253d43f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"31855d03-2bf6-4863-a578-1cec865f6809","type":"text/javascript","exec":[""]}}],"_postman_id":"1b53d162-9e67-42ce-a749-e68a2a4aa26e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}}],"id":"c508658b-84d5-475d-82d0-ebb7e4b67c3d","description":"AFEX's Beneficiary Management features allow our partners and clients to create and manage their own trusted payees (beneficiaries) list with AFEX. The following Beneficiary Management API collection will include a number of API methods that will help you create and manage an array of different beneficiary types based on your payment requirements.
\n
\nFurthermore, due to AFEX's own integration with third-party banking databases, our Create and Update Beneficiary methods apply thorough validation checks on beneficiary creation requests and by doing so return dynamic responses to help clients provide the correct details. These informative validation checks help to ensure our client's outgoing payments to newly created beneficiaries are successful.
Parameter Definitions
\n","event":[{"listen":"prerequest","script":{"id":"0cfb2d79-66c3-44b3-9f65-4f753c095932","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"66bfabf4-4ab8-4091-bbec-8f0db295669a","type":"text/javascript","exec":[""]}}],"_postman_id":"c508658b-84d5-475d-82d0-ebb7e4b67c3d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}},{"name":"Trades","item":[{"name":"Get Quote","id":"2f567030-27cd-4ef1-a145-fb584fbda51d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{AFEXAPI.Endpoint}}api/v2/quote?CurrencyPair=&Amount=&IsAmountSettlement=&OptionDate=&ValueDate=","description":"This API method allows you to request a rate quote for a specified currency pair and value date. Please note, next available value dates are returned by api/v2/ValueDates.
\nThe quote ID returned can then be used when calling either api/v2/Trades/Create or api/Forwards/Create to secure the rate for a trade at the quoted rate (providing the quote has not yet expired). A quote is valid for 30 seconds.
\nRequest Parameters
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}},"urlObject":{"path":["v2","quote"],"host":["{{AFEXAPI.Endpoint}}api"],"query":[{"key":"CurrencyPair","value":""},{"key":"Amount","value":""},{"key":"IsAmountSettlement","value":""},{"key":"OptionDate","value":""},{"key":"ValueDate","value":""}],"variable":[]}},"response":[],"_postman_id":"2f567030-27cd-4ef1-a145-fb584fbda51d"},{"name":"Create Trade","id":"89fe1ec1-a42d-4d9e-90f0-2a6291d937a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"AccountNumber\": \"\",\n \"Amount\": \"\",\n \"CP_Ref\":\"\",\n \"FeeAmt\": \"\",\n \"IsAmountSettlement\": \"\",\n \"Note\": \"\",\n \"OrderingPartyIsPartner\":\"\",\n \"POPCode\": \"\",\n \"PurposeOfPayment\": \"\",\n \"QuoteID\": \"\",\n \"RemitId\":\"\",\n \"SettlementCcy\": \"\",\n \"TradeCcy\": \"\",\n \"ValueDate\": \"\",\n \"VendorId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/v2/trades/create","description":"Create a trade or outright forward to convert one currency to another. Trades can be booked for cash value (today), tom value (next available business day), spot value (2 business days) or forward (beyond two business days). Trade proceeds can be paid directly to a beneficiary by supplying a VendorID, or to the client's funding balance currency account with AFEX i.e. a funding trade where a VendorID / beneficiary is NOT supplied.
\nThis recent addition to AFEX's DirectAPI enables you to create Spot and Outright Forward trades in batch. The 'Create Batch Trades' method allows users to submit multiple trade creation requests all in this single API method.
\n
\nSimilar to AFEX's POST Create Trade method, converted funds can be paid directly to multiple beneficiaries by supplying their Vendor IDs, or to the client's own funding balance currency account with AFEX.
\n
\nPlease note that this POST Create Batch Trades method can only support up to 100 trade entries at a time in a single request.
Retrieve the details of a specific Trade by passing its 'TradeNumber' (which is returned by the API in the Create Trade response). Here you will see the historic details of the trade including its status.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}},"urlObject":{"path":["v2","trades"],"host":["{{AFEXAPI.Endpoint}}api"],"query":[{"key":"Id","value":""}],"variable":[]}},"response":[{"id":"1b2db16b-041f-4817-b2da-afb5cbcb2b37","name":"200 Trade History (Date Range)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"API-Key","value":"{{API-Key}}"}],"url":{"raw":"{{URL}}api/trades?StartDate=05/01/2018&EndDate=05/29/2018","host":["{{URL}}api"],"path":["trades"],"query":[{"key":"Id","value":"","description":"Id can be passed to retrieve single transaction details","disabled":true},{"key":"StartDate","value":"05/01/2018","description":"Start date in the date range filter. YYYY/MM/DD"},{"key":"EndDate","value":"05/29/2018","description":"End date in the date range filter. YYYY/MM/DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"5860","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 29 May 2018 09:30:18 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","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)"}],"cookie":[],"responseTime":null,"body":"[{\"TradeNumber\":5603375,\"Amount\":1500.0,\"RemainingBalance\":1500.0,\"Rate\":1.3129,\"BeneficiaryName\":\"\",\"TradeCcy\":\"USD\",\"SettlementAmt\":1142.51,\"SettlementCcy\":\"GBP\",\"TradeDate\":\"2018-05-29T02:13:46\",\"ValueDate\":\"2018-06-15T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5601226,\"Amount\":300.0,\"RemainingBalance\":300.0,\"Rate\":1.3879,\"BeneficiaryName\":\"\",\"TradeCcy\":\"GBP\",\"SettlementAmt\":416.37,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-23T00:00:00\",\"ValueDate\":\"2018-05-25T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5601225,\"Amount\":666.0,\"RemainingBalance\":666.0,\"Rate\":1.5263,\"BeneficiaryName\":\"\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":1016.52,\"SettlementCcy\":\"CAD\",\"TradeDate\":\"2018-05-23T10:23:38\",\"ValueDate\":\"2018-07-12T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5601224,\"Amount\":50.0,\"RemainingBalance\":50.0,\"Rate\":1.5225,\"BeneficiaryName\":\"\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":76.13,\"SettlementCcy\":\"CAD\",\"TradeDate\":\"2018-05-23T10:22:35\",\"ValueDate\":\"2018-05-28T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5601206,\"Amount\":100.0,\"RemainingBalance\":100.0,\"Rate\":1.1902,\"BeneficiaryName\":\"\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":119.02,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-23T00:00:00\",\"ValueDate\":\"2018-05-25T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5599266,\"Amount\":100.0,\"RemainingBalance\":100.0,\"Rate\":1.1917,\"BeneficiaryName\":\"Catalano and Cosulich Shipping Services\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":119.17,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-17T15:08:55\",\"ValueDate\":\"2018-05-21T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5599265,\"Amount\":100.0,\"RemainingBalance\":100.0,\"Rate\":1.193,\"BeneficiaryName\":\"Accorinvest-Novotel Suites\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":119.3,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-17T15:06:53\",\"ValueDate\":\"2018-05-21T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5598670,\"Amount\":400.0,\"RemainingBalance\":400.0,\"Rate\":1.1996,\"BeneficiaryName\":\"\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":479.84,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-17T00:00:00\",\"ValueDate\":\"2018-05-21T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5598669,\"Amount\":200.0,\"RemainingBalance\":200.0,\"Rate\":1.1996,\"BeneficiaryName\":\"\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":239.92,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-17T00:00:00\",\"ValueDate\":\"2018-05-21T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5597968,\"Amount\":3000.0,\"RemainingBalance\":3000.0,\"Rate\":1.1989,\"BeneficiaryName\":\"\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":3596.7,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-16T00:00:00\",\"ValueDate\":\"2018-05-18T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5595649,\"Amount\":60.0,\"RemainingBalance\":60.0,\"Rate\":1.2659,\"BeneficiaryName\":\"SofyaDraftCAD\",\"TradeCcy\":\"CAD\",\"SettlementAmt\":47.4,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-10T08:28:11\",\"ValueDate\":\"2018-05-11T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5594389,\"Amount\":100.0,\"RemainingBalance\":100.0,\"Rate\":0.7591,\"BeneficiaryName\":\"37471 UAT API AUD 1\",\"TradeCcy\":\"AUD\",\"SettlementAmt\":75.91,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-07T15:24:16\",\"ValueDate\":\"2018-05-09T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5592101,\"Amount\":15.0,\"RemainingBalance\":15.0,\"Rate\":0.7567,\"BeneficiaryName\":\"AUD Ops Test\",\"TradeCcy\":\"AUD\",\"SettlementAmt\":11.35,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-01T14:09:00\",\"ValueDate\":\"2018-05-03T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5592100,\"Amount\":10.0,\"RemainingBalance\":10.0,\"Rate\":1.2116,\"BeneficiaryName\":\"Alfons Haar Mashinenbau GmbH and Co\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":12.12,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-01T14:07:50\",\"ValueDate\":\"2018-05-03T00:00:00\",\"Status\":\"Verified\"}]"},{"id":"4b002091-d2ef-4455-a322-90373d7ac8f1","name":"200 Trade History (ALL)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"API-Key","value":"{{API-Key}}"}],"url":{"raw":"{{URL}}api/trades","host":["{{URL}}api"],"path":["trades"],"query":[{"key":"Id","value":"","description":"Id can be passed to retrieve single transaction details","disabled":true},{"key":"StartDate","value":"","description":"Start date in the date range filter. YYYY/MM/DD","disabled":true},{"key":"EndDate","value":"","description":"End date in the date range filter. YYYY/MM/DD","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"54438","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Tue, 29 May 2018 09:15:17 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","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)"}],"cookie":[],"responseTime":null,"body":"[{\"TradeNumber\":5603375,\"Amount\":1500.0,\"RemainingBalance\":1500.0,\"Rate\":1.3129,\"BeneficiaryName\":\"\",\"TradeCcy\":\"USD\",\"SettlementAmt\":1142.51,\"SettlementCcy\":\"GBP\",\"TradeDate\":\"2018-05-29T02:13:46\",\"ValueDate\":\"2018-06-15T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5601226,\"Amount\":300.0,\"RemainingBalance\":300.0,\"Rate\":1.3879,\"BeneficiaryName\":\"\",\"TradeCcy\":\"GBP\",\"SettlementAmt\":416.37,\"SettlementCcy\":\"USD\",\"TradeDate\":\"2018-05-23T00:00:00\",\"ValueDate\":\"2018-05-25T00:00:00\",\"Status\":\"Verified\"},{\"TradeNumber\":5601225,\"Amount\":666.0,\"RemainingBalance\":666.0,\"Rate\":1.5263,\"BeneficiaryName\":\"\",\"TradeCcy\":\"EUR\",\"SettlementAmt\":1016.52,\"SettlementCcy\":\"CAD\",\"TradeDate\":\"2018-05-23T10:23:38\",\"ValueDate\":\"2018-07-12T00:00:00\",\"Status\":\"Verified\"}]"},{"id":"ba87fa92-19e2-4ca8-ac8c-19f91f0f1e93","name":"Single Trade ID 200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"API-Key","value":"{{API-Key}}"}],"url":{"raw":"{{URL}}api/trades?id=5603375","host":["{{URL}}api"],"path":["trades"],"query":[{"key":"Id","value":"5603375","description":"Id can be passed to retrieve single transaction details","disabled":true},{"key":"StartDate","value":"","description":"Start date in the date range filter. YYYY/MM/DD","disabled":true},{"key":"EndDate","value":"","description":"End date in the date range filter. YYYY/MM/DD","disabled":true},{"key":"id","value":"5603375"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 16 Jan 2019 06:12:23 GMT"},{"key":"Content-Length","value":"276"}],"cookie":[],"responseTime":null,"body":"{\n \"TradeNumber\": 5603375,\n \"Amount\": 1500,\n \"RemainingBalance\": 1500,\n \"Rate\": 1.3129,\n \"BeneficiaryName\": \"\",\n \"TradeCcy\": \"USD\",\n \"SettlementAmt\": 1142.51,\n \"SettlementCcy\": \"GBP\",\n \"TradeDate\": \"2018-05-29T02:13:46\",\n \"ValueDate\": \"2018-06-15T00:00:00\",\n \"Status\": \"Verified\",\n \"Funded\": false,\n \"Note\": \"\"\n}"},{"id":"e96194f7-1f65-44cf-bda0-8ebb26b66254","name":"Trade History","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"API-Key","value":"{{API-Key}}"}],"url":{"raw":"{{URL}}api/trades?Id=Optional&StartDate=Optional&EndDate=Optional","host":["{{URL}}api"],"path":["trades"],"query":[{"key":"Id","value":"Optional","description":"AFEX TradeNumber. The Id can be passed to retrieve details for a single transaction only. "},{"key":"StartDate","value":"Optional","description":"Start date in the date range filter. YYYY/MM/DD"},{"key":"EndDate","value":"Optional","description":"End date in the date range filter. YYYY/MM/DD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"41cd87a9-379d-4272-b35d-9065fc33d9f8"},{"name":"Trade History","id":"56660fa3-5c35-472c-a718-087557176830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"PageSize\":\"\",\r\n \"PageNumber\":\"\",\r\n \"RemitId\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/v2/trades","description":"This API method lets you retrieve the details for multiple trades booked over a specified date range. Please note that the widest date range window that can be search is 120 day (i.e. Current Day - 120 days). Alternatively, if you don't specify a start and end date the API response will return all trade history in the past 120 days by default.
\nRetrieve an image of a confirmation for a specified trade or a payment (SWIFT) confirmation. This is the PDF confirmation that AFEX emails to Communication Recipients set up on the client's account.
\nRequest a rate quote for a predelivery on an existing outright forward.
\nThe quote ID returned can then be supplied when calling api/predelivery/create. A quote is valid for 30 seconds.
\nRequired. YYYY/MM/DD. The date the trade currency funds will be paid out. For a predelivery, the value date cannot be greater than 14 days from the date of creation of the predelivery (inclusive of weekends and public holidays).
\n","type":"text/plain"},"key":"ValueDate","value":""},{"description":{"content":"Required. TradeNumber (AFEXtransaction ID) of parent forward
\n","type":"text/plain"},"key":"ParentTradeNumber","value":""}],"variable":[]}},"response":[],"_postman_id":"e8590b71-d3ae-424d-b31e-80e1b3bcda10"},{"name":"Create Predelivery on Outright Forward","id":"16342687-72ef-4f3a-b6dd-f85995bc1645","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"AccountNumber\": \"\",\n \"Amount\": \"\",\n \"FeeAmt\":\"\",\n \"Note\": \"\",\n \"OrderingPartyIsPartner\":\"\",\n \"POPCode\": \"\",\n \"PurposeOfPayment\": \"\",\n \"RemitId\":\"\",\n \"ValueDate\": \"\",\n \"VendorId\": \"\",\n \"ParentTradeNumber\": \"\",\n \"QuoteID\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/v2/predelivery/create","description":"Create a predelivery (drawdown) on an outright forward.
\nAFEX's Trades API collection provides our partners and clients with vast FX transaction capabilities including Spot trades, Outright Forwards and Predelivery. By integrating with these API methods clients will be able to retrieve quotes and lock-in favorable rates before proceeding to book the transaction. Trade details, statuses and even confirmations can then also be requested via this API collection.
\n","event":[{"listen":"prerequest","script":{"id":"30de10a7-e383-4a9d-baed-4a1421aec814","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cd237189-8f44-45c1-9b81-00120ee93b93","type":"text/javascript","exec":[""]}}],"_postman_id":"fe4da4a4-6bc0-4462-a630-cb56c47e02cd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}},{"name":"Window Forwards","item":[{"name":"Create Window Forward","id":"b80a9dcf-3628-46d6-96be-215c3b94563d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Amount\": \"\",\n \"AccountNumber\": \"\",\n \"CP_Ref\":\"\",\n \"IsAmountSettlement\": \"\",\n \"Note\": \"\",\n \"OptionDate\": \"\",\n \"QuoteId\": \"\",\n \"SettlementCcy\": \"\",\n \"TradeCcy\": \"\",\n \"ValueDate\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/forwards/create","description":"This API method allows you to create a Window Forward in order to convert one currency to another at a convenient rate. Window Forward trades must be booked beyond Spot value (beyond two business days). Both an Option Date and Window date must be specified which will specify the window in which funds can be drawndown from the booked forward contract.
\nFollowing the booking of a Window Forward trade, this API method allows you to create a drawdown from the forward contract to your funding balance or as a payment directly to a third-party beneficiary. Please note you can only drawdown a Window Forward between its option (start) date and value date window.
\nRetrieve the details of a specific Window Forward by passing its 'ReferenceNumber' (which is returned by the API in the Create Window Forward response). Here you will see the historic details of the Forward including its status and remaining balance.
\nThis API method lets you retrieve the details for multiple Window Forwards booked over a specified date range. Please note that the widest date range window that can be search is 120 day (i.e. Current Day - 120 days). Alternatively, if you don't specify a start and end date the API response will return all Window Forward history in the past 120 days by default.
\nAFEX's Window Forwards API collection provides further FX transaction capabilities in the form of Window Forwards and Drawdown methods. These API functions grant our clients with greater hedging flexibility by allowing them to exchange/drawdown funds before the maturity of their forward contract with AFEX. Similar to our core Trade APIs, clients can request rate quotes as well as retrieve historic forward trade details, statuses and confirmations with this collection.
\n","event":[{"listen":"prerequest","script":{"id":"307f7492-c5f5-41d5-b6ea-b4641308ae8f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e5ea338c-0840-4df9-b6d0-a12450933097","type":"text/javascript","exec":[""]}}],"_postman_id":"db7ebe87-28e9-4c9e-8acc-83a6bbd2a948","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}},{"name":"Payments","item":[{"name":"Create Payment","id":"56f3def2-4c54-4782-9847-25be37cdd974","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Amount\": \"\",\n \"CP_Ref\": \"\",\n \"Currency\": \"\",\n \"FeeAmt\": \"\",\n \"Note\":\"\",\n \"OrderingPartyIsPartner\":\"\",\n \"PaymentDate\": \"\",\n \"PopCode\": \"\",\n \"PurposeofPayment\": \"\",\n \"ReferenceNumber\": \"\",\n \"RemitId\":\"\",\n \"VendorId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/v2/payments/create","description":"This API method allows you to create scheduled payment out to third-party payee (beneficiary) or an internal transfer to an instant beneficiary (see POST Create Instant Payment Beneficiary for more information). Applicable payment fees will be detailed to you by your AFEX Account Manager and will also be displayed in the API responses for Trade and Payment creation. Please Note, whilst there will be payment fees associated with third-party beneficiary payments, there are no such fees for instant payments as they are processed entirely within AFEX's systems.
\nThis recent addition to AFEX's DirectAPI enables you to create scheduled payment requests in batch. The 'Create Batch Payments' method allows users to submit multiple scheduled payment creation requests all in this single API method.
\n
\nSimilar to AFEX's POST Create Payment method, you can schedule a payment using your AFEX account held funds to multiple beneficiaries by supplying their Vendor IDs.
\n
\nPlease note that this POST Create Batch Payments method can only support up to 100 payment entries at a time in a single request. There will also be fees associated with each third-party beneficiary payment.
Retrieve the details of a specific Payment by passing its 'ReferenceNumber' (which is returned by the API in the Create Payment response). Here you will see the historic details of the payment including its status.
\nThis API method lets you retrieve the details for multiple payments booked over a specified date range. Please note that the widest date range window that can be search is 120 day (i.e. Current Day - 120 days). Alternatively, if you don't specify a start and end date the API response will return all payment history in the past 120 days by default.
\nAFEX's Payments API collection allows our partners and clients to schedule third-party payments out to approved payees (beneficiaries) as created with POST Create Beneficiary. Based on the beneficiary type created, AFEX's Payment APIs utilise our vast established payment rails to deliver the sent funds to the chosen recipient. Similar to trade creation, clients will be able to also retrieve historic payment details and status as well as payment confirmations (including MT103 SWIFT confirmations where viable).
\n","event":[{"listen":"prerequest","script":{"id":"21af1e3f-a527-49f3-97b9-d0fa46cf8c9b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ddbb2cd2-0037-4c86-8f61-f7c833c5ec4b","type":"text/javascript","exec":[""]}}],"_postman_id":"a5f36be9-a90e-434f-a658-8f662d89e63c","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}},{"name":"Reference","item":[{"name":"Currency List","id":"c297d7e4-5862-4893-9311-c6ea96809f0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{AFEXAPI.Endpoint}}api/currency","description":"Retrieve details for all of AFEX's supported currencies. The returned results include the ISO currency code which is required when creating beneficiaries and trades. The response will also include available clearing methods per currency i.e. whether High Value (SWIFT) and / or Low Value (local clearing). These details are used to determine if high or low value clearing can be specified when validating and/or creating a beneficiary in that currency.
\nThis API method allows you to get the overall balances that you or a client holds in each foreign currency funding balance (Vostro account) a client has with AFEX. Furthermore if a currency is supplied in the optional 'currency' field , a funding balance detail report can be retrieved which will include all debits and credits for that currency balance within the current month will be returned. Alternatively, a specified date range can be populated to return transaction activity within that window. Please note that the widest date range window that can be search is 120 day (i.e. Current Day - 120 days).
\nNote: A Vostro account / funding balance is automatically created when a client first trades in a currency. The Create Funding Balance - Instant payments method can be used to create vostro accounts manually when required.
\nReturns approved trading limits and available limits for cash, tom, spot and forward trades.
Please note, clients approved for forwards are also limited to booking for value dates within their maximum approved forward tenor. Data on a client's approved forward tenor is not available via the API.
All limit amounts are expressed in the client's base currency.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}},"urlObject":{"path":["credit"],"host":["{{AFEXAPI.Endpoint}}api"],"query":[],"variable":[]}},"response":[{"id":"7259124c-885f-4b8e-91d4-bf12bdcab0c5","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"url":"{{URL}}api/credit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"123","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 27 Feb 2018 14:42:42 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"{\"SpotLimit\":15000000.0,\"AvailableSpotLimit\":15000000.0,\"ForwardLimit\":15000000.0,\"AvailableForwardLimit\":14998417.9162413}"},{"id":"9cb60ecf-2a7a-4990-b9af-41ef3cd39397","name":"Credit Limits","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{URL}}api/credit"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"07731c27-b67e-4974-8988-359088966b4c"},{"name":"Get Rate","id":"f639736d-49ee-419b-9ee6-ca9d78e018e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{AFEXAPI.Endpoint}}api/rates?CurrencyPair=&ValueType","description":"Request a rate for a specified currency pair.
\nThis is an indicative rate only. Use api/quote for securing a quote and booking a transaction.
Required. ISO 3 character currency code for each currency in the pair e.g. USDAUD. The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair.
\n","type":"text/plain"},"key":"CurrencyPair","value":""},{"description":{"content":"Optional. Specify CASH, TOM or SPOT. The default is SPOT if not specified.
\n","type":"text/plain"},"key":"ValueType","value":""}],"variable":[]}},"response":[{"id":"1f1e52e1-718a-40dd-8413-50a940c21e30","name":"Get Rate","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/rates?CurrencyPair=","host":["{{URL}}api"],"path":["rates"],"query":[{"key":"CurrencyPair","value":"","description":"(Mandatory) The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. "},{"key":"ValueType","value":null,"description":"(Optional) Specify CASH, SPOT or TOM rate","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"23a2f8db-4851-4082-ab2d-9d4084491855","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/rates?CurrencyPair=CADAUD","host":["{{URL}}api"],"path":["rates"],"query":[{"key":"CurrencyPair","value":"CADAUD","description":"(Mandatory) The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. "},{"key":"ValueType","value":null,"description":"(Optional) Specify CASH, SPOT or TOM rate","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"49","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 27 Feb 2018 14:43:17 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"{\"Rate\":0.9918,\"InvertedRate\":1.0083,\"Terms\":\"E\"}"},{"id":"8e4d97a2-2709-4a64-9501-50b7f85f37ea","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/rates?CurrencyPair=CADAUD&ValueType=TOM","host":["{{URL}}api"],"path":["rates"],"query":[{"key":"CurrencyPair","value":"CADAUD","description":"(Mandatory) The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. "},{"key":"ValueType","value":"TOM","description":"(Optional) Specify CASH, SPOT or TOM rate"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"49","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 27 Feb 2018 14:43:45 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"{\"Rate\":0.9919,\"InvertedRate\":1.0082,\"Terms\":\"E\"}"}],"_postman_id":"f639736d-49ee-419b-9ee6-ca9d78e018e6"},{"name":"Settlement Account Details","id":"40dd2038-4f9e-4d24-ac7d-18db4c0a30ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{AFEXAPI.Endpoint}}api/ssi/GetSSI?Currency","description":"This API method allows you to retrieve AFEX's Standard Settlement Instructions (SSIs). These AFEX bank account details can be displayed to a client when they need to wire in currency funds in order to settle a trade and/or outgoing payment. AFEX has a number of global settlement accounts which allows clients to remit settlement funds locally.
\nRequired. 3 character ISO currency code
\n","type":"text/plain"},"key":"Currency","value":""}],"variable":[]}},"response":[{"id":"807ef177-8933-4891-8e1e-88c307e6df96","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/ssi/GetSSI?Currency=AUD","host":["{{URL}}api"],"path":["ssi","GetSSI"],"query":[{"key":"Currency","value":"AUD","description":"(Required) ISO currency code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"184","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 27 Feb 2018 14:44:17 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"[{\"Currency\":\"AUD\",\"PaymentInstructions\":\"Remit Funds to: Bank of America, Sydney\\rSWIFT: BOFAAUSX\\rBSB: 232001\\rAccount No: 14849037\\rBeneficiary: Associated Foreign Exchange, Inc.\"}]"},{"id":"9a660331-602f-41bc-a999-ade9db51ce89","name":"Settlement Account Details","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/ssi/GetSSI?Currency","host":["{{URL}}api"],"path":["ssi","GetSSI"],"query":[{"key":"Currency","value":null,"description":"(Required) ISO currency code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a746310b-4039-4db3-ba85-1b576ae04957","name":"400 Bad Request","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/ssi/GetSSI?Currency=","host":["{{URL}}api"],"path":["ssi","GetSSI"],"query":[{"key":"Currency","value":"","description":"(Required) ISO currency code"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"27","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 27 Feb 2018 14:44:33 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"\"The currency is required.\""}],"_postman_id":"40dd2038-4f9e-4d24-ac7d-18db4c0a30ad"},{"name":"Get Value Date","id":"e4b22414-eb2b-4f5c-ba44-c606a2fa3b6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{AFEXAPI.Endpoint}}api/v2/valuedates?CurrencyPair=&ValueType=","description":"The value date is the date in which the trade proceeds are paid out to either the beneficiary, or in the case of a funding trade, to the client's AFEX currency funding balance. Value dates must be business days for both the buy (trade) and sell (settlement) currencies. The AFEX value date calendar is based on local business dates, business dates in the country of the trade and settlement currency and local payment cut off times by currency.
\nAFEX's api/v2/Valuedates method returns next available value date for the tenor populated in the request. The supported tenors include CASH (value today), TOM (value next available business day), or SPOT (value 2 business days). If the tenor specified is not allowed for the currency due to AFEX currency rules, an error message will be returned rather than a date. Value dates beyond spot i.e. forward value dates, are not available via this method. The GET Holidays method can be used however to help check upcoming currency/country holidays. The returned value dates can then be used when creating trades and payments.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}},"urlObject":{"path":["v2","valuedates"],"host":["{{AFEXAPI.Endpoint}}api"],"query":[{"key":"CurrencyPair","value":""},{"key":"ValueType","value":""}],"variable":[]}},"response":[{"id":"11f1b223-57ec-4470-986e-b6851cac4430","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/valuedates?CurrencyPair=USDAUD&ValueType","host":["{{URL}}api"],"path":["valuedates"],"query":[{"key":"CurrencyPair","value":"USDAUD","description":"(Mandatory) The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. "},{"key":"ValueType","value":null,"description":"(Optional) CASH, TOM or SPOT"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"12","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 28 Feb 2018 14:25:24 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"\"2018/03/02\""},{"id":"215daca1-1be1-419f-9922-745e10ff5204","name":"Get Value Date","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/valuedates?CurrencyPair&ValueType","host":["{{URL}}api"],"path":["valuedates"],"query":[{"key":"CurrencyPair","value":null,"description":"(Mandatory) The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. "},{"key":"ValueType","value":null,"description":"(Optional) CASH, TOM or SPOT"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"974d6a5c-22e4-43ce-8d7c-ec3440994f36","name":"Get Value Date Cash not allowed status 400","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/valuedates?CurrencyPair=USDAFN&ValueType=CASH","host":["{{URL}}api"],"path":["valuedates"],"query":[{"key":"CurrencyPair","value":"USDAFN","description":"(Mandatory) The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. "},{"key":"ValueType","value":"CASH","description":"(Optional) CASH, TOM or SPOT"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 16 Jan 2019 22:50:33 GMT"},{"key":"Content-Length","value":"49"}],"cookie":[],"responseTime":null,"body":"\"This AFN currency is not allowed for Cash date.\""},{"id":"e57f9809-1e96-46d9-8a79-c683f7d15fd1","name":"Get Value Date Spot not allowed status 400","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/valuedates?CurrencyPair=USDAFN&ValueType=SPOT","host":["{{URL}}api"],"path":["valuedates"],"query":[{"key":"CurrencyPair","value":"USDAFN","description":"(Mandatory) The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. "},{"key":"ValueType","value":"SPOT","description":"(Optional) CASH, TOM or SPOT"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 16 Jan 2019 22:53:51 GMT"},{"key":"Content-Length","value":"49"}],"cookie":[],"responseTime":null,"body":"\"This AFN currency is not allowed for Spot date.\""},{"id":"f8814e4a-152a-42be-8b8e-e936f6d36e9d","name":"Get Value Date TOM not allowed status 400","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/valuedates?CurrencyPair=USDAFN&ValueType=TOM","host":["{{URL}}api"],"path":["valuedates"],"query":[{"key":"CurrencyPair","value":"USDAFN","description":"(Mandatory) The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. "},{"key":"ValueType","value":"TOM","description":"(Optional) CASH, TOM or SPOT"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/7.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 16 Jan 2019 22:52:06 GMT"},{"key":"Content-Length","value":"48"}],"cookie":[],"responseTime":null,"body":"\"This AFN currency is not allowed for Tom date.\""}],"_postman_id":"e4b22414-eb2b-4f5c-ba44-c606a2fa3b6b"},{"name":"Fees","id":"2a6d693d-39c4-4608-a062-bc2f6e8f8cfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Amount\": \"\",\n \"AccountNumber\": \"\",\n \"SettlementCcy\": \"\",\n \"TradeCcy\": \"\",\n \"ValueDate\": \"\",\n \"VendorId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{AFEXAPI.Endpoint}}api/fees","description":"Retrieve any applicable payment processing fees that you will be charged for the scheduling of beneficiary payments. Payment processing fees may be charged for both a beneficiary payment directly from a trade (spot, forward or predelivery) and via a scheduled payment. Payment fees will be deducted from the clients base currency AFEX held funding balance (Vostro account).
\n
\nThe fee returned is charged to the AFEX client and does not include any other indirect fees which may be deducted from the amount sent to the beneficiary by banks or intermediary banks involved in onward processing of the payment.
Please note, payment processing fees are NOT applied to funding trades (where trade proceeds are paid into the client's own foreign currency holding with AFEX) as there is no payment to a beneficiary involved.
Retrieve all non-processing days (holidays) for a currency pair. The returned holiday results listing can be used to ensure a valid forward value date is populated when creating a forward trade/payment
\nThe logic for deriving a valid value date from api/holidays response is shown below.
\nA valid value date is any date which:
\nRequired. 3 character ISO currency code . The currency pair specifies the trade (buy) and settlement (sell) currencies. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. For example if the client wants to convert AUD to USD, the currency pair would be expressed as USDAUD.
\n","type":"text/plain"},"key":"CurrencyPair","value":""}],"variable":[]}},"response":[{"id":"545f95ed-72cb-4e67-a2d2-e6ac2e3b70d3","name":"Holidays","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{{API-Key}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/holidays?CurrencyPair=","host":["{{URL}}api"],"path":["holidays"],"query":[{"key":"CurrencyPair","value":"","description":"3 character ISO currency code (Mandatory). The currency pair specifies the trade (buy) and settlement (sell) currencies being quoted. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. For example if the client wants to convert AUD to USD, the currency pair would be expressed as USDAUD."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d2fae8d4-33c4-4e1d-8b13-b290f7a1c7b4","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"API-Key","value":"{API-Key}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{URL}}api/holidays?CurrencyPair=USDGBP","host":["{{URL}}api"],"path":["holidays"],"query":[{"key":"CurrencyPair","value":"USDGBP","description":"3 character ISO currency code (Mandatory). The currency pair specifies the trade (buy) and settlement (sell) currencies being quoted. The pair must have the trade currency (buy) as the first in the pair and the settlement currency (sell) as the second in the pair. For example if the client wants to convert AUD to USD, the currency pair would be expressed as USDAUD."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"2025","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 28 Feb 2018 14:28:32 GMT","name":"Date","description":""},{"key":"Expires","value":"-1","name":"Expires","description":""},{"key":"Pragma","value":"no-cache","name":"Pragma","description":""},{"key":"Server","value":"Microsoft-IIS/7.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""}],"cookie":[{"expires":"Invalid Date","httpOnly":true,"domain":"demo.api.afex.com","path":"/","secure":false,"value":"h05kmghdz03szziajnojiu0b","key":"ASP.NET_SessionId"}],"responseTime":null,"body":"[\n \"2018-01-01T00:00:00\",\n \"2018-01-15T00:00:00\",\n \"2018-02-19T00:00:00\",\n \"2018-03-30T00:00:00\",\n \"2018-04-02T00:00:00\",\n \"2018-05-07T00:00:00\",\n \"2018-05-28T00:00:00\",\n \"2018-07-04T00:00:00\",\n \"2018-08-27T00:00:00\",\n \"2018-09-03T00:00:00\",\n \"2018-10-08T00:00:00\",\n \"2018-11-12T00:00:00\",\n \"2018-11-22T00:00:00\",\n \"2018-12-25T00:00:00\",\n \"2018-12-26T00:00:00\",\n \"2019-01-01T00:00:00\",\n \"2019-01-21T00:00:00\",\n \"2019-02-18T00:00:00\",\n \"2019-04-19T00:00:00\",\n \"2019-04-22T00:00:00\",\n \"Contniued\"\n \"...\"\n]"}],"_postman_id":"6220724a-f244-407a-a225-72a9d839fe5c"}],"id":"c1367400-a3e6-4bf0-8a93-725f0fdd3447","description":"The following reference collection includes a number of supporting API methods to help our partners and clients at each stage of a payment journey. Information that can be sourced from these methods include currency lists, client account balances and trading limits, valid trade value date and AFEX's settlement account details for different currencies.
\n","event":[{"listen":"prerequest","script":{"id":"5d4141d9-8294-4905-ba0d-1baceab7ab89","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"06901eca-33ea-4189-989f-3ad2b56ce53f","type":"text/javascript","exec":[""]}}],"_postman_id":"c1367400-a3e6-4bf0-8a93-725f0fdd3447","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]},"isInherited":true,"source":{"_postman_id":"af0acbd5-6174-42e0-ada8-f2927d739c23","id":"af0acbd5-6174-42e0-ada8-f2927d739c23","name":"Corpay Cross-Border 12.03.2021","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"API-Key"},{"key":"value","value":"{{API-Key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"3f0164d2-b065-4ba8-8af6-053c6b9d44c5","type":"text/javascript","exec":["pm.request.headers.add({"," key: 'Content-Type',"," value: 'application/json'","});"]}},{"listen":"test","script":{"id":"e27d0ff4-6770-47b9-a79d-36e244f3680f","type":"text/javascript","exec":[""]}}]}