Key Entities
\n![](\"https://canny-files.s3-eu-west-1.amazonaws.com/CannyPay-Entity-relationship.png\")
User
\nA User is someone who can login and log out of the system. To create a user one need very minimal data, just a username, password etc.
A basic user when given appropriate can be saved in the system as a recipient (beneficiary of payments) or as an Customer (Sender of payments)
When a user is not qualified as a beneficiary or customer, personID (unique identifier of a user), it refers to a regular user.
Customers and beneficiaries are uniquely created (unless the user forces a new one).
The system is designed in such a way that existing customers or beneficiaries can be searched and found. It’s envisaged that there should not be duplicate customers or beneficiaries
Recipient
\nWhen recipient details are provided we can extend a simple user to a Recipient
\nCustomer
\nWhen creating an invoice or RTP creates a customer. Who then signs up as a user.
Customers in the system could be searched using 3 parameter:
Country
Name of the
RecipientPersonID (optional)
When RecipientPersonID is given, customers of particular recipient (invoice sender) could be searched. If this ID is not given a search on the whole system is done.
Buy Currency
\nor “Purchase Currency” means the currency being bought by you and sold by us (through the payment partners like Wise, Rational FX etc.).
\ne.g. when a customer (or payer) residing in UK wants to send let's say send money (INR) to India, then that payer will sell the currency he has in the residing country (lets say GBP) and \"buys\" INR from the payment partners like Wise, Rational FX etc. so that the bought INR is deposited into beneficiary's Indian bank account.
\nSell Currency
\nor “Sold Currency” means the currency being given by you and bought by us (through the payment partners like Wise, Rational FX etc.).
\nSee above example
\n","_postman_id":"cf3dc593-b39f-46e7-b0dc-ec9eb7a01144","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"CannyCo's API services enable you to on-board your own end-users within CannyCo's global payments services which in turn grants them access to CannyCo's unique and innovative payment features.
\nOn-Board a end-customer workflow
\n\n
Lets have a look at the keys steps of this workflow:
\n- \n
- Get in touch with us to get API token for authentication. \n
- Use \"SaveUser\" API to sign up your end-users on to our platform. \n
- Confirm the details of the this user with \"ValidateUserID\" API by passing the right credentials \n
![\"Payments](\"https://canny-files.s3-eu-west-1.amazonaws.com/signingup-a-client-workflow_.jpg\")
- \n
Step 1. Create a User -
\nSaveUser(a beneficiary registers as a user) \nStep 2. Make this user a Recipient by calling
\nSaveRecipient. A user can become a Recipient when details that's needed to make the user a recipient is collected. This could include bank information etc. ) . Note - use the same personID that you got in step 1 as the value in the RecipientPersonID field. \nStep 3. Once the user becomes a recipient, they can associate a Payer (who can now pay the recipient) by the following steps below:\n-- Step 3.1 Find if payer already exists : Use
\nGetListOfCustomersAPI to find whether the intended Payer already exists in the system. \n-- Step 3.1.1. If they exist, then get their CustomerPersonID and update the Recipient by Calling theSaveRecipientagain. Make sure to pass in the RecipientPersonID and CustomerPersonID on the respective Keys. Please also make sure that you pass on all other data and the corresponding UpdateToken that you can get fromGetRecipientInformationAPI. This way association of the recipient and the Payer (a.k.a Customer) that you have just found.\n-- Step 3.2 IF no Payer Exist : Create a new Payer by calling API -SaveCustomerand pass the needed Customer Information and don't forget to leave CustomerPersonID Blank, in order to create a new customer.\nNote: In both the cases, note the CustomerPersonID of the Payer which would used in the subsequent steps \nStep 4. At this point the recipient (a.k.a Beneficiary) emails the invoice to the customer
\n \nStep 5. The Payer now receives the request to pay from the recipient and if they are not a user of the system they can now register as a user. Use the API -
\nSaveUserand pass the CustomerPersonID from the previous step 3 as PersonID. This way the Payer that was created by the recipient has become a user of the system at the same time all the information that was passed by the recipient to create the Payer is now associated with this newly created user. \n
![\"Recipient](\"https://canny-files.s3-eu-west-1.amazonaws.com/Recipient-Registering-first-and-adding-a-Payer-flow.jpg\")
- \n
Step 1. Create a User -
\nSaveUser(a soon to be payer registers as a user) \nStep 2. Make this user a Payer (a.k.a Customer) by calling
\nSaveCustomer. A user can become a Customer/Payer when details that's needed to make the user a Payer is collected. This could include address information etc. ) . Note - use the same personID that you got in step 1 as the value in the CustomerPersonID field.\n-- Step 2.1 Submitting a Payer for KYC : Note a Payer can get do payments only when they are approved for payments after going through a KYC check by our payment partners. Towards this we have made available a helper KYC API namedSaveCustomerRegistration. You can delay submission for KYC to the Payment Partner till all the details for KYC has been collected and take advantage of this API's Save-As-You-Go feature. In this API till the attribute\"TypeSave\": \"Incomplete\"the saving of details is happening on our systems only. Once you have completed collection of all the details change the attribute to\"TypeSave\": \"Complete\"to push the KYC details to the payments partner. As of now the SLA for KYC check is anywhere between 2hrs to 2 working days. The Payer would be approved do to payments once their status is\"Status\": \"Authorized to deal\". Till then they can do everything on our system but would NOT be authorised to do payments. \nStep 3. Once the user becomes a Payer/Customer, they can associate a Recipient (to whom this payer can do payments) by the following steps below:\n-- Step 3.1 Find if recipient already exists : Use
\nGetListOfRecipientsAPI to find whether the intended Payer already exists in the system. \n-- Step 3.1.1 If they exist, then get their RecipientPersonID and update the Recipient by Calling the SaveRecipient again. Make sure to pass in the RecipientPersonID and CustomerPersonID on the respective Keys. Please also make sure that you pass on all other data and the corresponding UpdateToken that you can get from GetRecipientInformation API. This way association of the recipient that you have just found and the Payer (a.k.a Customer).\n-- Step 3.2 IF no recipient exist : Create a new Recipient by calling API -SaveRecipientand pass the needed Recipient Information and don't forget to leave RecipientPersonID blank, in order to create a new Recipient.\nNote: In both the cases, note the CustomerPersonID of the Payer which would used in the subsequent steps \nStep 4. At this point, once the Payments status is authorized to deal and the recipient's details are all ready and associated (a.k.a Beneficiary) the payer can proceed to do the payments.
\n \nStep 5. To begin doing the payments, first one has to get a \"Value Date\" from the
\nGetValueDateAPI \nStep 6. Using the value date, you can get the Quote for the currency pair your intend to a trade / deal on. use
\nGetQuoteAPI to get the real-time quote. \nStep 7. Once you get a quote Post a Payment to the recipient using the API
\nPostDeal\nStep 8. If posting of deal has been successful you can check the details of the payment from
\nGetConfirmationAPI. \n
![\"Payer](\"https://canny-files.s3-eu-west-1.amazonaws.com/Payer-Registering-from-Scratch-and-adding-recipients.jpg\")
Use Case Library
\n\n
To 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 CannyCo's API services in real-world scenarios.
\nEach use case will provide a typical scenario and business requirement which will be solved for using Canny's wide range of API services.
\n- \n
\nOn-board a Client- In this tutorial you will learn how to on-board a user on to CannyCo's Payments marketplace. \n
\nBeneficiary Payment With FX- In this tutorial you will learn how to execute an international payment to a third-party payee (beneficiary, a.k.a Recipient). 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 \n
List of Values (ENUMS)
\nThere are few data items for which only certain values are allowed. These allowable values can be fetched from the following API
\nFrom API
\n- \n
- Banks - From GetListOfBanks\n/api/Bank/GetListOfBanks?NameLike=BAN&CountryID=US&Page=0&Items=10&SearchBy=bankhBy=bank&ExternalInterface=AFEX \n
- Branches - From GetListOfBankBranches\n/api/Bank/GetListOfBankBranches?BankName=Centennial Bank&BranchDescription=ba&CountryID=USA&ExternalInterface=AFEX&Page=0&Items=10 \n
- Get State by Country:\n/api/Global/GetListOfStates?CountryID=US \n
Standard List
\nFrom “GetList” API
\n /api/Global/GetLists?ListName=Account Type&ExternalInterface=AFEX
Some of the lists are:
\n- \n
- Salutation \n
- Address Type \n
- Account Type \n
- Beneficiary Status \n
- Customer Type \n
- Customer Status \n
- Settlement Delivery Method \n
- Electronic Funds Transfer \n
- Incoming Instruments \n
- Wire Transfer \n
- Industry Sectors \n
- Deal Status \n
- Deal Paid Status \n
- Deal Disbursement Status Names \n
- Bank Status \n
Master list of error codes **
\n- \n
- HTTP Status Codes \n
- Error Status Codes \n
- Other Application-specific Codes (e.g authentication, PayOut codes etc..) \n
HTTP Status Codes
\nExample Error Status Codes
\n","_postman_id":"199dafd3-5125-4a3e-944e-276d0b7d1025","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Create User
\nThis API creates a user in the Global Payments system.
\nPossible Even when this API could be called
\n- \n
- Sign up \n
Request Parameters (body)
\nErrors & Exceptions
\n##Outstanding Questions**
\n- \n
- Insert attribute table \n
- define mandatory fields and their formats \n
- Is \"PersonID\" always system (Canny Marketplace System) defined, or can any PersonID is allowed (in the case of creation of customer before user) \n
Login User
\nThis API logs in a user and returns a sessionID
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get List of Customers
\nReturns user information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Save Customer
\nThis API creates a customer in the Global Payments system.
\nPossible Even when this API could be called
\n- \n
- Adding a Payer (note - this not a submission for KYC) \n
Attribute Details
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Save Customer Registration - Corporate
\nThis API facilitates:
\n- \n
- capturing the details of a user \n
- submitting the KYC details to a payment partner. \n
this API also gives you the facility to \"Save as you Go\" feature to capture user's data. This is achieved through the flag TypeSave. As long as this flag is Incomplete. we merely keep storing the data in our database. As soon as the flag is set to Complete we submit the captured user data to the respective Payments Partner mentioned in the field ExternalInterface
** Apt time to call this API could be:**
\n- \n
- when you Business Profile information has been collected from the user. \n
Notes:
\n- \n
- The CustomerPersonID is mandatory. \n
- It has to be match the personID of the caller who's logged in \n
- It will check that the email is not duplicated \n
- emailID of main contact is necessary. \n
- All Date in YYYY/mm/dd format. \n
- images of document need to be base64 encoded string of the image file \n
If you have done a \"SaveCustomer\" call before for a user, then Saving the Customer with Full KYC Detail (SaveCustomerRegistration) would be deemed as an Update of that customer record.
\nSo please execute the following sequence:\nSaveCustomer --> GetCusomerRegistration (to get the updateToken etc.) -->SaveCustomerRegistration (with the update Token details & MainContactPersonId etc.)
\nThe only time you do \"SaveCustomerRegistration\" without an update token is when you already have quite a lot of information about the Customer, and don't have to first do \"SaveCustomer\" and then call this API. If you have enough information about a customer then you can call this API directly.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Save Customer Registration - Individual
\nThis API facilitates:
\n- \n
- capturing the details of a user \n
- submitting the KYC details to a payment partner. \n
this API also gives you the facility to \"Save as you Go\" feature to capture user's data. This is achieved through the flag TypeSave. As long as this flag is Incomplete. we merely keep storing the data in our database. As soon as the flag is set to Complete we submit the captured user data to the respective Payments Partner mentioned in the field ExternalInterface
Apt time when this API could be called
\n- \n
- when you have collected most of the individual Profile information from the user. \n
Notes:
\n- \n
- The CustomerPersonID is mandatory. \n
- It has to be match the personID of the caller who's logged in \n
- It will check that the email is not duplicated \n
- emailID of main contact is necessary. \n
- Main Contact email ID and the customer/user (logged in) emailID needs to be different. \n
- All Date in YYYY/mm/dd format \n
- images of document need to be base64 encoded string of the image file \n
- Salutation is mandatory and a possible value can be “N/A”. If N/A We will not send this to any partner. \n
- Gender is mandatory and supports value “NOT_KNOWN” \n
If you have done a \"SaveCustomer\" call before for a user, then Saving the Customer with Full KYC Detail (SaveCustomerRegistration) would be deemed as an Update of that customer record.
\nSo please execute the following sequence:\nSaveCustomer --> GetCusomerRegistration (to get the updateToken etc.) -->SaveCustomerRegistration (with the update Token details & MainContactPersonId etc.)
\nThe only time you do \"SaveCustomerRegistration\" without an update token is when you already have quite a lot of information about the Customer, and don't have to first do \"SaveCustomer\" and then call this API. If you have enough information about a customer then you can call this API directly.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get customer registration
\nReturns customer registration information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get list of customers
\nWhen the beneficiary creates an invoice, you need to show a list of his customers. If a RecipientPersonid is sent, it will return only the customers linked to this recipient. If NULL is sent, it will do a global search on all customers within the specified country This API, will do a partial customer name search on firstname, lastname or company name.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Support partial name searching
\n","type":"text/plain"},"key":"Name","value":"a"},{"description":{"content":"Support exact email searching
\n","type":"text/plain"},"key":"UserEmail","value":null}],"variable":[]}},"response":[],"_postman_id":"94fe89c4-c45d-4912-aea4-6657ab41f635"}],"id":"c17fb33f-4646-4b43-a07a-c6e44c654aea","_postman_id":"c17fb33f-4646-4b43-a07a-c6e44c654aea","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Create / Update Recipient
\nThis API logs in a user and returns a sessionID
\nNote
\nThere are some utility APIs that help you to construct recipient with minimum errors so that transactions errors are kept to minimum.
\n- \n
- The API 'GetExternalBanksByProvider' helps you in constructing UI screens to help end user find their bank details easily with minimum of data entry yet ensuring that proper bank account data is searched and saved. \n
- Some payment partners have some restrictive rules such as the beneficiary address and currency should be from same country home currency for few corridors like INR. \n
- for the dynamic part of bank account section of the request parameter, please use \"GetBankAccountRequirement\" API to get the needed bank account fields. This will ensure minimal errors. \n
Request Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Save Customer
\nThis API creates a customer in the Global Payments system.
\nPossible Even when this API could be called
\n- \n
- Adding a Payer (note - this not a submission for KYC) \n
Attribute Details
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Create / Update Recipient
\nThis API logs in a user and returns a sessionID
\nNote: - for the dynamic part of bank account section of the request parameter, please use \"GetBankAccountRequirement\" API to get the needed bank account fields. This will ensure minimal errors.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get list of recipients
\nReturns recipients information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Customer unique identification
\n","type":"text/plain"},"key":"CustomerPersonID","value":"77b63db5-1240-4b9f-9250-764a4db65d9f"},{"key":"CountryID","value":"IN"},{"key":"Name","value":""},{"description":{"content":"page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"number of items per page
\n","type":"text/plain"},"key":"items","value":"100"},{"key":"UserEmail","value":null}],"variable":[]}},"response":[],"_postman_id":"5aaf23a9-5814-415f-968b-02c16df555bd"},{"name":"GetRecipientInformation","id":"b995aebb-bf57-4707-968e-19df8d0b20e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host-dev}}/api/Recipient/GetRecipientInformation?RecipientPersonID=4e320941-79d3-445f-9c3e-82eff8d36b8a","description":"Get Recipient Information
\nReturns recipient information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Recipient unique idenfication
\n","type":"text/plain"},"key":"RecipientPersonID","value":"4e320941-79d3-445f-9c3e-82eff8d36b8a"}],"variable":[]}},"response":[],"_postman_id":"b995aebb-bf57-4707-968e-19df8d0b20e9"},{"name":"GetBankAccountRequirements","id":"b4349f23-1174-4b72-b18a-381e7611bff5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/ecmascript","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Global/GetBankAccountRequirements?CountryID=IN&CurrencyID=INR&ExternalInterface=AFEX&RecipientType=Corporate","description":"Get BankAccount requirements
\nReturns bank account requirements information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"2-character ISO code. \nThis API could return no values if there are no bank account requirements available for the country
\n","type":"text/plain"},"key":"CountryID","value":"IN"},{"description":{"content":"This could be blank or NULL. In this case it will return the default configuration for the bank account
\n","type":"text/plain"},"key":"CurrencyID","value":"INR"},{"description":{"content":"AFEX | RFX | ALL
\n","type":"text/plain"},"key":"ExternalInterface","value":"AFEX"},{"disabled":true,"description":{"content":"Local ||SWIFT
\n","type":"text/plain"},"key":"TrasnferType","value":"SWIFT"},{"key":"RecipientType","value":"Corporate"},{"disabled":true,"key":null,"value":""}],"variable":[]}},"response":[{"id":"9b067e62-c11d-4209-987a-66e22f3855dc","name":"GetBankAccountRequirements (IN / INR)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/ecmascript","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":{"raw":"{{global-payments-host}}/api/Global/GetBankAccountRequirements?CountryID=IN&CurrencyID=INR&ExternalInterface=AFEX","host":["{{global-payments-host}}"],"path":["api","Global","GetBankAccountRequirements"],"query":[{"key":"CountryID","value":"IN","description":"2-character ISO code. \nThis API could return no values if there are no bank account requirements available for the country"},{"key":"CurrencyID","value":"INR","description":"This could be blank or NULL. In this case it will return the default configuration for the bank account"},{"key":"ExternalInterface","value":"AFEX"}]}},"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/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 19 May 2021 17:14:12 GMT"},{"key":"Content-Length","value":"1265"}],"cookie":[],"responseTime":null,"body":"{\n \"bankAccountRequirements\": [\n {\n \"type\": \"indian\",\n \"title\": \"Local bank account\",\n \"usageInfo\": null,\n \"fields\": [\n {\n \"name\": \"Recipient type\",\n \"group\": [\n {\n \"key\": \"legalType\",\n \"name\": \"Recipient type\",\n \"type\": \"select\",\n \"refreshRequirementsOnChange\": true,\n \"required\": true,\n \"displayFormat\": null,\n \"example\": \"\",\n \"minLength\": null,\n \"maxLength\": null,\n \"validationRegexp\": null,\n \"validationAsync\": null,\n \"valuesAllowed\": [\n {\n \"key\": \"PRIVATE\",\n \"name\": \"Person\"\n },\n {\n \"key\": \"BUSINESS\",\n \"name\": \"Business\"\n }\n ]\n }\n ]\n },\n {\n \"name\": \"IFSC Code\",\n \"group\": [\n {\n \"key\": \"ifscCode\",\n \"name\": \"IFSC Code\",\n \"type\": \"text\",\n \"refreshRequirementsOnChange\": false,\n \"required\": true,\n \"displayFormat\": null,\n \"example\": \"YESB0236041\",\n \"minLength\": 11,\n \"maxLength\": 11,\n \"validationRegexp\": \"^[A-Za-z]{4}0[A-Za-z0-9]{6}$\",\n \"validationAsync\": {\n \"url\": \"https://api.sandbox.transferwise.tech/v1/validators/ifsc-code\",\n \"params\": [\n {\n \"key\": \"ifscCode\",\n \"parameterName\": \"ifscCode\",\n \"required\": true\n }\n ]\n },\n \"valuesAllowed\": null\n }\n ]\n },\n {\n \"name\": \"Account number\",\n \"group\": [\n {\n \"key\": \"accountNumber\",\n \"name\": \"Account number\",\n \"type\": \"text\",\n \"refreshRequirementsOnChange\": false,\n \"required\": true,\n \"displayFormat\": null,\n \"example\": \"678911234567891\",\n \"minLength\": 5,\n \"maxLength\": 20,\n \"validationRegexp\": \"^[a-zA-Z0-9]{5,20}$\",\n \"validationAsync\": null,\n \"valuesAllowed\": null\n }\n ]\n }\n ]\n }\n ],\n \"ErrorMessage\": {\n \"ErrorSeverity\": 0,\n \"ErrorMessage\": \"\"\n }\n}"}],"_postman_id":"b4349f23-1174-4b72-b18a-381e7611bff5"},{"name":"getPartnerSupported (Coming Soon)","id":"b06d92c0-f33a-48a9-ad55-4919d919adf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/ecmascript","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Global/getPartnerSuported?RecipientPersonId=42c52858-9af0-4de3-aeab-b8b92cdc324b","description":"Get BankAccount requirements
\nReturns bank account requirements information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"2-character ISO code. \nThis API could return no values if there are no bank account requirements available for the country
\n","type":"text/plain"},"key":"RecipientPersonId","value":"42c52858-9af0-4de3-aeab-b8b92cdc324b"},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"d37f5d9c-46c1-4f6a-8c12-18a3c40f6736","name":"getPartnerSupported","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/ecmascript","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":{"raw":"{{global-payments-host}}/api/Global/getPartnerSuported?RecipientPersonId=42c52858-9af0-4de3-aeab-b8b92cdc324b","host":["{{global-payments-host}}"],"path":["api","Global","getPartnerSuported"],"query":[{"key":"RecipientPersonId","value":"42c52858-9af0-4de3-aeab-b8b92cdc324b","description":"2-character ISO code. \nThis API could return no values if there are no bank account requirements available for the country"},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n PartnerSupported:\n [\n {\n PArnerName:\"AFEX\",\n PartnerID:\"1\",\n TranferTypeSupported:\"SWIFT\"\n },\n {\n PArnerName:\"RFX\",\n PartnerID:\"2\",\n TranferTypeSupported:\"SWIFT\"\n },\n {\n PArnerName:\"RFX\",\n PartnerID:\"2\",\n TranferTypeSupported:\"Local\"\n },\n]\n\n}"}],"_postman_id":"b06d92c0-f33a-48a9-ad55-4919d919adf7"}],"id":"e919806f-4248-4b74-b498-eb53159803e7","_postman_id":"e919806f-4248-4b74-b498-eb53159803e7","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get Quote
\nReturns quote information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Customer unique idenfication ID
\n","type":"text/plain"},"key":"CustomerPersonID","value":"ed3baf65-115c-49dc-9772-1e40ed3c2a01"},{"description":{"content":"Spot, Forward, Swap, etc
\n","type":"text/plain"},"key":"dealType","value":"Spot"},{"description":{"content":"From the GetValueDate API
\n","type":"text/plain"},"key":"valueDate","value":"2021/05/27"},{"key":"buyCurrency","value":"INR"},{"key":"sellCurrency","value":"GBP"},{"key":"dealAmount","value":"1000"},{"description":{"content":"Case sensitive. Use only Buy or Sell
\n","type":"text/plain"},"key":"lockedSide","value":"Sell"},{"description":{"content":"AFEX, Rational, Currency Cloud
\n","type":"text/plain"},"key":"externalInterface","value":"AFEX"}],"variable":[]}},"response":[{"id":"e04961ff-1129-4ea8-8014-af9d69271e61","name":"GetQuote - by customer 4","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":{"raw":"{{global-payments-host}}/api/Rate/GetQuote?CustomerPersonID=ed3baf65-115c-49dc-9772-1e40ed3c2a01&dealType=Spot&valueDate=2021/05/27&buyCurrency=INR&sellCurrency=GBP&dealAmount=1000&lockedSide=Buy&externalInterface=AFEX","host":["{{global-payments-host}}"],"path":["api","Rate","GetQuote"],"query":[{"key":"CustomerPersonID","value":"ed3baf65-115c-49dc-9772-1e40ed3c2a01","description":"Customer unique idenfication ID"},{"key":"dealType","value":"Spot","description":"Spot, Forward, Swap, etc"},{"key":"valueDate","value":"2021/05/27","description":"From the GetValueDate API"},{"key":"buyCurrency","value":"INR"},{"key":"sellCurrency","value":"GBP"},{"key":"dealAmount","value":"1000"},{"key":"lockedSide","value":"Buy"},{"key":"externalInterface","value":"AFEX","description":"AFEX, Rational, Currency Cloud"}]}},"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/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 24 May 2021 21:32:48 GMT"},{"key":"Content-Length","value":"199"}],"cookie":[],"responseTime":null,"body":"{\n \"CustomerRate\": 106.26992561,\n \"ExternalInterface\": \"AFEX\",\n \"RateQuoteID\": \"065411e3-e5fc-4a03-998e-861f88eca9b5\",\n \"Source\": \"AFEX\",\n \"ValidForSeconds\": 31,\n \"ErrorMessage\": {\n \"ErrorSeverity\": 0,\n \"ErrorMessage\": \"\"\n }\n}"}],"_postman_id":"c2cbfbb1-53f4-4c5c-b341-351d55dbe58b"},{"name":"GetQuotes","id":"83ea44ab-6817-45b3-9798-1d57715d911e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Rate/GetQuotes?dealType=Spot&buyCurrency=INR&sellCurrency=GBP&dealAmount=1000&lockedSide=Sell&sortBy=Cheapest","description":"Get Quotes
\nReturns a quote for each partner available in the system for a given currency pair. It is not required to
have a session to use this API (depending on the API key used)
Request Parameters (body)
\nResponse (body)
\nResponse Sample (body)
\n{\n \"Quotes\": [\n {\n \"Interface\": \"Rational\",\n \"Rate\": 1.19146,\n \"BuyAmount\": 1000.00,\n \"SellAmount\": 1191.46,\n \"InterfaceDeliveryDate\": \"2022/07/14\",\n \"Message\": \"\"\n },\n {\n \"Interface\": \"Transfer Wise\",\n \"Rate\": 1.1915,\n \"BuyAmount\": 1000.0,\n \"SellAmount\": 1191.50,\n \"InterfaceDeliveryDate\": \"N/A\",\n \"Message\": \"\"\n },\n {\n \"Interface\": \"Corpay\",\n \"Rate\": 1.21554,\n \"BuyAmount\": 1000.00,\n \"SellAmount\": 1215.54,\n \"InterfaceDeliveryDate\": \"2022/07/13\",\n \"Message\": \"\"\n },\n {\n \"Interface\": \"Currency Cloud\",\n \"Rate\": 1.4079,\n \"BuyAmount\": 1000.0,\n \"SellAmount\": 1407.9,\n \"InterfaceDeliveryDate\": \"N/A\",\n \"Message\": \"\"\n }\n ],\n \"ErrorMessage\": {\n \"ErrorCode\": 0,\n \"ErrorMessage\": null,\n \"Details\": null\n }\n}\n\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"A valid FX transaction type. Valid values: Spot, Forward, Swap.
\n","type":"text/plain"},"key":"dealType","value":"Spot"},{"description":{"content":"The currency to buy
\n","type":"text/plain"},"key":"buyCurrency","value":"INR"},{"description":{"content":"The settlement currency
\n","type":"text/plain"},"key":"sellCurrency","value":"GBP"},{"description":{"content":"The amount of the deal
\n","type":"text/plain"},"key":"dealAmount","value":"1000"},{"description":{"content":"Indicates if the amount is related to buy or the sell currency
\n","type":"text/plain"},"key":"lockedSide","value":"Sell"},{"description":{"content":"Indicates if the result is sorted by some criteria Valid values: Cheapest, Fastest. Defaul valuet Cheapest
\n","type":"text/plain"},"key":"sortBy","value":"Cheapest"}],"variable":[]}},"response":[{"id":"34bcf7d8-b92c-41b9-8cd7-fbe25caba153","name":"GetQuotes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":{"raw":"{{global-payments-host}}/v0/api/Rate/GetQuotes?dealType=Spot&buyCurrency=GBP&sellCurrency=USD&dealAmount=1000&lockedSide=Buy&sortBy=Cheapest","host":["{{global-payments-host}}"],"path":["v0","api","Rate","GetQuotes"],"query":[{"key":"dealType","value":"Spot","description":"A valid FX transaction type. Valid values: Spot, Forward, Swap."},{"key":"buyCurrency","value":"GBP","description":"The currency to buy"},{"key":"sellCurrency","value":"USD","description":"The settlement currency"},{"key":"dealAmount","value":"1000","description":"The amount of the deal"},{"key":"lockedSide","value":"Buy","description":"Indicates if the amount is related to buy or the sell currency"},{"key":"sortBy","value":"Cheapest","description":"Indicates if the result is sorted by some criteria Valid values: Cheapest, Fastest. Defaul valuet Cheapest"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"693"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Date","value":"Wed, 07 Sep 2022 17:40:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Quotes\": [\n {\n \"Interface\": \"Rational\",\n \"Rate\": 1.15161,\n \"BuyAmount\": 1000,\n \"SellAmount\": 1151.61,\n \"InterfaceDeliveryDate\": \"2022/09/08\",\n \"ValueDate\": \"2022/09/08\",\n \"Message\": \"\"\n },\n {\n \"Interface\": \"Transfer Wise\",\n \"Rate\": 1.15165,\n \"BuyAmount\": 1000,\n \"SellAmount\": 1151.65,\n \"InterfaceDeliveryDate\": \"N/A\",\n \"ValueDate\": \"2022/09/08\",\n \"Message\": \"\"\n },\n {\n \"Interface\": \"Corpay\",\n \"Rate\": 1.17493,\n \"BuyAmount\": 1000,\n \"SellAmount\": 1174.93,\n \"InterfaceDeliveryDate\": \"2022/09/07\",\n \"ValueDate\": \"2022/09/07\",\n \"Message\": \"\"\n },\n {\n \"Interface\": \"Currency Cloud\",\n \"Rate\": 1.4079,\n \"BuyAmount\": 1000,\n \"SellAmount\": 1407.9,\n \"InterfaceDeliveryDate\": \"N/A\",\n \"ValueDate\": \"2022/09/08\",\n \"Message\": \"\"\n }\n ],\n \"ErrorMessage\": {\n \"ErrorCode\": 0,\n \"ErrorMessage\": null,\n \"Details\": null\n }\n}"}],"_postman_id":"83ea44ab-6817-45b3-9798-1d57715d911e"},{"name":"GetLandingPageURL","id":"4f35cb2b-bde9-4ffe-8e0e-d4cf3a5a5c7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/v0/api/Rate/GetLandingPageUrl?buyAmount=0&buyCurrency=GBP&sellAmount=1000&sellCurrency=USD&lockside=Sell&partner=rational","description":"Get Landing Page URL
\nReturns a URL (hosted by Canny) which renders a HTML5 webpage that shows to an end user all the right data (as given in the request parameters).
\nFrom this page, the end user can seamlessly navigate forward to complete their payment journey.
\nThis API is useful to build HTML anchor tags that link the content to destination URL properly.
\nThe request parameter of this API should be built using the data fetched from the quotes APIs (GetRates, GetQuote or GetQuotes)
\nRequest Parameters (body)
\nResponse (body)
\nResponse Sample (body)
\n{\n \"Url\": \"https://canny-nexo-uat.firebaseapp.com/external-send-money?buyCurrency=INR&buyAmount=0&sellCurrency=GBP&sellAmount=12312&lockedside=Sell&partner=Rational\",\n \"ErrorMessage\": {\n \"ErrorCode\": 0,\n \"ErrorMessage\": null,\n \"Details\": null\n }\n}\n\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"The currency to buy
\n","type":"text/plain"},"key":"buyCurrency","value":"GBP"},{"key":"sellAmount","value":"1000"},{"description":{"content":"The settlement currency
\n","type":"text/plain"},"key":"sellCurrency","value":"USD"},{"key":"lockside","value":"Sell"},{"key":"partner","value":"rational"}],"variable":[]}},"response":[{"id":"e1851c14-73b5-4b32-9d68-cb706340a6b3","name":"GetLandingPageURL","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":{"raw":"{{global-payments-host}}/v0/api/Rate/GetLandingPageUrl?buyAmount=0&buyCurrency=INR&sellAmount=12312&sellCurrency=GBP&lockside=Sell&partner=Rational","host":["{{global-payments-host}}"],"path":["v0","api","Rate","GetLandingPageUrl"],"query":[{"key":"buyAmount","value":"0"},{"key":"buyCurrency","value":"INR","description":"The currency to buy"},{"key":"sellAmount","value":"12312"},{"key":"sellCurrency","value":"GBP","description":"The settlement currency"},{"key":"lockside","value":"Sell"},{"key":"partner","value":"Rational"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"229"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Date","value":"Wed, 07 Sep 2022 17:33:26 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Url\": \"https://canny-nexo-uat.firebaseapp.com/external-send-money?buyCurrency=INR&buyAmount=0&sellCurrency=GBP&sellAmount=12312&lockedside=Sell&partner=Rational\",\n \"ErrorMessage\": {\n \"ErrorCode\": 0,\n \"ErrorMessage\": null,\n \"Details\": null\n }\n}"}],"_postman_id":"4f35cb2b-bde9-4ffe-8e0e-d4cf3a5a5c7c"},{"name":"GetRates","event":[{"listen":"test","script":{"id":"2de40fb7-a705-4a58-85b7-83978e870083","exec":["const response = pm.response.json();","","console.log(\"API Key -- > \"+pm.environment.get(\"APIKey\"));"," "],"type":"text/javascript"}}],"id":"e7315742-10b5-4a8d-b2e6-60dee0d5d453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Rate/GetRates?currencies=[{\"BuyCurrency\": \"INR\", \"SellCurrency\": \"GBP\"},{\"BuyCurrency\": \"INR\", \"SellCurrency\": \"USD\"},{\"BuyCurrency\": \"INR\", \"SellCurrency\": \"AED\"}]&dealAmount=1000&lockedSide=Sell&externalInterfaces=Rational, corpay,wise,ccloud","description":"Get Rates
\nReturns an array of rates for different currency pair from the specified payment partners.
\nRequest Parameters (body)
\nResponse Body
\nJason Array of Rates Object
\nResponse Sample
\n[\n {\n \"ExternalInterface\": \"Rational\",\n \"BuyCurrency\": \"USD\",\n \"SellCurrency\": \"CAD\",\n \"BuyAmount\": 765.16,\n \"SellAmount\": 1000.0,\n \"CustomerRate\": 1.30692\n },\n {\n \"ExternalInterface\": \"Rational\",\n \"BuyCurrency\": \"EUR\",\n \"SellCurrency\": \"USD\",\n \"BuyAmount\": 1005.89,\n \"SellAmount\": 1000.0,\n \"CustomerRate\": 0.9941490\n },\n {\n \"ExternalInterface\": \" corpay\",\n \"BuyCurrency\": \"USD\",\n \"SellCurrency\": \"CAD\",\n \"BuyAmount\": 741.02,\n \"SellAmount\": 1000.0,\n \"CustomerRate\": 1.34950\n },\n {\n \"ExternalInterface\": \" corpay\",\n \"BuyCurrency\": \"EUR\",\n \"SellCurrency\": \"USD\",\n \"BuyAmount\": 913.83,\n \"SellAmount\": 1000.0,\n \"CustomerRate\": 1.0943000\n },\n {\n \"ExternalInterface\": \"wise\",\n \"BuyCurrency\": \"USD\",\n \"SellCurrency\": \"CAD\",\n \"BuyAmount\": 741.02,\n \"SellAmount\": 1000.0,\n \"CustomerRate\": 1.34950\n },\n {\n \"ExternalInterface\": \"wise\",\n \"BuyCurrency\": \"EUR\",\n \"SellCurrency\": \"USD\",\n \"BuyAmount\": 913.83,\n \"SellAmount\": 1000.0,\n \"CustomerRate\": 1.0943000\n },\n {\n \"ExternalInterface\": \"ccloud\",\n \"BuyCurrency\": \"USD\",\n \"SellCurrency\": \"CAD\",\n \"BuyAmount\": 741.02,\n \"SellAmount\": 1000.0,\n \"CustomerRate\": 1.34950\n },\n {\n \"ExternalInterface\": \"ccloud\",\n \"BuyCurrency\": \"EUR\",\n \"SellCurrency\": \"USD\",\n \"BuyAmount\": 913.83,\n \"SellAmount\": 1000.0,\n \"CustomerRate\": 1.0943000\n }\n]\n\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Array of Currency pairs for which the rates are desired.
Buy Currency
or “Purchase Currency” means the currency being bought by you and sold by us (through the payment partners like Wise, Rational FX etc.).
or “Sold Currency” means the currency being given by you and bought by us (through the payment partners like Wise, Rational FX etc.).
\ne.g. when a customer (or payer) residing in UK wants to send let's say send money (INR) to India, then that payer will sell the currency he has in the residing country (lets say GBP) and \"buys\" INR from the payment partners like Wise, Rational FX etc. so that the bought INR is deposited into beneficiary's Indian bank account.
\n","type":"text/plain"},"key":"currencies","value":"[{\"BuyCurrency\": \"INR\", \"SellCurrency\": \"GBP\"},{\"BuyCurrency\": \"INR\", \"SellCurrency\": \"USD\"},{\"BuyCurrency\": \"INR\", \"SellCurrency\": \"AED\"}]"},{"description":{"content":"Amount for which the rates are desired
\n","type":"text/plain"},"key":"dealAmount","value":"1000"},{"description":{"content":"The currency pair side for which the amount is fixed
\n","type":"text/plain"},"key":"lockedSide","value":"Sell"},{"description":{"content":"Payment partner from whom the rates are desired. e.g. CorPay, RationalFX etc.
\n","type":"text/plain"},"key":"externalInterfaces","value":"Rational, corpay,wise,ccloud"}],"variable":[]}},"response":[{"id":"aaafd91c-df5f-4a75-a9b0-f2fd9c0945a2","name":"GetRates","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":{"raw":"{{global-payments-host}}/v2/api/Rate/GetRates?Currencies=[{\"BuyCurrency\": \"CAD\",\"SellCurrency\": \"GBP\"}]&dealAmount=100&lockedSide=Sell&externalInterfaces=Rational,Currency Cloud,AFEX","host":["{{global-payments-host}}"],"path":["v2","api","Rate","GetRates"],"query":[{"key":"Currencies","value":"[{\"BuyCurrency\": \"CAD\",\"SellCurrency\": \"GBP\"}]"},{"key":"dealAmount","value":"100","description":"Amount for which the rates are desired"},{"key":"lockedSide","value":"Sell","description":"The currecy pair side for which the amount is fixed"},{"key":"externalInterfaces","value":"Rational,Currency Cloud,AFEX","description":"Payment partner from whom the rates are desired."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"407"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Date","value":"Wed, 07 Sep 2022 17:33:15 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"ExternalInterface\": \"Rational\",\n \"BuyCurrency\": \"CAD\",\n \"SellCurrency\": \"GBP\",\n \"BuyAmount\": 151.36,\n \"SellAmount\": 100,\n \"CustomerRate\": 1.5136\n },\n {\n \"ExternalInterface\": \"Currency Cloud\",\n \"BuyCurrency\": \"CAD\",\n \"SellCurrency\": \"GBP\",\n \"BuyAmount\": 172.41,\n \"SellAmount\": 100,\n \"CustomerRate\": 1.7241\n },\n {\n \"ExternalInterface\": \"AFEX\",\n \"BuyCurrency\": \"CAD\",\n \"SellCurrency\": \"GBP\",\n \"BuyAmount\": 148.24,\n \"SellAmount\": 100,\n \"CustomerRate\": 1.4824\n }\n]"}],"_postman_id":"e7315742-10b5-4a8d-b2e6-60dee0d5d453"},{"name":"PostDeal","id":"5a58cbdc-f95e-4a1a-814e-d7cb67df71cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"BuyAmount\": 1000,\r\n\t\"BuyCurrency\": \"INR\",\r\n\t\"SellAmount\": 106269.92561,\r\n\t\"SellCurrency\": \"GBP\",\r\n\t\"CustomerRate\": 106.26992561,\r\n\t\"CustomerRefNo\": \"customer-4-ref\", // Customer reference number\r\n\t\"ValueDate\": \"2021/05/27\",\r\n\t\"ExternalInterface\": \"AFEX\", // AFEX, Rational, Currency Cloud\r\n\t\"ExternalInterfaceType\": \"PassThru\", // Use \"PassThru\"\r\n\t\"Status\": \"Accepted\", // Use \"Accepted\"\r\n\t\"LockedSide\": \"Sell\",\r\n\t\"OutgoingFunds\":[{\r\n\t \"RecipientPersonID\": \"a805da77-4b18-4af2-8464-cddb8f1e1771\", // PersonId of the recipient\r\n\t \"PaymentAmount\": 106269.92561, // Amount to be sent to the recipient\r\n \"PurposeOfPaymentCode\": \"GDSV\", // Code from the GetPurposeOfPaymentsList API\r\n \"PurposeOfPaymentDescription\": \"Goods And Services\" // description from the GetPurposeOfPaymentsList API\r\n\t}],\r\n\t\"RateQuoteID\": \"dbc6f099-fdca-416f-b418-ed9a252ff996\", // Value returned by the GetQuote\r\n\t\"UpdateToken\": \"\" // leave blank\r\n}"},"url":"{{global-payments-host}}api/Deals/PostPayment","description":"Create Payment
\nUse to create payments.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get value date
\nReturns value date information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"AFEX, Rational, Currency Cloud
\n","type":"text/plain"},"key":"ExternalInterface","value":"AFEX"}],"variable":[]}},"response":[],"_postman_id":"765914f8-2315-4762-9578-fc4509915a4e"},{"name":"GetConfirmation","id":"f4f5b1d5-e801-4eb4-86d2-6626a6d69dbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Deals/GetConfirmation?DealID=12368&ExternalInterface=AFEX","description":"Get Confirmation
\nReturns confirmation information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get list of Payments
\nReturns payments information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Use Spot. Future use for other instruments
\n","type":"text/plain"},"key":"dealType","value":"Spot"},{"description":{"content":"Deal status. Only \"Accepted\" supported for now
\n","type":"text/plain"},"key":"status","value":"Accepted"},{"key":"fromDate","value":"2021-02-02"},{"key":"toDate","value":"2021-04-06"},{"description":{"content":"Customer unique idenfication ID
\n","type":"text/plain"},"key":"CustomerPersonID","value":"8731EF69-A7DC-44FD-8C84-3D31522A8876"},{"description":{"content":"0 = All deals, 1 = only outstanding deals
\n","type":"text/plain"},"key":"onlyOutstandingDeals","value":"0"},{"key":"page","value":"1"},{"key":"items","value":"100"}],"variable":[]}},"response":[],"_postman_id":"26475a4f-f144-4802-8c43-b28370a3fc25"},{"name":"GetPayment (with disbursement)","id":"ff438882-325a-4b14-81c5-65c607bc349f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Deals/GetPayment?DealID=11712","description":"Get Payment
\nReturns payment information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Deal ID returned in the PostDeal or GetListofPayments
\n","type":"text/plain"},"key":"DealID","value":"11712"}],"variable":[]}},"response":[],"_postman_id":"ff438882-325a-4b14-81c5-65c607bc349f"},{"name":"GetFees","id":"705b44b4-aa57-4637-9c8a-78defc544648","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Global/GetFees?BuyCurrency=USD&SellCurrency=GBP&Amount=1000&RecipientPersonID=737e76a5-f8d7-4019-a79e-50ea3a03dd08&ExternalInterface=AFEX","description":"Get list of fees
\nReturns fee information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Recipient unique identifier
\n","type":"text/plain"},"key":"RecipientPersonID","value":"737e76a5-f8d7-4019-a79e-50ea3a03dd08"},{"description":{"content":"AFEX, Rational, Currency Cloud
\n","type":"text/plain"},"key":"ExternalInterface","value":"AFEX"}],"variable":[]}},"response":[],"_postman_id":"705b44b4-aa57-4637-9c8a-78defc544648"}],"id":"75569ef2-1794-4e5f-8329-292d2b6cf1e7","_postman_id":"75569ef2-1794-4e5f-8329-292d2b6cf1e7","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get List of Banks
\nReturns banks information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Bank partial or full name
\n","type":"text/plain"},"key":"NameLike","value":"BAN"},{"description":{"content":"Required field
\n","type":"text/plain"},"key":"CountryID","value":"US"},{"key":"Page","value":"0"},{"key":"Items","value":"10"},{"description":{"content":"Bank or SWIFT
\n","type":"text/plain"},"key":"SearchBy","value":"bank"},{"key":"ExternalInterface","value":"AFEX"}],"variable":[]}},"response":[],"_postman_id":"89811a40-4866-4d06-8d26-e934e22b6495"},{"name":"BankSearch","id":"77c78bd0-05f2-4c71-bf43-64dab26090c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Bank/GetListOfBanks?NameLike=BAN&CountryID=US&Page=0&Items=10&SearchBy=bank&ExternalInterface=AFEX","description":"Get List of Banks
\nReturns banks information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Bank partial or full name
\n","type":"text/plain"},"key":"NameLike","value":"BAN"},{"description":{"content":"Required field
\n","type":"text/plain"},"key":"CountryID","value":"US"},{"key":"Page","value":"0"},{"key":"Items","value":"10"},{"description":{"content":"Bank or SWIFT
\n","type":"text/plain"},"key":"SearchBy","value":"bank"},{"key":"ExternalInterface","value":"AFEX"}],"variable":[]}},"response":[],"_postman_id":"77c78bd0-05f2-4c71-bf43-64dab26090c5"},{"name":"GetExternalBanksByProvider","id":"429513c3-cd05-481f-b9b7-3652f20fb9db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Bank/GetExternalBanksByProvider?CountryID=GB&ExternalInterface=AFEX&City=Norwich&SearchBy=NationalID&SearchText=4035","description":"Get List of Banks
\nReturns banks information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Required field
\n","type":"text/plain"},"key":"CountryID","value":"GB"},{"key":"ExternalInterface","value":"AFEX"},{"key":"City","value":"Norwich"},{"description":{"content":"NationalID || SWIFT
\n","type":"text/plain"},"key":"SearchBy","value":"NationalID"},{"key":"SearchText","value":"4035"}],"variable":[]}},"response":[],"_postman_id":"429513c3-cd05-481f-b9b7-3652f20fb9db"},{"name":"GetListOfBankBranches","id":"8e0053ca-121d-4636-8cee-b1377f6cad42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Bank/GetListOfBankBranches?BankName=Centennial Bank&BranchDescription=ba&CountryID=US&ExternalInterface=AFEX&Page=0&Items=10","description":"Get List of Bank Branches
\nReturns bank branches information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Partial or full bank name
\n","type":"text/plain"},"key":"BankName","value":"Centennial Bank"},{"description":{"content":"Branch description or branch identifier (i.e. ABA, Routing, Transit, etc.)
\n","type":"text/plain"},"key":"BranchDescription","value":"ba"},{"key":"CountryID","value":"US"},{"description":{"content":"AFEX, Rational, Currency Cloud
\n","type":"text/plain"},"key":"ExternalInterface","value":"AFEX"},{"key":"Page","value":"0"},{"key":"Items","value":"10"}],"variable":[]}},"response":[],"_postman_id":"8e0053ca-121d-4636-8cee-b1377f6cad42"},{"name":"GetListOfStates","id":"d2a9281b-c76e-40d6-aea3-4a041aa30f21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Global/GetListOfStates?CountryID=ZA","description":"Get list of states
\nReturns Currencies information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"2-character ISO code. \nThis API could return no values if there are no states or provinces available for the country
\n","type":"text/plain"},"key":"CountryID","value":"ZA"}],"variable":[]}},"response":[],"_postman_id":"d2a9281b-c76e-40d6-aea3-4a041aa30f21"},{"name":"GetCurrencies","id":"1a4f4078-7d06-4de6-8164-b806a7eaf85d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Global/GetCurrencies?ExternalInterface=AFEX","description":"Get currencies
\nReturns Currencies information.
\nRequest Parameters (body)
\nErrors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get lists
\nReturns lists information.
\nRequest Parameters (body)
\nItems for which list of values could be fetched
\n- \n
- Salutation \n
- Address Type \n
- Account Type \n
- Beneficiary Status \n
- Customer Type \n
- Customer Status \n
- Settlement Delivery Method \n
- Electronic Funds Transfer \n
- Incoming Instruments \n
- Wire Transfer \n
- Industry Sectors \n
- Deal Status \n
- Deal Paid Status \n
- Deal Disbursement Status Names \n
- Bank Status \n
- Purpose (Payment Purpose) \n
Errors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Use the indicated Listname in all the APIs
\n","type":"text/plain"},"key":"ListName","value":"Industry Sectors"},{"description":{"content":"AFEX, Rational, Currency Cloud
\n","type":"text/plain"},"key":"ExternalInterface","value":"AFEX"}],"variable":[]}},"response":[],"_postman_id":"0a89902f-285f-4587-b8b0-22c7dfea56d8"},{"name":"GetPurposeOfPaymentsList","id":"e3a86612-30e1-46b7-b22e-8791d34c53c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"SessionID","value":"{{SessionID}}","type":"text"}],"url":"{{global-payments-host}}/api/Global/GetPurposeOfPaymentsList?BankCountryCode=IN&BeneficiaryCountryCode=IN&Currency=INR&ExternalInterface=Rational","description":"Get lists
\nReturns lists information.
\nRequest Parameters (body)
\nItems for which list of values could be fetched
\n- \n
- Salutation \n
- Address Type \n
- Account Type \n
- Beneficiary Status \n
- Customer Type \n
- Customer Status \n
- Settlement Delivery Method \n
- Electronic Funds Transfer \n
- Incoming Instruments \n
- Wire Transfer \n
- Industry Sectors \n
- Deal Status \n
- Deal Paid Status \n
- Deal Disbursement Status Names \n
- Bank Status \n
- Purpose (Payment Purpose) \n
Errors & Exceptions
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"APIKey"},{"key":"value","value":"Get lists
\nReturns lists information.
\nRequest Parameters (body)
\nItems for which list of values could be fetched
\n- \n
- Salutation \n
- Address Type \n
- Account Type \n
- Beneficiary Status \n
- Customer Type \n
- Customer Status \n
- Settlement Delivery Method \n
- Electronic Funds Transfer \n
- Incoming Instruments \n
- Wire Transfer \n
- Industry Sectors \n
- Deal Status \n
- Deal Paid Status \n
- Deal Disbursement Status Names \n
- Bank Status \n