Welcome to the Verto FX Platform API documentation.
\nVertoFX is a cross-border payments and FX platform that allows businesses to have global & local accounts.
\nWe accept & send payments using accounts globally in 50 currencies on a single application.
\nThis document is written for a technical audience implementing online pay-in/out and currency exchange functions using VertoFX platform.
\nThe API integration model is the most simplest and straightforward way which enables secure pay-in/out and FX experience to take place behind the scenes. Available API calls for authentication, transaction and queries enable businesses to enjoy VertoFX features in a secure and safe manner from the backend without interacting with VertoFX screens.
\nThe API supports all platforms & languages that can implement HTTP RESTful methods.
\nTo try out our API on sandbox you can create on account using this link - https://sandbox.vertofx.com/auth/register.
\nA dedicated API test environment (staging) is available and all API action types given in this document can be tested using VertoFX API Test URL. All API requests should be sent to this URL address using HTTP RESTful methods.
\nVertoFX API Testing URL
\n\nVertoFX API Live URL
\n\nVertoFX is built on a robust and secure communication protocol. VertoFX API is a set of instructions submitted with standard HTTPS Post requests. At the server end, we use a certificate delivered by Verisign. The SSL encryption guarantees that it is our servers you are communicating with and that your data is transmitted in encrypted form.
\nWhen we receive a request, we check the level of encryption. Directly TLSv1.2 version and next version is supported.
\n\n\nNote:
\n
Non-encrypted HTTP connections are not accepted. Do not connect to our API with unencrypted HTTP, as this will transmit your access token in plaintext over the network
\n\nYou should also not proceed with a connection when you receive a certificate validation error from VertoFX. Make sure all parts of your application are using encryption and HTTPS and failing when certificate validation fails.
\n
You first authenticate to the API by providing an API token in the request. To know how to generate and access your client Id and Access token click here
\nYour Client ID & API Key combination enables you to access many privileges, so be sure to keep them secret.
\nFor security reasons, once copied, the API key will be invisible. If you lost your existing API key or was not able to save it; then you need to generate a new one by following the same steps.
\n\n\nNote:
\n
All API requests must be made over HTTPS and authenticated.
A request to the VertoFX API is made by sending a JSON request to VertoFX API Endpoint URL. Each HTTP POST request sent to the API URL should have a set of parameter-value pairs encoded in it, depending on the type of request being sent.
\nBaseURL to be used in all API Requests for the sandbox environment:
\nBaseURL : https://api-v3-sandbox.vertofx.com
\nVertoFX responses by default will be in the form of JSON format. You can use any JSON parsing tool or framework to process VertoFX responses.
\nIf a request results in an error, the relevant error code, message and details will be present in the response. The existing error codes in the system are as follows:
\n500 - Internal Server Error
\n400 - Bad Request, the request contains missing parameters, is in an incorrect shape, or failed a validation test
\n401 - Unauthorized - Please verify that the authentication token is provided and is valid
\n404 - Not Found - The requested endpoint or entity does not exist
\n200 - The request was processed successfully
\nVerto API v2.1 supports four main functional areas which are:
\nUsing the functions independently or together, you can automate many business use cases. The following diagram illustrates the standard FX and Payment flow which also gives a quick overview of a typical business case.
\nAfter the successful authentication to Verto API service (1), you can benefit from the following services:
\nCheck your wallet and balance information (2)
\nCheck the exchange rate (3)
\nExchange funds (4)
\nCreate and update Beneficiaries (5)
\nCreate payments (6)
\nYou can also check the status of exchange and payment transactions using “Get Order Details” and “Get Payment Details” services. You can find the details of these individual services in the following sections.
\n\n\nNote:
\n
You first need to authenticate to the API service by providing an API token in the request. You can get your API token using the AUTHORIZATION service specified below. This service requires you to send your Client ID & API Key which can be found on your Verto account profile.
In response you’ll be provided with a token that will be valid for 60 minutes. Simply add this token as header parameter to every request. Your Client ID & API Key set enables you to access many privileges, so be sure to keep them secret!
\nURL : - {{baseurl}}/users/login
\nYou first need to authenticate to the API by providing an \"Authorization Token\" in the request. You can get your Authorization token using the \"login'\" service.
\nThis service will require you to send your Client ID & API Key which can be found on your Verto account profile. Simply go to your Verto Account on the right hand side and select API Credentials option.
\nWhen clicked, your Client ID will be displayed along with the option to \"Generate New API Key\" as follows:
\n\n\nNote:
\n
The API Key will not be displayed again when you come back to this screen for security reasons. So please make sure that you copy your API Key and save securely at your end. However, if you lost your existing API key or were not able to save it; then you can obtain another one by deactivating the existing one and then generating a new one using the buttons on the top right corner.
You can send your Authorization request using the Client ID and API key values. In response to your request, you’ll be provided with a token value that will be valid for 60 minutes. You need to add this token as “header parameter” to your requests for other services.
\nFollowing API services available to support FX related business cases:
\nCreate FX Trade
\nGet FX Rate
\nGet FX Order Details
\nBook FX Trade (This service has been deprecated in v2)
\nPlease see the below diagram for a typical exchange use case flow.
\nFollowing API services available to support Beneficiaries related business cases:
\nCreate Beneficiaries
\nUpdate Beneficiaries
\nDelete Beneficiaries
\nList Beneficiaries
\nGet Beneficiary Details
\nPlease see the below diagram for a typical use case flow involving beneficiaries.
\n\n\nNote:
\n
If you are operating in the financial sector, your beneficiaries will be subject to approval. For all other clients, the beneficiaries will be auto-approved.
Following API services available to support withdrawal/payment related business cases.
\nCreate Payment Request
\nGet Payment Request Details
\nGet Payment Request List
\nIn addition to the beneficiaries, list wallet, list purpose codes services; you need to utilise the above given payment specific services.
\nPlease see the below diagram for a typical payment use case and possible values that you might get in the Status field.
\nIn response to some events, we generate and send out a webhook message to your defined URL.
\nThe events for which Verto API will send webhooks
\nFX status changes
\nWhen FX order is created
\nWhen inward order is confirmed
\nWhen inward order is disputed
\nWhen outward order is completed
\nWhen Outward order is disputed
\nBeneficiaries
\nWhen a Beneficiary is created with a status for pending
\nWhen a Beneficiary gets approved.
\nWhen a beneficiary gets rejected.
\nMaking Payments
\nWhen payment is requested
\nWhen payment request is completed
\nWhen payment is refunded
\nWhen Payment is achieved
\nReceiving Payments
\nWhen you receive a payment into your wallet from an external entity, this can be through our global accounts feature or directly into your wallet from a business which an entity on Verto.
\nWhen you add funds to your wallet.
\n\n\nNote:
\n
We don’t notify on any actions taken by the vertofx admin team, only for requests created by you or your customers. These would include actions like a manual credit intoyour wallet done by the verto operations team. In order to check balance use the wallet listing APIs
To configure the web hooks from your account
\nLogin to the production or sandbox account
\nGo to your profile and click on API
\nGo to Web hook settings
\nSave and continue
\nOnce you’re done configuring the call back URLs it should look something like this
\nWeb hooks that are sent and the responses we receive for them from the client can be seen in this section.
\nTo view more information on the log you can click on an individual record
\nYou are not required to authorize the callbacks sent by Verto API.
\nWe recommend you to whitelist the IP addresses listed below for both the Sandbox and Production environment.
\n18.157.51.166
\n18.198.227.220
\n18.235.242.90
\n3.208.60.185
\n//Example of the web hooks structure\n{\n \"payload\": {\n //Response for API goes here\n }\n}\n//Example response for a Beneficiary Approved\n{\n \"payload\": {\n \"id\": 9734,\n \"accountNumber\": \"121212184874848\",\n \"bankName\": \"Punjab National Bank\",\n \"beneficiaryAddress\": \"Plot No 4, Sector -10 Dwarka\",\n \"beneficiaryCity\": \"New Delhi\",\n \"beneficiaryCompanyName\": \"Test 3 \",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryPostcode\": \"110075\",\n \"country\": \"India\",\n \"reference\": \"RP-09112022-006\",\n \"nationalId\": \"PUNB0657700\",\n \"currency\": \"INR\",\n \"clientReference\": \"\",\n \"status\": \"approved\"\n }\n}\n//Example response for a payment outward approved\n{\n \"payload\": {\n \"id\": 6548,\n \"amount\": \"200000.00\",\n \"reference\": \"TO-22092024-005\",\n \"state\": \"completed\",\n \"currency\": \"NGN\",\n \"paymentId\": null,\n \"type\": \"wallet_to_account\",\n \"clientReference\": null,\n \"account\": {\n \"id\": 4369,\n \"accountNumber\": \"9079135431\",\n \"bankName\": \"MONIEPOINT MICROFINANCE BANK\",\n \"beneficiaryAddress\": \"\",\n \"beneficiaryCity\": \"\",\n \"beneficiaryCompanyName\": \"\",\n \"beneficiaryCountryCode\": \"\",\n \"beneficiaryEntityType\": \"individual\",\n \"beneficiaryPostcode\": \"\",\n \"beneficiaryEmail\": \"\",\n \"country\": \"Nigeria\",\n \"reference\": \"RP-19062024-003\",\n \"beneficiaryFirstName\": \"Daniel\",\n \"beneficiaryLastName\": \"Torkura\",\n \"nationalId\": \"090405\",\n \"currency\": \"NGN\",\n \"clientReference\": \"\",\n \"status\": \"approved\"\n },\n \"walletId\": 2561,\n \"createdDate\": \"2024-09-22T14:26:07.000Z\",\n \"completedDate\": \"2024-09-22T14:26:46.018Z\",\n \"archivedDate\": null\n }\n}\n//Example response for an inward payment to wallet from an external entity\n{\n \"payload\": {\n \"id\": 6546,\n \"amount\": \"230000.00\",\n \"reference\": \"TO-22092024-003\",\n \"state\": \"completed\",\n \"currency\": \"USD\",\n \"paymentId\": null,\n \"type\": \"iban_to_wallet\",\n \"clientReference\": \"null:test_sandbox:Daniel Torkura:1234567890:TY28239UY\",\n \"account\": {\n \"id\": 4368,\n \"accountNumber\": \"1234567890\",\n \"bankName\": null,\n \"beneficiaryAddress\": null,\n \"beneficiaryCity\": null,\n \"beneficiaryCompanyName\": \"Daniel Torkura\",\n \"beneficiaryCountryCode\": null,\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryPostcode\": null,\n \"beneficiaryEmail\": null,\n \"country\": null,\n \"reference\": \"RP-22092024-001\",\n \"beneficiaryFirstName\": null,\n \"beneficiaryLastName\": null,\n \"nationalId\": \"TY28239UY\",\n \"currency\": \"USD\",\n \"clientReference\": null,\n \"status\": \"approved\"\n },\n \"walletId\": 2558,\n \"createdDate\": \"2024-09-22T14:06:02.000Z\",\n \"completedDate\": \"2024-09-22T14:06:03.308Z\",\n \"archivedDate\": null\n }\n}\n//\"clientReference\": \"customReferenceLabel : \"vendorReferenceId : ultimateDebitorName : ultimateDebitorIdentifier : ultimateDebitorFinancialInstitution\"\n//vendorReferenceId - Sender reference (e.g Collaboration 09087).\n//ultimateDebitorName - Sender’s name.\n//ultimateDebitorIdentifier - Sender’s account number.\n//ultimateDebitorFinancialInstitution - Sender’s Bank.\n//Example response for an FX order being inward confirmed\n{\n \"payload\": {\n \"id\": 3791,\n \"reference\": \"EN-22092024-004\",\n \"amountFrom\": \"10000000.00\",\n \"amountTo\": \"7506100.00\",\n \"rate\": \"0.7506100000\",\n \"transactionState\": \"outward_remittance_complete\",\n \"status\": \"deposit_recorded\",\n \"createdDate\": \"2024-09-22T14:18:51.000Z\",\n \"completedDate\": \"2024-09-22T14:20:08.278Z\",\n \"archivedDate\": null,\n \"clientReference\": null,\n \"currencyFrom\": \"USD\",\n \"currencyTo\": \"GBP\"\n }\n}\n// Wallet to wallet inbound webhook\n{\n \"payload\": {\n \"id\": 6547,\n \"amount\": \"20000.00\",\n \"reference\": \"TO-22092024-004\",\n \"state\": \"completed\",\n \"currency\": \"USD\",\n \"paymentId\": null,\n \"type\": \"wallet_to_wallet\",\n \"clientReference\": null,\n \"walletId\": 3063,\n \"transactionType\": \"credit\",\n \"toWalletId\": 3063,\n \"fromWalletId\": 2558,\n \"createdDate\": \"2024-09-22T14:13:51.000Z\",\n \"completedDate\": \"2024-09-22T14:13:51.000Z\",\n \"archivedDate\": null\n }\n}\n// Wallet to wallet outbound webhook\n{\n \"payload\": {\n \"id\": 6547,\n \"amount\": \"20000.00\",\n \"reference\": \"TO-22092024-004\",\n \"state\": \"completed\",\n \"currency\": \"USD\",\n \"paymentId\": null,\n \"type\": \"wallet_to_wallet\",\n \"clientReference\": null,\n \"walletId\": 2558,\n \"transactionType\": \"debit\",\n \"toWalletId\": 3063,\n \"fromWalletId\": 2558,\n \"createdDate\": \"2024-09-22T14:13:51.000Z\",\n \"completedDate\": \"2024-09-22T14:13:51.000Z\",\n \"archivedDate\": null\n }\n}\n\nThe payload in the response would have the object for a successful API call for getting corresponding Data type.
\nWeb hooks are sent on events like when the payment status changes, beneficiary status changes and FX order changes.
\nIf there is a failure to consume these web hooks Verto has a mechanism to send a retry message for the consumer of the API to acknowledge.
\nVerto tries to send the web hook for failed attempts 10 times in the same day with an exponential back off.
\n1. How to use the Side field in the create fx request? I am already providing Currency From and Currency To information in the exchange token, why do I still need to specify the Side?
\nSuppose we say currency from = USD and currency to = GBP, the API will return us the rate of let’s say 0.8. Now, in Create FX if the clients only mention amount (e.g. 1000), it can mean either of the two options:
\nSELL 1000 USD and buy 800 GBP
\nSell 1250 USD to BUY 1000 GBP
\nTo prevent ambiguity, either we ask for both the amounts (from + to) OR ask amount + side (buy / sell)
\nBoth of the use cases are valid and depend on the client which one to opt.
\nThe side refers to the amount. If you say the amount is 100 and currencies are USD to NGN. That implies whether you want to sell 100 USD or buy 100 NGN
\n2. What are the statuses that GetPaymentDetails may return?
\nWhen you enquiry the status of payment, you may get following values in the response:
\nRequested - payment request received successfully.
\nCompleted - payment request completed.
\nRefunded - payment could not completed and funds returned.
\nArchived - payment archived due to being cancelled by the client or staying in the requested status over a certain period of time.
\n3. If the created beneficiary is subject to approval, how can we know whether a beneficiary has been approved or not. Where can we see the status of the beneficiaries?
\nGet beneficiaries List service will return all beneficiaries created and their statuses. Please make sure that you create your payment requests only for approved beneficiaries. Otherwise your payment request will return beneficiary not found error message.
\n4. On beneficiary creation, what are the required fields for USD Beneficiaries?
\nA/c Number + Routing Number / ABA Code (within the US - Domestic Payments)
\nA/c Number
\nRouting Number / ABA Code
\nBank Name
\nBeneficiary Address
\nBeneficiary City
\nBeneficiary PostCode
\nBeneficiary State or Province
\nA/c Number + Swift (Outside the US - International Payments)
\nA/c Number
\nSwift
\nBank Name
\nBeneficiary Address
\nBeneficiary City
\nBeneficiary PostCode
\nBeneficiary State or Province
\n5. What am I supposed to enter in the National ID field? Is it mandatory?
\nYes, the National ID field is mandatory and you can use this field to provide Beneficiary Bank’s BIC/Swift Code.
\n6. To create an FX trade, we have to generate a token first which lasts for 30 secs. What do we do if the client does not do the trade in 30 secs and does it after this period.
\nTo work around this, you can keep your wallet pre-funded to avoid market rates change risk, in order to get started using our API you'll need to have multi currency wallets and funds in these accounts.
\n7. Do I have to pay an extra amount to access the API.
\nYes, you can write to us on api.support@vertofx.com with your details, a sales person will get back to you to discuss commercials based on your usage volumes. This is only applicable to when you are ready to go live.
\n8. What happens post integration on sandbox, how do we go live?
\nOn agreement with us on the commercials to consume our APIs, we'll setup a tech review call with you on the integrations done, we'll create your account on the live environment, there will be a process of onboarding that'll take place which generally takes 1-2 days based on receiving required documents. Your billing on the API only starts once we turn on your API access on the live environment.
\nSend email to api.support@vertofx.com
\nWe have a dedicated team to talk to you. https://www.vertofx.com/contact
\nSearch our FAQ. https://vertofx.com/faq
\nContact Customer Excellence team. customersupport@vertofx.com
\nWe also setup slack channels on request, you can drop in a request on the above support mail ID and we'll set one up for a direct communication.
\nCreate Payment Request updated to accept Payment Id, passing duplicate payment Id will cause the request to fail. This is to avoid any double debit scenarios.
\nThe Get FX rate updated from rate to FX and it now accepts from and to currency codes, request mthod is changed from POST to Get
\nGet order details : /orders/v2/:orderId updated to /orders/v2.1/fx/:orderId
\nCreate Payment : /profile/v2/wallets/:walletId/payment updated to /profile/v2.1/request
\nCreate Payment : Wallet Id is taken from the request body
\nGet Payment Details : profile/v2/transferRequest/:requestId to profile/v2.1/request/:requestId
\nUpdate Beneficiary : /profile/v2/beneficiaries/account/:beneficiaryId to /profile/v2.1/beneficiaries/:beneficiaryId
\nYou can now get payments list, delete beneficiaries and get beneficiary details
\nGet FX rate the request method has been changed to GET from POST
\nCreate Beneficiary/Update Beneficiary
Change: We remove some fields from the request body, these fields auto fill by nationalId(Swift code/Bic/ABA code/ IFSC code/ Routing Number).
The fields which are removed are:
bankName
beneficiaryAddress
beneficiaryCity
New Field : clientReference to take a custom reference from the consumers of the API
Create Beneficiary/Update Beneficiary request body changes to make entity type mandatory and based on that either the individual details or the company name is mandatory
\nBrace yourself — game-changing APIs are on the horizon.
\nWe’re about to drop some powerful new functionality that will ignite fresh possibilities for developers and businesses.
\nGet ready to push boundaries and take your projects to the next level.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Quick Start Guide","slug":"quick-start-guide"},{"content":"Authorization","slug":"authorization"},{"content":"FX Services","slug":"fx-services"},{"content":"Beneficiary Services","slug":"beneficiary-services"},{"content":"Withdraw Services","slug":"withdraw-services"},{"content":"Webhooks","slug":"webhooks"},{"content":"FAQ","slug":"faq"},{"content":"Contact Us","slug":"contact-us"},{"content":"Change Log","slug":"change-log"},{"content":"Coming Soon","slug":"coming-soon"}],"owner":"18594636","collectionId":"70528056-a00c-4e19-8cf5-d721a6dad95f","publishedId":"UzBjrnt7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-06-24T03:46:59.000Z"},"item":[{"name":"Login","event":[{"listen":"test","script":{"id":"f44e87a4-dcc8-467e-af56-faa23bc7c949","exec":["let responseData=pm.response.json();\r","console.log(responseData);\r","pm.environment.set(\"bearer_token\", responseData.token);"],"type":"text/javascript"}}],"id":"e55bc777-3ae2-45c4-8a7a-ef62fdd00e5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"ACYK8A0FSA4E2YN0BHBEX8JP20NF\",\r\n \"apiKey\": \"3E4XZCW50S4BX7M7Q16MJZJDWFXEFN8ZMX77CMM9XBGSF3XC5K1GHCP0\",\r\n \"mode\": \"apiKey\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/users/login","description":"You first authenticate to the API by providing an Authorization Token in the request. You can get your Authorization token using the Authorization service.
\nThis service will require you to send your Client ID & API Key which can be found on your VertoFX account profile.
\nSimply go to your Verto Account on the right hand side and select API Credentials option. Click on Generate New API Key button. Your Client ID and API key will be generated and displayed on the screen.
\nClick on Copy icon and save it securely for your own records.
\nFor security reasons, once copied, the API key will be invisible. If you lost your existing API key or was not able to save it; then you need to generate a new one by following the same steps.
\nIn response to your request sent to Authorization service, you’ll be provided with a token value that will be valid for 60 minutes. You need to add this token as header parameter to relevant requests requiring it.
\n","urlObject":{"path":["users","login"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[],"variable":[]}},"response":[{"id":"bcd8feec-1ff9-4fe2-b544-69d712c0ec22","name":"Authorization","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"ACYK8A0FSA4E2YN0BHBEX8JP20NF\",\r\n \"apiKey\": \"3E4XZCW50S4BX7M7Q16MJZJDWFXEFN8ZMX77CMM9XBGSF3XC5K1GHCP0\",\r\n \"mode\": \"apiKey\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/users/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NCwic2Vzc2lvbklkIjoiNmM3NGNkN2UtZGM2My0zNGMwLTNhMGEtNTY1ZDZmYzMxZWFjIiwiaWF0IjoxNjU1MzAwMDE1LCJleHAiOjE2NTUzMDM2MTV9.hU0Kzv6rlgQxOnJOtn9AyXpH5xyLv85iQCFaGP_83d4\"\n}"}],"_postman_id":"e55bc777-3ae2-45c4-8a7a-ef62fdd00e5c"},{"name":"Get an FX Rate","event":[{"listen":"test","script":{"id":"7e981d3a-b5dd-4a41-8817-2249ba47fbf6","exec":["pm.test(\"Your test name\", function () {"," var jsonData = pm.response.json();","pm.environment.set(\"vfx_token\", jsonData.vfx_token);","});"],"type":"text/javascript","packages":{}}}],"id":"6ad5ce1e-2e9f-42e0-9172-5c584680a9b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/orders/v2.1/fx?currencyFrom=NGN¤cyTo=USD","description":"You can use this service to get the current actual FX rate for a given currency pair using CurrencyFrom and CurrencyTo fields. In the response you'll receive a vfx_token with an expiry of 30 seconds, you can use this token to Create an FX Trade.
(Required) The CurrencyFrom you want to trade
\n","type":"text/plain"},"key":"currencyFrom","value":"NGN"},{"description":{"content":"(Required) The CurrencyTo you want to trade
\n","type":"text/plain"},"key":"currencyTo","value":"USD"}],"variable":[]}},"response":[{"id":"1d3f334b-b6c3-4d0a-9b66-54cf33dfa656","name":"Get an FX Rate","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api-v3-sandbox.vertofx.com/orders/v2.1/fx?currencyFrom=USD¤cyTo=GBP","host":["https://api-v3-sandbox.vertofx.com"],"path":["orders","v2.1","fx"],"query":[{"key":"currencyFrom","value":"USD","description":"(Required) The CurrencyFrom you want to trade"},{"key":"currencyTo","value":"GBP","description":"(Required) The CurrencyTo you want to trade"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"fbfd96ce-bb9c-0137-cf79-0e875758d501"},{"key":"vfx-api-stack-id","value":"f0736ce3-b320-51c8-3086-40d59af25b55"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"313"},{"key":"ETag","value":"W/\"139-dHGv5PUig8Y2VVNJksJc+YWCTcI\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:00:07 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"rate\": 0.6391593,\n \"vfx_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXJyZW5jeUZyb20iOiJVU0QiLCJjdXJyZW5jeVRvIjoiR0JQIiwicmF0ZSI6MC42MzkxNTkzLCJzcHJlYWQiOjAuMDcxMDE3NywiaWF0IjoxNjU1Mzc3MjA3LCJleHAiOjE2NTUzNzcyMzd9.MY5CGm0U9MMKH5kT1Vv-tKcxhv3e6_KsODF-NTU5_qo\",\n \"expiry\": \"2022-06-16T11:00:37.003Z\"\n}"}],"_postman_id":"6ad5ce1e-2e9f-42e0-9172-5c584680a9b6"},{"name":"Get an FX Rate (New)","event":[{"listen":"test","script":{"id":"3c158b9c-dc4c-41d4-bf5f-4d087f3abcbf","exec":["pm.test(\"Your test name\", function () {"," var jsonData = pm.response.json();"," pm.environment.set(\"vfx_token\", jsonData.vfx_token);","});"],"type":"text/javascript","packages":{}}}],"id":"dacf7566-b865-4880-84f5-48f39734bfb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"paymentMode\": \"later\",\r\n \"currencyFrom\": {\r\n \"currencyName\": \"NGN\"\r\n },\r\n \"currencyTo\": {\r\n \"currencyName\": \"USD\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-exchange-now-sandbox.vertofx.com/fx/rate","description":"The get rates API can be used to current actual FX rate for a given currency pair using the currencyFrom, currencyTo and paymentMode. The paymentMode is used for specifying the settlement option you intend you use for the trade.
In the response you'll receive a vfx_token with an expiry of 30 seconds, you can use this token to Create an FX Trade.
Request
\nResponse
\n","urlObject":{"path":["fx","rate"],"host":["https://api-exchange-now-sandbox.vertofx.com"],"query":[],"variable":[]}},"response":[{"id":"525c645c-20c6-4cc1-a679-0ffecbc2d725","name":"Get an FX Rate (New)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"paymentMode\": \"later\",\n \"currencyFrom\": {\n \"currencyName\": \"NGN\"\n },\n \"currencyTo\": {\n \"currencyName\": \"USD\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-exchange-now-sandbox.vertofx.com/fx/rate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"rate\": 0.00167025,\n \"vfx_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXJyZW5jeUZyb20iOiJOR04iLCJjdXJyZW5jeUZyb21JZCI6bnVsbCwiY3VycmVuY3lUbyI6IlVTRCIsImN1cnJlbmN5VG9JZCI6bnVsbCwiYnlwYXNzQ2hlY2tzIjpmYWxzZSwiY29tcGFueUlkIjoiNTI1IiwicmF0ZSI6MC4wMDE2NzE3Mzc1LCJzcHJlYWQiOjAuMDAwMDI4MjYyNSwicGF5bWVudE1vZGUiOiJsYXRlciIsImlhdCI6MTcxNTMzNjU0MCwiZXhwIjoxNzE1MzM2NTcwfQ.cDeISzitUdSLeheJE3VYSdCrPoJWJz-eUcwxFWQkNU8\",\n \"expiry\": \"2024-05-10T10:22:49.994Z\",\n \"success\": true\n}"}],"_postman_id":"dacf7566-b865-4880-84f5-48f39734bfb4"},{"name":"Create an FX Trade","id":"687b5c29-0cef-4422-b2b0-68e75809b278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"vfx_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXJyZW5jeUZyb20iOiJVU0QiLCJjdXJyZW5jeVRvIjoiR0JQIiwicmF0ZSI6MC42MzkxNTkzLCJzcHJlYWQiOjAuMDcxMDE3NywiaWF0IjoxNjU1Mzc3ODU4LCJleHAiOjE2NTUzNzc4ODh9.QHk76hGswh_YTR1M95dda1Oah8ZBhy6NREVrhIPDwO8\",\n \"side\": \"BUY\",\n \"amount\": 100,\n \"clientReference\": \"Test100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/orders/v2.1/fx","description":"This service is used to convert money between different currencies within wallets.
\nYou will need to include vfx_token value in your request which is returned in the response of Get FXRate call and valid for 30 seconds only.
You also need to specify the side as either Sell or Buyas well as the amount subject to trade. Client Reference field is available for any internal use to identify the transaction
This API can be used to create an FX trade between all the currency pairs we support. You can convert it into another wallet or send the converted funds to a beneficiary.
\nRequest
\n","urlObject":{"path":["fx","payments"],"host":["https://api-exchange-now-sandbox.vertofx.com"],"query":[],"variable":[]}},"response":[{"id":"320404c5-1ac0-4d7b-98df-f7e65ef22d90","name":"convertWalletPayout","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"paymentType\": \"convertWalletPayout\",\n \"sourceWalletId\": 11435,\n \"sourceAmount\": 4800,\n \"purposeId\": 14,\n \"vfxToken\": \"{{vfx_token}}\",\n \"customPaymentReference\": null,\n \"targetAccountId\": 23181,\n \"paymentId\": \"277b6e05-5f22-450c-95b9-bfd2969dd7da\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api-exchange-now-sandbox.vertofx.com/fx/payments"},"status":"Created","code":200,"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"id\": \"20088\",\n \"reference\": \"EN-05062024-055\",\n \"userId\": \"2289\",\n \"companyId\": \"2233\",\n \"currencyFrom\": \"USD\",\n \"amountFrom\": 4800,\n \"currencyTo\": \"NGN\",\n \"amountTo\": 4936560,\n \"rate\": 1028.4456,\n \"pricing\": {\n \"overageFee\": 0,\n \"usageId\": \"6660409cc733e0fac55eb97f\",\n \"subscriptionId\": \"664b3fc0e8e52032427e0b70\"\n },\n \"state\": \"inwardSettlementDone\",\n \"source\": \"wallet\",\n \"sourceId\": 11435,\n \"target\": \"account\",\n \"targetId\": 32655,\n \"description\": null,\n \"inwardSettlementTime\": \"2024-06-05T10:40:44.000Z\",\n \"outwardSettlementTime\": null,\n \"purpose\": \"Professional fees payment(i.e. legal, accountant)\",\n \"scheduledAt\": null,\n \"expiredAt\": null,\n \"createdAt\": \"2024-06-05T10:40:29.000Z\",\n \"updatedAt\": \"2024-06-05T10:40:51.000Z\",\n \"transaction\": {\n \"receiver\": {\n \"accountNumber\": \"5401662301\",\n \"bankName\": \"Providus Bank\",\n \"name\": \"crest \",\n \"bankCode\": \"000023\"\n },\n \"shortURL\": \"https://pay.vertofx.com/n3hjz2v\"\n }\n}\n"},{"id":"56fece7c-7ccf-49f6-a41c-4a8a203ef349","name":"convertWithinWallets","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"paymentType\": \"convertWithinWallets\",\n \"sourceWalletId\": 11435,\n \"sourceAmount\": 4800,\n \"vfxToken\": \"{{vfx_token}}\",\n \"customPaymentReference\": null,\n \"targetWalletId\": 23181,\n \"paymentId\": \"cb11cf95-db51-4f2a-a233-8ae7ee939bf0\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://api-exchange-now-sandbox.vertofx.com/fx/payments"},"status":"Created","code":200,"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"id\": \"3685\",\n \"reference\": \"EN-12092024-024\",\n \"userId\": \"334\",\n \"companyId\": \"525\",\n \"currencyFrom\": \"GBP\",\n \"amountFrom\": 100,\n \"currencyTo\": \"USD\",\n \"amountTo\": 127.12,\n \"rate\": 1.2712360448,\n \"pricing\": {\n \"overageFee\": 0,\n \"usageId\": null,\n \"subscriptionId\": null\n },\n \"state\": \"inwardSettlementDone\",\n \"source\": \"wallet\",\n \"sourceId\": 2559,\n \"target\": \"wallet\",\n \"targetId\": 2558,\n \"depositAccountId\": null,\n \"description\": null,\n \"inwardSettlementTime\": \"2024-09-12T09:47:45.000Z\",\n \"outwardSettlementTime\": null,\n \"scheduledAt\": null,\n \"expiredAt\": null,\n \"createdAt\": \"2024-09-12T09:47:40.000Z\",\n \"updatedAt\": \"2024-09-12T09:47:45.000Z\"\n}"}],"_postman_id":"dfd0d6e7-0354-4d92-806f-efaa05456fcc"},{"name":"Get an FX Trade","id":"648c3f99-93b9-4003-9480-d946763ccb86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/orders/v2.1/fx/140","description":"This service is used to get the payment order details including its status. Simply add OrderID to your get URL and you will be returned the order details including reference, currencyFrom, currencyTo, amountFrom, amountTo, rate and transactionState information for the given OrderID.
This API can be used to get an FX trade using the Verto transaction id.
\n","urlObject":{"path":["fx",":reference"],"host":["https://api-exchange-now-sandbox.vertofx.com"],"query":[],"variable":[{"description":{"content":"Indicates FX order or wallet payment reference number or paymentId.
\n","type":"text/plain"},"type":"any","value":"EN-05062024-055","key":"reference"}]}},"response":[{"id":"e35239db-fc8b-4237-a6af-65644e3cc655","name":"Get an FX Trade (New)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-exchange-now-sandbox.vertofx.com/fx/:reference","protocol":"https","host":["api-exchange-now-sandbox","vertofx","com"],"path":["fx",":reference"],"variable":[{"key":"reference","value":"EN-05062024-055","description":"Indicates FX order or wallet payment reference number or paymentId."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"20088\",\n \"reference\": \"EN-05062024-055\",\n \"userId\": \"2289\",\n \"companyId\": \"2233\",\n \"currencyFrom\": \"USD\",\n \"amountFrom\": 4800,\n \"currencyTo\": \"NGN\",\n \"amountTo\": 4936560,\n \"rate\": 1028.4456,\n \"pricing\": {\n \"overageFee\": 0,\n \"usageId\": \"6660409cc733e0fac55eb97f\",\n \"subscriptionId\": \"664b3fc0e8e52032427e0b70\"\n },\n \"state\": \"inwardSettlementDone\",\n \"source\": \"wallet\",\n \"sourceId\": 11435,\n \"target\": \"account\",\n \"targetId\": 32655,\n \"description\": null,\n \"inwardSettlementTime\": \"2024-06-05T10:40:44.000Z\",\n \"outwardSettlementTime\": null,\n \"purpose\": \"Professional fees payment(i.e. legal, accountant)\",\n \"scheduledAt\": null,\n \"expiredAt\": null,\n \"createdAt\": \"2024-06-05T10:40:29.000Z\",\n \"updatedAt\": \"2024-06-05T10:40:51.000Z\",\n \"transaction\": {\n \"receiver\": {\n \"accountNumber\": \"5401662301\",\n \"bankName\": \"Providus Bank\",\n \"name\": \"crest \",\n \"bankCode\": \"000023\"\n },\n \"shortURL\": \"https://pay.vertofx.com/n3hjz2v\"\n },\n \"paymentId\": \"88ba34cd-7074-46f4-a006-4fd8c7a5e1e8\"\n}"}],"_postman_id":"f2f11fa7-d7e8-430c-8f57-2b4906493f66"},{"name":"Get all FX Trades (New)","event":[{"listen":"test","script":{"id":"3c158b9c-dc4c-41d4-bf5f-4d087f3abcbf","exec":["pm.test(\"Your test name\", function () {"," var jsonData = pm.response.json();"," pm.environment.set(\"vfx_token\", jsonData.vfx_token);","});"],"type":"text/javascript","packages":{}}}],"id":"4f26acb5-8a9b-427b-ab5a-aea9e97d7e78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"sourceTargetPairs\": [\r\n {\r\n \"source\": \"wallet\",\r\n \"target\": \"account\"\r\n },\r\n {\r\n \"source\": \"account\",\r\n \"target\": \"wallet\"\r\n },\r\n {\r\n \"source\": \"account\",\r\n \"target\": \"account\"\r\n },\r\n {\r\n \"source\": \"wallet\",\r\n \"target\": \"wallet\"\r\n }\r\n ],\r\n \"state\": {\r\n \"include\": [\r\n \"inwardSettlementDone\"\r\n ]\r\n },\r\n \"createdStartDate\": \"2024-02-20T18:30:00.000Z\",\r\n \"createdEndDate\": \"2024-03-22T18:29:59.999Z\",\r\n \"paymentIds\": [\"88ba34cd-7074-46f4-a006-4fd8c7a5e1e8\", \"807e02f5-7235-4826-aef5-d93c75216b48\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-exchange-now-sandbox.vertofx.com/fx/list?limit=20&skip=10","description":"Fetch all the FX trades initiated by your company.
\n","urlObject":{"path":["fx","list"],"host":["https://api-exchange-now-sandbox.vertofx.com"],"query":[{"description":{"content":"Required:\nThe total number of items you want to fetch.
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"Required:\nThe total number of items you want skipped.
\n","type":"text/plain"},"key":"skip","value":"10"}],"variable":[]}},"response":[{"id":"a8df2bac-347b-4a30-9bee-6ff520b38020","name":"Get all FX Trades (New)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"sourceTargetPairs\": [\r\n {\r\n \"source\": \"wallet\",\r\n \"target\": \"account\"\r\n },\r\n {\r\n \"source\": \"account\",\r\n \"target\": \"wallet\"\r\n },\r\n {\r\n \"source\": \"account\",\r\n \"target\": \"account\"\r\n },\r\n {\r\n \"source\": \"wallet\",\r\n \"target\": \"wallet\"\r\n }\r\n ],\r\n \"state\": {\r\n \"include\": [\r\n \"inwardSettlementDone\"\r\n ]\r\n },\r\n \"createdStartDate\": \"2024-02-20T18:30:00.000Z\",\r\n \"createdEndDate\": \"2024-03-22T18:29:59.999Z\",\r\n \"paymentIds\": [\"88ba34cd-7074-46f4-a006-4fd8c7a5e1e8\", \"807e02f5-7235-4826-aef5-d93c75216b48\"]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-exchange-now-sandbox.vertofx.com/fx/list?limit=20&skip=10","protocol":"https","host":["api-exchange-now-sandbox","vertofx","com"],"path":["fx","list"],"query":[{"key":"limit","value":"20","description":"Required:\nThe total number of items you want to fetch."},{"key":"skip","value":"10","description":"Required:\nThe total number of items you want skipped."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": 355,\n \"items\": [\n {\n \"id\": \"20088\",\n \"reference\": \"EN-05062024-055\",\n \"userId\": \"2289\",\n \"companyId\": \"2233\",\n \"currencyFrom\": \"USD\",\n \"amountFrom\": 4800,\n \"currencyTo\": \"NGN\",\n \"amountTo\": 4936560,\n \"rate\": 1028.4456,\n \"pricing\": {\n \"overageFee\": 0,\n \"usageId\": \"6660409cc733e0fac55eb97f\",\n \"subscriptionId\": \"664b3fc0e8e52032427e0b70\"\n },\n \"state\": \"inwardSettlementDone\",\n \"source\": \"wallet\",\n \"sourceId\": 11435,\n \"target\": \"account\",\n \"targetId\": 32655,\n \"description\": null,\n \"inwardSettlementTime\": \"2024-06-05T10:40:44.000Z\",\n \"outwardSettlementTime\": null,\n \"purpose\": \"Professional fees payment(i.e. legal, accountant)\",\n \"scheduledAt\": null,\n \"expiredAt\": null,\n \"createdAt\": \"2024-06-05T10:40:29.000Z\",\n \"updatedAt\": \"2024-06-05T10:40:51.000Z\",\n \"transaction\": {\n \"receiver\": {\n \"accountNumber\": \"5401662301\",\n \"bankName\": \"Providus Bank\",\n \"name\": \"crest \",\n \"bankCode\": \"000023\"\n },\n \"shortURL\": \"\"\n },\n \"paymentId\": \"064e9219-401e-4cec-a201-6324266bc3cb\"\n },\n {\n \"id\": \"20064\",\n \"reference\": \"EN-05062024-030\",\n \"userId\": \"2289\",\n \"companyId\": \"2233\",\n \"currencyFrom\": \"GBP\",\n \"amountFrom\": 7880,\n \"currencyTo\": \"USD\",\n \"amountTo\": 9984.84,\n \"rate\": 1.2671113414,\n \"pricing\": {\n \"overageFee\": 0,\n \"usageId\": null,\n \"subscriptionId\": null\n },\n \"state\": \"outwardSettlementDone\",\n \"source\": \"wallet\",\n \"sourceId\": 11436,\n \"target\": \"wallet\",\n \"targetId\": 16024,\n \"description\": null,\n \"inwardSettlementTime\": \"2024-06-05T08:28:16.000Z\",\n \"outwardSettlementTime\": \"2024-06-05T08:28:21.000Z\",\n \"scheduledAt\": null,\n \"expiredAt\": null,\n \"createdAt\": \"2024-06-05T08:28:13.000Z\",\n \"updatedAt\": \"2024-06-05T08:28:21.000Z\",\n \"paymentId\": \"c00ce727-e376-4a07-abc2-ba9178c9931c\"\n },\n {\n \"id\": \"20032\",\n \"reference\": \"EN-04062024-069\",\n \"userId\": \"2289\",\n \"companyId\": \"2233\",\n \"currencyFrom\": \"AUD\",\n \"amountFrom\": 4000,\n \"currencyTo\": \"USD\",\n \"amountTo\": 2242.98,\n \"rate\": 0.5607452955,\n \"pricing\": {\n \"overageFee\": 0,\n \"usageId\": \"665eecc7af3ae240252e360f\",\n \"subscriptionId\": \"664b3fc0e8e52032427e0b70\"\n },\n \"state\": \"confirmed\",\n \"source\": \"account\",\n \"sourceId\": null,\n \"target\": \"account\",\n \"targetId\": 32593,\n \"description\": null,\n \"inwardSettlementTime\": null,\n \"outwardSettlementTime\": null,\n \"purpose\": \"Professional fees payment(i.e. legal, accountant)\",\n \"scheduledAt\": null,\n \"expiredAt\": null,\n \"createdAt\": \"2024-06-04T10:30:21.000Z\",\n \"updatedAt\": \"2024-06-04T10:32:20.000Z\",\n \"transaction\": {\n \"receiver\": {\n \"accountNumber\": \"48488488\",\n \"bankName\": \"Access Bank Kenya PLC\",\n \"name\": \"Verto ka company\",\n \"bankCode\": \"ABNGKENA\"\n },\n \"shortURL\": \"\"\n },\n \"paymentId\": \"d499aa62-861b-460d-a8d5-7c2f95fe9c51\"\n },\n {\n \"id\": \"20029\",\n \"reference\": \"EN-04062024-066\",\n \"userId\": \"2289\",\n \"companyId\": \"2233\",\n \"currencyFrom\": \"GBP\",\n \"amountFrom\": 4000,\n \"currencyTo\": \"USD\",\n \"amountTo\": 5060.88,\n \"rate\": 1.2652207418,\n \"pricing\": {\n \"overageFee\": 0,\n \"usageId\": \"665eea1dcfa84cee1b5e3a51\",\n \"subscriptionId\": \"664b3fc0e8e52032427e0b70\"\n },\n \"state\": \"inwardSettlementDone\",\n \"source\": \"wallet\",\n \"sourceId\": 11436,\n \"target\": \"account\",\n \"targetId\": 32592,\n \"description\": null,\n \"inwardSettlementTime\": \"2024-06-04T10:20:06.000Z\",\n \"outwardSettlementTime\": null,\n \"purpose\": \"Purchase of Professional Service(s)\",\n \"scheduledAt\": null,\n \"expiredAt\": null,\n \"createdAt\": \"2024-06-04T10:19:05.000Z\",\n \"updatedAt\": \"2024-06-04T10:20:10.000Z\",\n \"transaction\": {\n \"receiver\": {\n \"accountNumber\": \"48488488\",\n \"bankName\": \"Access Bank Kenya PLC\",\n \"name\": \"Verto ka company\",\n \"bankCode\": \"ABNGKENA\"\n },\n \"shortURL\": \"\"\n },\n \"paymentId\": \"88ba34cd-7074-46f4-a006-4fd8c7a5e1e8\"\n },\n {\n \"id\": \"20028\",\n \"reference\": \"EN-04062024-065\",\n \"userId\": \"2289\",\n \"companyId\": \"2233\",\n \"currencyFrom\": \"USD\",\n \"amountFrom\": 1000,\n \"currencyTo\": \"NGN\",\n \"amountTo\": 1028445.6,\n \"rate\": 1028.4456,\n \"pricing\": {\n \"overageFee\": 0,\n \"usageId\": \"665ee9b0cfa84cee1b5e3a50\",\n \"subscriptionId\": \"664b3fc0e8e52032427e0b70\"\n },\n \"state\": \"inwardSettlementDone\",\n \"source\": \"wallet\",\n \"sourceId\": 11435,\n \"target\": \"account\",\n \"targetId\": 32591,\n \"description\": null,\n \"inwardSettlementTime\": \"2024-06-04T10:18:48.000Z\",\n \"outwardSettlementTime\": null,\n \"purpose\": \"Purchase of Professional Service(s)\",\n \"scheduledAt\": null,\n \"expiredAt\": null,\n \"createdAt\": \"2024-06-04T10:16:27.000Z\",\n \"updatedAt\": \"2024-06-04T10:18:55.000Z\",\n \"transaction\": {\n \"receiver\": {\n \"accountNumber\": \"7844554554\",\n \"bankName\": \"ACCESS BANK PLC (DIAMOND)\",\n \"name\": \"Haryanka Industries\",\n \"bankCode\": \"000005\"\n },\n \"shortURL\": \"\"\n },\n \"paymentId\": \"812\"\n }\n ]\n}"}],"_postman_id":"4f26acb5-8a9b-427b-ab5a-aea9e97d7e78"},{"name":"Create a Beneficiary","id":"c9b29398-7a5b-4a6d-bedd-148fb988b2a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"currency\": \"NGN\",\n \"beneficiaryCountryCode\": \"NG\",\n \"accountNumber\": \"2000293918130\",\n \"nationalId\": \"PUNB0644100\",\n \"country\": \"India\",\n \"clientReference\": \"Test-Bene100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries","description":"This service is used to create a beneficiary through the Verto API. Beneficiaries undergo an approval process once they are created. This is subject to the type of business, if you are a money serving business, beneficiaries will go through an approval process in the live environment.
\n","urlObject":{"path":["profile","v2.1","beneficiaries"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[],"variable":[]}},"response":[{"id":"012a3366-0c82-4175-ace1-182c3f8b0d58","name":"Create a Beneficiary","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"currency\": \"INR\",\n \"beneficiaryCountryCode\": \"IN\",\n \"accountNumber\": \"2000293918130\",\n \"nationalId\": \"PUNB0644100\",\n \"country\": \"India\",\n \"clientReference\": \"Test-Bene100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"0b89a983-866a-9f10-f064-8f2394d07d85"},{"key":"vfx-api-stack-id","value":"4d5d2a3a-2577-5b39-c55d-329ee6121dbb"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"551"},{"key":"ETag","value":"W/\"227-eoje+2pZebQ5LX4l9/DFgNf1Pjk\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:20:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"account\": {\n \"id\": 284,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"country\": \"India\",\n \"reference\": \"RP-09062022-003\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": \"Test-Bene100\",\n \"status\": \"approved\"\n }\n}"}],"_postman_id":"c9b29398-7a5b-4a6d-bedd-148fb988b2a3"},{"name":"Get a Beneficiary","id":"b7aa6f3f-d74b-4c32-b9db-e8329721e38d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries/284","description":"This service is used to get the details of a particular beneficiary including status. Simply add BeneficiaryAccountID to your get URL and you will be returned the beneficiary details including ID, accountNumber, bankName, address, clientReference, status and other fields too.
This service is used to get the list of all beneficiaries set for a particular user including the details such as ID, account number, bank name, address, clientReference, status and other fields too.
\n","urlObject":{"path":["profile","v2.1","beneficiaries"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[{"description":{"content":"(Required) The no. of accounts show on a page
\n","type":"text/plain"},"key":"customPageSize","value":"10"},{"description":{"content":"(Required) The current page no.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"c11139bc-00e9-4265-bbd8-d2d235da196e","name":"Get all Beneficiaries","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries?customPageSize=10&page=1","host":["https://api-v3-sandbox.vertofx.com"],"path":["profile","v2.1","beneficiaries"],"query":[{"key":"customPageSize","value":"10","description":"(Required) The no. of accounts show on a page"},{"key":"page","value":"1","description":"(Required) The current page no."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"cd246b3a-7ad1-a25d-385d-ae7209bfd48d"},{"key":"vfx-api-stack-id","value":"a32ca87b-0725-732b-71a4-dcb2c41966fc"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"5113"},{"key":"ETag","value":"W/\"13f9-0+BODhdSnkJrn6HzJv9podYlAzw\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:20:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 284,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"country\": \"India\",\n \"reference\": \"RP-09062022-003\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": \"Test-Bene100\",\n \"status\": \"approved\"\n },\n {\n \"id\": 283,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"Verto\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryPostcode\": \"122001\",\n \"country\": \"India\",\n \"reference\": \"RP-16062022-001\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": null,\n \"status\": \"approved\"\n },\n {\n \"id\": 282,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryEmail\": \"test_100@gmail.com\",\n \"country\": \"India\",\n \"reference\": \"RP-09062022-003\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": \"Test-100\",\n \"status\": \"approved\"\n },\n {\n \"id\": 278,\n \"accountNumber\": \"8311547163\",\n \"bankName\": \"Community Federal Savings Bank\",\n \"beneficiaryAddress\": \"89-16 JAMAICA AVENUE\",\n \"beneficiaryCity\": \"QUEENS\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"US\",\n \"beneficiaryEntityType\": \"company\",\n \"country\": \"USA\",\n \"reference\": \"RP-09062022-004\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"CMFGUS33\",\n \"currency\": \"USD\",\n \"clientReference\": null,\n \"status\": \"approved\"\n },\n {\n \"id\": 277,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"country\": \"India\",\n \"reference\": \"RP-09062022-003\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"USD\",\n \"clientReference\": null,\n \"status\": \"approved\"\n },\n {\n \"id\": 276,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"BANCO SAFRA SA\",\n \"beneficiaryAddress\": \"LUXEMBOURG\",\n \"beneficiaryCity\": \"LUXEMBOURG\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"US\",\n \"beneficiaryEntityType\": \"company\",\n \"reference\": \"RP-09062022-001\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"SAFRLULLCCY\",\n \"currency\": \"USD\",\n \"clientReference\": null,\n \"status\": \"approved\"\n },\n {\n \"id\": 275,\n \"accountNumber\": \"8311547160\",\n \"bankName\": \"Community Federal Savings Bank\",\n \"beneficiaryAddress\": \"89-16 JAMAICA AVENUE\",\n \"beneficiaryCity\": \"QUEENS\",\n \"beneficiaryCompanyName\": \"Test OU\",\n \"beneficiaryCountryCode\": \"US\",\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryPostcode\": \"11421\",\n \"reference\": \"RP-09062022-002\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"CMFGUS33\",\n \"currency\": \"USD\",\n \"clientReference\": null,\n \"status\": \"approved\"\n },\n {\n \"id\": 272,\n \"accountNumber\": \"123654789\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"individual\",\n \"beneficiaryPostcode\": \"122001\",\n \"beneficiaryEmail\": \"test@test.com\",\n \"reference\": \"RP-06062022-002\",\n \"beneficiaryFirstName\": \"final \",\n \"beneficiaryLastName\": \"test\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": null,\n \"status\": \"approved\"\n },\n {\n \"id\": 267,\n \"accountNumber\": \"111111\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"individual\",\n \"beneficiaryEmail\": \"test@test.com\",\n \"reference\": \"RP-25052022-001\",\n \"beneficiaryFirstName\": \"final \",\n \"beneficiaryLastName\": \"test\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": \"Testing10\",\n \"status\": \"approved\"\n },\n {\n \"id\": 266,\n \"accountNumber\": \"11111\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"individual\",\n \"beneficiaryEmail\": \"test@test.com\",\n \"reference\": \"RP-23022022-001\",\n \"beneficiaryFirstName\": \"final \",\n \"beneficiaryLastName\": \"test\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": \"Testing10\",\n \"status\": \"approved\"\n }\n ],\n \"metaData\": {\n \"total\": 35,\n \"current_page\": \"1\",\n \"page_size\": \"10\"\n }\n}"}],"_postman_id":"50d68b8c-c215-46d3-ad1a-ef09ac9df49e"},{"name":"Update a Beneficiary","id":"72e33096-bb84-441b-9e16-70aab4ea6355","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"beneficiaryCompanyName\": \"Verto\",\n \"currency\": \"INR\",\n \"beneficiaryCountryCode\": \"IN\",\n \"accountNumber\": \"2000293918130\",\n \"nationalId\": \"PUNB0644100\",\n \"country\": \"India\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries/283","description":"This service is used to update a beneficiary by specifying by their ID.
\nBeneficiaries undergo an approval process once they are updated. This is subject to the type of business, if you are a money serving business, beneficiaries will go through an approval process in the live environment.
\nEndFragment
\n","urlObject":{"path":["profile","v2.1","beneficiaries","283"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[],"variable":[]}},"response":[{"id":"57d41133-78ff-4590-83c3-8bf5ca456e6f","name":"Update a Beneficiary","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"beneficiaryCompanyName\": \"Verto\",\n \"currency\": \"INR\",\n \"beneficiaryCountryCode\": \"IN\",\n \"accountNumber\": \"2000293918130\",\n \"nationalId\": \"PUNB0644100\",\n \"country\": \"India\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries/283"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"e488610a-35be-7365-134c-b8dddc2911c1"},{"key":"vfx-api-stack-id","value":"e354c25b-9142-bfe0-77e1-34ba5d2096c5"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"548"},{"key":"ETag","value":"W/\"224-USV85up5jcznurxOKc9+yBxqkd0\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:14:50 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"account\": {\n \"id\": 283,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"Verto\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"beneficiaryPostcode\": \"122001\",\n \"country\": \"India\",\n \"reference\": \"RP-16062022-001\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": null,\n \"status\": \"approved\"\n }\n}"}],"_postman_id":"72e33096-bb84-441b-9e16-70aab4ea6355"},{"name":"Delete a Beneficiary","id":"cd004b69-348f-42dc-bfa4-ef1cc6fde325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries/2435","description":"This service helps you delete an existing beneficiary by providing beneficiary Id in the URL.
\nIf you don't know what the beneficiary Id is you can use the Get Beneficiary List API and use the field ID that comes in the list.
\n\n\nNote:
\n
Make sure that beneficiary is not included in any payment transaction.
Request Details
\nResponse Details
\n","urlObject":{"path":["profile","v2.1","beneficiaries","2435"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[],"variable":[]}},"response":[{"id":"462d6be6-315c-4e80-a778-ae56dba5f76b","name":"Delete a Beneficiary","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries/283"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true\r\n}"}],"_postman_id":"cd004b69-348f-42dc-bfa4-ef1cc6fde325"},{"name":"Get all Wallets","id":"db62b051-363a-4db3-b90a-502fd4c0e947","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/wallets?customPageSize=50&page=1","description":"This service is used to get the list of all wallets of a particular user account on Verto platform. The response will include the wallet ID, balance, currency and customReferenceLabel for all available wallets.
\n","urlObject":{"path":["profile","v2.1","wallets"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[{"key":"customPageSize","value":"50"},{"description":{"content":"(Required) The current page no.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"f52adc2d-24ea-428d-8976-031c2d558985","name":"Get all Wallets","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api-v3-sandbox.vertofx.com/profile/v2.1/wallets?customPageSize=50&page=1","host":["https://api-v3-sandbox.vertofx.com"],"path":["profile","v2.1","wallets"],"query":[{"key":"customPageSize","value":"50"},{"key":"page","value":"1","description":"(Required) The current page no."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"e33df614-dda3-66ef-aec3-339b5fe6714e"},{"key":"vfx-api-stack-id","value":"341e8f25-e1e8-ff38-8e41-962e3af3926b"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"779"},{"key":"ETag","value":"W/\"30b-VMQUamOlkdhcSrmxTzC+L1xBTCY\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:22:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 19,\n \"balance\": \"0.00\",\n \"currency\": \"BDT\"\n },\n {\n \"id\": 18,\n \"balance\": \"30316.94\",\n \"currency\": \"EUR\"\n },\n {\n \"id\": 14,\n \"balance\": \"575.15\",\n \"currency\": \"GBP\"\n },\n {\n \"id\": 12,\n \"balance\": \"0.00\",\n \"currency\": \"MYR\"\n },\n {\n \"id\": 11,\n \"balance\": \"0.00\",\n \"currency\": \"THB\"\n },\n {\n \"id\": 10,\n \"balance\": \"0.00\",\n \"currency\": \"KWD\"\n },\n {\n \"id\": 9,\n \"balance\": \"0.00\",\n \"currency\": \"QAR\"\n },\n {\n \"id\": 8,\n \"balance\": \"0.00\",\n \"currency\": \"IDR\"\n },\n {\n \"id\": 7,\n \"balance\": \"0.00\",\n \"currency\": \"HRK\"\n },\n {\n \"id\": 6,\n \"balance\": \"0.00\",\n \"currency\": \"RUB\"\n },\n {\n \"id\": 5,\n \"balance\": \"0.00\",\n \"currency\": \"BGN\"\n },\n {\n \"id\": 3,\n \"balance\": \"556.00\",\n \"currency\": \"INR\"\n },\n {\n \"id\": 4,\n \"balance\": \"0.00\",\n \"currency\": \"BHD\"\n },\n {\n \"id\": 2,\n \"balance\": \"0.00\",\n \"currency\": \"CNY\"\n },\n {\n \"id\": 1,\n \"balance\": \"11132.69\",\n \"customReferenceLabel\": \"USDDD\",\n \"currency\": \"USD\"\n }\n ],\n \"metaData\": {\n \"total\": 15,\n \"current_page\": \"1\",\n \"page_size\": \"50\"\n }\n}"}],"_postman_id":"db62b051-363a-4db3-b90a-502fd4c0e947"},{"name":"Get all Wallets (v2.2)","id":"4b229f73-59f4-4b6a-9014-c9db1ad08de9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.2/wallets?customPageSize=50&page=1","description":"This endpoint is used to fetch all the wallets associated with your account.
\nFetching your wallets and wallet information is important because it allows you to know all the wallets available on your account.
\nA successful request returns the walletId, and currency for all available wallets.
\n","urlObject":{"path":["profile","v2.2","wallets"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[{"description":{"content":"(Required) The no. of accounts show on a page
\n","type":"text/plain"},"key":"customPageSize","value":"50"},{"description":{"content":"(Required) The current page no.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"c89943f9-3a69-4a01-9488-6ad6078eb137","name":"Get all Wallets (v2.2)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api-v3-sandbox.vertofx.com/profile/v2.2/wallets/:id ","host":["https://api-v3-sandbox.vertofx.com"],"path":["profile","v2.2","wallets",":id "],"variable":[{"key":"id ","value":"2560","description":"Indicates the unique wallet id assigned to each wallet."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"103ccd99-062f-b6a2-9dac-a4f539c7a86e"},{"key":"vfx-api-stack-id","value":"12339f43-8b5a-c9cc-6f16-1e5449dd2099"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"689"},{"key":"ETag","value":"W/\"2b1-6HkVrr7w+xFGUy099VtkjmxGJV0\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:25:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2809,\n \"currency\": \"GHS\"\n },\n {\n \"id\": 2718,\n \"currency\": \"ZAR\"\n }\n ],\n \"metadata\": {\n \"total\": 11,\n \"currentPage\": 1,\n \"pageSize\": 10\n }\n}\n"}],"_postman_id":"4b229f73-59f4-4b6a-9014-c9db1ad08de9"},{"name":"Get a Wallet (v2.2)","id":"b25e5845-421f-4d1e-bbf2-26ba191e3acc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.2/wallets/:id ","description":"This endpoint is used to fetch the details of a wallet such as the balance and account details.
\nFetching the wallet details returns the currency, balance and account details. A wallet can be linked to one account, two accounts or zero. Also, the type of account referenced as the account mode can either be multi (two accounts), global/local (one) or none (zero).
\nThe details also vary based also based on the currency. You can find out more here.
\n","urlObject":{"path":["profile","v2.2","wallets",":id "],"host":["https://api-v3-sandbox.vertofx.com"],"query":[],"variable":[{"description":{"content":"Indicates the unique wallet id assigned to each wallet.
\n","type":"text/plain"},"type":"any","value":"2560","key":"id "}]}},"response":[{"id":"6ea5398e-f897-4242-8dfb-736f451be7a9","name":"Get a Wallet (v2.2)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api-v3-sandbox.vertofx.com/profile/v2.2/wallets/:id ","host":["https://api-v3-sandbox.vertofx.com"],"path":["profile","v2.2","wallets",":id "],"variable":[{"key":"id ","value":"2560","description":"Indicates the unique wallet id assigned to each wallet."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"103ccd99-062f-b6a2-9dac-a4f539c7a86e"},{"key":"vfx-api-stack-id","value":"12339f43-8b5a-c9cc-6f16-1e5449dd2099"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"689"},{"key":"ETag","value":"W/\"2b1-6HkVrr7w+xFGUy099VtkjmxGJV0\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:25:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"wallet\": {\n \"id\": 2560,\n \"customReferenceLabel\": \"Default USD Wallet\",\n \"balance\": \"10000000\",\n \"currency\": \"EUR\",\n \"accountMode\": \"multi\",\n \"localAccountDetails\": {\n \"name\": \"HeyPay\",\n \"accountNumber\": \"DE60202208000094767314\",\n \"sortCode\": \"SXPYDEHH\",\n \"bankName\": \"BankingCircle\",\n \"bankAddress\": \"MAXIMILIANSTR 54, MUENCHEN, D-80538, Germany\"\n },\n \"globalAccountDetails\": {\n \"name\": \"HeyPay\",\n \"accountNumber\": \"DK8089000094767314\",\n \"swiftCode\": \"SXPYDKKK\",\n \"bankName\": \"BankingCircle\",\n \"bankAddress\": \"AMERIKA PLADS 38, KOEBENHAVN, 2900, Denmark\"\n }\n }\n}"}],"_postman_id":"b25e5845-421f-4d1e-bbf2-26ba191e3acc"},{"name":"Create a Wallet-to-Wallet Transfer (New)","id":"daf2b738-4cbf-4ca4-8c14-341d84e50453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": 1000,\r\n \"currency\": \"USD\",\r\n \"sourceWalletId\": 1,\r\n \"targetWalletId\": 2,\r\n \"description\": \"Internal funds movement\",\r\n \"externalUniqueRef\": \"71467f6d-58ed-400f-89b6-20db028fb498\"\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"https://api-payment-sandbox.vertofx.com/transfer","description":"The wallet-to-wallet API enables seamless transfer of funds between two same currency wallets within your Verto account.
\n","urlObject":{"protocol":"https","path":["transfer"],"host":["api-payment-sandbox","vertofx","com"],"query":[],"variable":[]}},"response":[{"id":"141f495a-255f-406d-97ee-c0b7da778966","name":"Create a Wallet-to-Wallet Transfer (New)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1000,\n \"currency\": \"USD\",\n \"sourceWalletId\": 3064,\n \"targetWalletId\": 3063,\n \"description\": \"Internal funds movement\",\n \"externalUniqueRef\": \"71467f6d-58ed-400f-89b6-20db028fb498\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-payment-sandbox.vertofx.com/transfer"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"amount\": 200,\n \"currency\": \"USD\",\n \"reference\": \"T0-28052024-046\",\n \"description\": \"Internal funds movement\",\n \"sourceWalletId\": 3064,\n \"targetWalletId\": 3063,\n \"state\": \"completed\",\n \"externalUniqueRef\": \"71467f6d-58ed-400f-89b6-20db028fb498\"\n}"}],"_postman_id":"daf2b738-4cbf-4ca4-8c14-341d84e50453"},{"name":"Get all Purpose Codes","id":"0972c4ff-2676-472d-838d-6901f949e52c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/purpose?purpose=true","description":"This service is used to gather all purpose codes in the system used for payments. As it is mandatory to specify a purpose code in generating payments, you will need this information in order to use Create Payment service.
\n","urlObject":{"path":["profile","v2.1","purpose"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[{"description":{"content":"(Required) Purpose must be true
\n","type":"text/plain"},"key":"purpose","value":"true"}],"variable":[]}},"response":[{"id":"7a9a721d-e987-4ce6-b9e0-022052c694ce","name":"Get all Purpose Codes","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api-v3-sandbox.vertofx.com/profile/v2.1/purpose?purpose=true","host":["https://api-v3-sandbox.vertofx.com"],"path":["profile","v2.1","purpose"],"query":[{"key":"purpose","value":"true","description":"(Required) Purpose must be true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"4c4c5581-7178-8cd5-9738-7343225c7c0d"},{"key":"vfx-api-stack-id","value":"71d6550b-73db-36a0-cf02-6923cea571cc"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2628"},{"key":"ETag","value":"W/\"a44-uBHJSOdNASgHgrG/pb6gfMspM1w\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:22:18 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"documentTypes\": [\n {\n \"id\": 3,\n \"category\": \"Payment Purpose\",\n \"title\": \"Purchase of Good(s)\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 4,\n \"category\": \"Payment Purpose\",\n \"title\": \"Purchase of Professional Service(s)\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 5,\n \"category\": \"Payment Purpose\",\n \"title\": \"Professional fees payment(i.e. legal, accountant)\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 6,\n \"category\": \"Payment Purpose\",\n \"title\": \"Payroll/Personnel Payment\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 7,\n \"category\": \"Payment Purpose\",\n \"title\": \"Payment for a loan or deposit\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 8,\n \"category\": \"Payment Purpose\",\n \"title\": \"Bill payment(i.e. credit card, utility)\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 9,\n \"category\": \"Payment Purpose\",\n \"title\": \"Research and Development\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 10,\n \"category\": \"Payment Purpose\",\n \"title\": \"Payment, Family Assistance\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 11,\n \"category\": \"Payment Purpose\",\n \"title\": \"Medical Assistance\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 12,\n \"category\": \"Payment Purpose\",\n \"title\": \"Medical Claim Reimbursement\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 13,\n \"category\": \"Payment Purpose\",\n \"title\": \"Remittance of funds from e-commerce\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 14,\n \"category\": \"Payment Purpose\",\n \"title\": \"IP Trademark Patent Work\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 15,\n \"category\": \"Payment Purpose\",\n \"title\": \"Travel/Hospitality\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 16,\n \"category\": \"Payment Purpose\",\n \"title\": \"Publisher\",\n \"createdAt\": \"2021-04-19T10:39:40.000Z\",\n \"updatedAt\": \"2021-04-19T10:39:40.000Z\"\n },\n {\n \"id\": 17,\n \"category\": \"Payment Purpose\",\n \"title\": \"Investment\",\n \"createdAt\": \"2021-06-07T11:05:51.000Z\",\n \"updatedAt\": \"2021-06-07T11:05:51.000Z\"\n },\n {\n \"id\": 18,\n \"category\": \"Payment Purpose\",\n \"title\": \"Wallet Top Up\",\n \"createdAt\": \"2021-06-07T11:05:51.000Z\",\n \"updatedAt\": \"2021-06-07T11:05:51.000Z\"\n },\n {\n \"id\": 19,\n \"category\": \"Payment Purpose\",\n \"title\": \"Internal Company Transfer\",\n \"createdAt\": \"2021-06-07T11:05:51.000Z\",\n \"updatedAt\": \"2021-06-07T11:05:51.000Z\"\n }\n ]\n}"}],"_postman_id":"0972c4ff-2676-472d-838d-6901f949e52c"},{"name":"Get all Currencies","id":"b3e1cd72-2a40-43b7-88aa-256fa7f6ee78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/currencies?customPageSize=10&page=1","description":"This service is used to get all the currencies in the system used for payments.
\n","urlObject":{"path":["profile","v2.1","currencies"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[{"description":{"content":"(Required) The no. of currencies show on a page
\n","type":"text/plain"},"key":"customPageSize","value":"10"},{"description":{"content":"(Required) The current page no.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"97de52cc-62de-4244-8d98-b6a16e99083a","name":"Get all Currencies","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api-v3-sandbox.vertofx.com/profile/v2.1/currencies?customPageSize=10&page=1","host":["https://api-v3-sandbox.vertofx.com"],"path":["profile","v2.1","currencies"],"query":[{"key":"customPageSize","value":"10","description":"(Required) The no. of currencies show on a page"},{"key":"page","value":"1","description":"(Required) The current page no."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 7,\n \"currencyName\": \"AED\",\n \"countryName\": \"UAE\"\n },\n {\n \"id\": 17,\n \"currencyName\": \"AUD\",\n \"countryName\": \"Australia\"\n },\n {\n \"id\": 40,\n \"currencyName\": \"BDT\",\n \"countryName\": \"Bangladesh\"\n },\n {\n \"id\": 21,\n \"currencyName\": \"BGN\",\n \"countryName\": \"Bulgaria\"\n },\n {\n \"id\": 20,\n \"currencyName\": \"BHD\",\n \"countryName\": \"Bahrain\"\n }\n ],\n \"metadata\": {\n \"total\": 51,\n \"currentPage\": 1,\n \"pageSize\": 5\n }\n}"}],"_postman_id":"b3e1cd72-2a40-43b7-88aa-256fa7f6ee78"},{"name":"Create a Payment Request","id":"f9693dd0-b742-4353-a9c5-35c50e03e05e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"beneficiaryId\": 284,\n \"purposeId\": 3,\n \"amount\": 100,\n \"walletId\": 3,\n \"clientReference\": \"Payment-100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/request","description":"This service is used to create a payment withdrawal request by specifying a wallet ID, amount, beneficiary ID and a purpose ID. You can also provide a custom client reference if needed.
\nRequest
\n","urlObject":{"path":["profile","v2.1","request"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[],"variable":[]}},"response":[{"id":"5209e477-b6c9-403c-a939-2d26f8fc0035","name":"Create a Payment Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"beneficiaryId\": 284,\n \"purposeId\": 3,\n \"amount\": 100,\n \"walletId\": 3,\n \"clientReference\": \"Payment-100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/request"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"579afa0a-b9a9-5231-33a6-dd00ede36d89"},{"key":"vfx-api-stack-id","value":"a51c2105-fc06-36c5-53cf-e1748aaf8259"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"662"},{"key":"ETag","value":"W/\"296-CtL2YGew0g6tO/Ro5eb46UZC03o\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:23:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"payment\": {\n \"id\": 416,\n \"userId\": 4,\n \"reference\": \"TO-16062022-007\",\n \"clientReference\": \"Payment-100\",\n \"account\": {\n \"id\": 284,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"country\": \"India\",\n \"reference\": \"RP-09062022-003\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": \"Test-Bene100\",\n \"status\": \"approved\"\n },\n \"currency\": \"INR\"\n }\n}"}],"_postman_id":"f9693dd0-b742-4353-a9c5-35c50e03e05e"},{"name":"Create a Payment Request (v2.2)","id":"407bf9cd-af9f-4246-a070-dd835cc55a9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"beneficiaryId\": 278,\r\n \"purposeId\": 12,\r\n \"amount\": 100,\r\n \"walletId\": 1,\r\n \"clientReference\": \"Testing\",\r\n \"paymentId\": \"a7600e0e-a973-4d26-b15c-89de5836e900\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/profile/v2.2/request","description":"This service is used to create a payment withdrawal request by specifying a wallet ID, amount, beneficiary ID, paymentId and a purpose ID. You can also provide a custom client reference if needed and paymentId is unique uuid for unique reference.
\nRequest
\nError Handling
\n","urlObject":{"path":["profile","v2.2","request"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[],"variable":[]}},"response":[{"id":"2568160b-c682-4fa5-850d-14f1c4578ee9","name":"Create a Payment Request (v2.2)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"beneficiaryId\": 278,\r\n \"purposeId\": 12,\r\n \"amount\": 100,\r\n \"walletId\": 1,\r\n \"clientReference\": \"Testing\",\r\n \"paymentId\": \"a7600e0e-a973-4d26-b15c-89de5836e900\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v3-sandbox.vertofx.com/profile/v2.2/request"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"c9c53074-575d-806d-31a1-5c4238ab3e83"},{"key":"vfx-api-stack-id","value":"7f3a300b-499b-3c29-a077-623691d5364a"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"641"},{"key":"ETag","value":"W/\"281-HWxqqE9su4whAHZW/HNWuiwj5j4\""},{"key":"Date","value":"Tue, 26 Jul 2022 06:40:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"payment\": {\n \"id\": 447,\n \"userId\": 4,\n \"reference\": \"TO-26072022-002\",\n \"paymentId\": \"a7600e0e-a973-4d26-b15c-89de5836e900\",\n \"clientReference\": \"Testing\",\n \"account\": {\n \"id\": 278,\n \"accountNumber\": \"8311547163\",\n \"bankName\": \"Community Federal Savings Bank\",\n \"beneficiaryAddress\": \"89-16 JAMAICA AVENUE\",\n \"beneficiaryCity\": \"QUEENS\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"US\",\n \"beneficiaryEntityType\": \"company\",\n \"country\": \"USA\",\n \"reference\": \"RP-09062022-004\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"CMFGUS33\",\n \"currency\": \"USD\",\n \"clientReference\": null,\n \"status\": \"approved\"\n },\n \"currency\": \"USD\"\n }\n}"}],"_postman_id":"407bf9cd-af9f-4246-a070-dd835cc55a9d"},{"name":"Get all Payment Requests","id":"b3e919e6-59e6-4097-9cf0-7864b5afde20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/request?customPageSize=10&page=1&searchQuery=Payment-100","description":"This service is used to get the list of all payment request list set for a particular user including the details such as ID, reference, currency, state, clientReference, account details too.
\n","urlObject":{"path":["profile","v2.1","request"],"host":["https://api-v3-sandbox.vertofx.com"],"query":[{"description":{"content":"Required\nThis is the page size for the payment requests
\n","type":"text/plain"},"key":"customPageSize","value":"10"},{"description":{"content":"Required \nPage Number in the list of payments
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Optional\nYou can search payments by the client Reference set by you in the create payment request call.
\n","type":"text/plain"},"key":"searchQuery","value":"Payment-100"}],"variable":[]}},"response":[{"id":"5761c998-39a6-468a-ba04-84a479de814e","name":"Get all Payment Requests","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://api-v3-sandbox.vertofx.com/profile/v2.1/request?customPageSize=10&page=1&searchQuery=Payment-100","protocol":"https","host":["api-v3-sandbox","vertofx","com"],"path":["profile","v2.1","request"],"query":[{"key":"customPageSize","value":"10","description":"Required\nThis is the page size for the payment requests"},{"key":"page","value":"1","description":"Required \nCurrent page number"},{"key":"searchQuery","value":"Payment-100","description":"Optional\nYou can search payments by the client Reference set by you in the create payment request call."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"vfx-api-call-id","value":"bf332ccc-89f6-d939-e869-235f92972688"},{"key":"vfx-api-stack-id","value":"1be552a4-0fa9-58fb-b8a8-9f2cdb9d926c"},{"key":"vfx-correlation-id","value":"undefined"},{"key":"content-security-policy","value":"default-src 'none'; img-src 'self'; script-src 'self'; style-src 'self'; object-src 'none'"},{"key":"strict-transport-security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"DENY"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"cache-control","value":"no-cache, no-store"},{"key":"expires","value":"0"},{"key":"pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"747"},{"key":"ETag","value":"W/\"2eb-2UVEBHAPZj0+7dR0uKpOqIf0q9o\""},{"key":"Date","value":"Thu, 16 Jun 2022 11:24:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 416,\n \"amount\": \"100.00\",\n \"reference\": \"TO-16062022-007\",\n \"state\": \"requested\",\n \"currency\": \"INR\",\n \"clientReference\": \"Payment-100\",\n \"account\": {\n \"id\": 285,\n \"accountNumber\": \"2000293918130\",\n \"bankName\": \"PUNJAB NATIONAL BANK\",\n \"beneficiaryAddress\": \"INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32\",\n \"beneficiaryCity\": \"HARYANA\",\n \"beneficiaryCompanyName\": \"OLSEN INDUSTRIA E COMERCIO SA\",\n \"beneficiaryCountryCode\": \"IN\",\n \"beneficiaryEntityType\": \"company\",\n \"country\": \"India\",\n \"reference\": \"RP-16062022-001\",\n \"beneficiaryFirstName\": \"\",\n \"beneficiaryLastName\": \"\",\n \"nationalId\": \"PUNB0644100\",\n \"currency\": \"INR\",\n \"clientReference\": \"Test-Bene100\",\n \"status\": \"approved\"\n }\n }\n ],\n \"metaData\": {\n \"total\": 1,\n \"current_page\": \"1\",\n \"page_size\": \"10\"\n }\n}"}],"_postman_id":"b3e919e6-59e6-4097-9cf0-7864b5afde20"},{"name":"Get a Payment Request","id":"f65879bf-0a58-4c69-897c-2518a62c7ce0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api-v3-sandbox.vertofx.com/profile/v2.1/request/416","description":"This service is used to get the details of a particular payment withdrawal request including state. Simply add requestID to your get URL and you will be returned the request including the details such as ID, reference, currency, state, clientReference, account details too.